org.apache.directory.server.xdbm.search.evaluator

Class SubtreeScopeEvaluator

java.lang.Object

org.apache.directory.server.xdbm.search.evaluator.SubtreeScopeEvaluator

All Implemented Interfaces:

Evaluator<org.apache.directory.api.ldap.model.filter.ScopeNode>

public class SubtreeScopeEvaluator
extends Object
implements Evaluator<org.apache.directory.api.ldap.model.filter.ScopeNode>

Evaluates ScopeNode assertions with subtree scope on candidates using an entry database.

Author:

Apache Directory Project

Constructor Summary

Constructors

Constructor and Description
SubtreeScopeEvaluator(Store db, org.apache.directory.api.ldap.model.filter.ScopeNode node) Creates a subtree scope node evaluator for search expressions.

Method Summary

Methods

Modifier and Type	Method and Description
boolean	evaluate(org.apache.directory.api.ldap.model.entry.Entry candidate) Asserts whether or not a candidate has sub level scope while taking alias dereferencing into account.
boolean	evaluate(IndexEntry<?,String> indexEntry) Asserts whether or not a candidate has sub level scope while taking alias dereferencing into account.
String	getBaseId()
org.apache.directory.api.ldap.model.filter.ScopeNode	getExpression() Gets the expression used by this expression Evaluator.
boolean	isDereferencing()
String	toString()
String	toString(String tabs) Pretty-print an Evaluator

Methods inherited from class java.lang.Object

clone, equals, finalize, getClass, hashCode, notify, notifyAll, wait, wait, wait

Constructor Detail

SubtreeScopeEvaluator

public SubtreeScopeEvaluator(Store db,
                     org.apache.directory.api.ldap.model.filter.ScopeNode node)
                      throws Exception

Creates a subtree scope node evaluator for search expressions.

Parameters:

node - the scope node

db - the database used to evaluate scope node

Throws:

Exception - on db access failure

Method Detail

evaluate

public boolean evaluate(IndexEntry<?,String> indexEntry)
                 throws org.apache.directory.api.ldap.model.exception.LdapException

Asserts whether or not a candidate has sub level scope while taking alias dereferencing into account.

Specified by:

evaluate in interface Evaluator<org.apache.directory.api.ldap.model.filter.ScopeNode>

Parameters:

candidate - the entry tested to see if it is in subtree scope

Returns:

true if the candidate is within one level scope whether or not alias dereferencing is enabled.

Throws:

Exception - if the index lookups fail.

org.apache.directory.api.ldap.model.exception.LdapException

See Also:

Evaluator.evaluate(org.apache.directory.server.xdbm.IndexEntry)

evaluate

public boolean evaluate(org.apache.directory.api.ldap.model.entry.Entry candidate)
                 throws Exception

Asserts whether or not a candidate has sub level scope while taking alias dereferencing into account.

Specified by:

evaluate in interface Evaluator<org.apache.directory.api.ldap.model.filter.ScopeNode>

Parameters:

candidate - the entry tested to see if it is in subtree scope

Returns:

true if the candidate is within one level scope whether or not alias dereferencing is enabled.

Throws:

Exception - if the index lookups fail.

See Also:

Evaluator.evaluate(org.apache.directory.server.xdbm.IndexEntry)

getExpression

public org.apache.directory.api.ldap.model.filter.ScopeNode getExpression()

Description copied from interface: Evaluator

Gets the expression used by this expression Evaluator.

Specified by:

getExpression in interface Evaluator<org.apache.directory.api.ldap.model.filter.ScopeNode>

Returns:

the AST for the expression

getBaseId

public String getBaseId()

isDereferencing

public boolean isDereferencing()

toString

public String toString(String tabs)

Description copied from interface: Evaluator

Pretty-print an Evaluator

Specified by:

toString in interface Evaluator<org.apache.directory.api.ldap.model.filter.ScopeNode>

Parameters:

tabs - The tabs to add before the evaluator

Returns:

The pretty-printed evaluator and its descendants

See Also:

Object.toString()

toString

public String toString()

Overrides:

toString in class Object

See Also:

Object.toString()