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 java.lang.Object
implements Evaluator<org.apache.directory.api.ldap.model.filter.ScopeNode>

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

Field Summary

Fields

Modifier and Type	Field and Description
private java.lang.String	baseId The entry identifier of the scope base
private boolean	baseIsContextEntry Whether or not to accept all candidates.
private java.lang.String	contextEntryId
private Store	db The entry database/store
private boolean	dereferencing True if the scope requires alias dereferencing while searching
private org.apache.directory.api.ldap.model.filter.ScopeNode	node The ScopeNode containing initial search scope constraints

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

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<?,java.lang.String> indexEntry) Asserts whether or not a candidate has sub level scope while taking alias dereferencing into account.
java.lang.String	getBaseId()
private java.lang.String	getContextEntryId()
org.apache.directory.api.ldap.model.filter.ScopeNode	getExpression() Gets the expression used by this expression Evaluator.
boolean	isDereferencing()
private boolean	isDescendant(java.lang.String candidateId) Tells if a candidate is a descendant of the base ID.
java.lang.String	toString()
java.lang.String	toString(java.lang.String tabs) Pretty-print an Evaluator

Methods inherited from class java.lang.Object

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

Field Detail

node

private final org.apache.directory.api.ldap.model.filter.ScopeNode node

The ScopeNode containing initial search scope constraints

baseId

private final java.lang.String baseId

The entry identifier of the scope base

baseIsContextEntry

private final boolean baseIsContextEntry

Whether or not to accept all candidates. If this evaluator's baseId is set to the context entry's id, then obviously all candidates will be subordinate to this root ancestor or in subtree scope. This check is done on initialization and used there after. One reason we need do this is because the subtree scope index (sub level index) does not map the values for the context entry id to it's subordinates since it would have to include all entries. This is a waste of space and lookup time since we know all entries will be subordinates in this case.

dereferencing

private final boolean dereferencing

True if the scope requires alias dereferencing while searching

db

private final Store db

The entry database/store

contextEntryId

private java.lang.String contextEntryId

Constructor Detail

SubtreeScopeEvaluator

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

Creates a subtree scope node evaluator for search expressions.

Parameters:

node - the scope node

db - the database used to evaluate scope node

Throws:

java.lang.Exception - on db access failure

Method Detail

getContextEntryId

private java.lang.String getContextEntryId()
                                    throws java.lang.Exception

Throws:

java.lang.Exception

isDescendant

private boolean isDescendant(java.lang.String candidateId)
                      throws org.apache.directory.api.ldap.model.exception.LdapException

Tells if a candidate is a descendant of the base ID. We have to fetch all the parentIdAndRdn up to the baseId. If we terminate on the context entry without having found the baseId, then the candidate is not a descendant.

Throws:

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

evaluate

public boolean evaluate(IndexEntry<?,java.lang.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:

java.lang.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 java.lang.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:

java.lang.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 java.lang.String getBaseId()

isDereferencing

public boolean isDereferencing()

toString

public java.lang.String toString(java.lang.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 java.lang.String toString()

Overrides:

toString in class java.lang.Object

See Also:

Object.toString()