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

Class BaseLevelScopeEvaluator<E>

java.lang.Object

org.apache.directory.server.xdbm.search.evaluator.BaseLevelScopeEvaluator<E>

All Implemented Interfaces:

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

public class BaseLevelScopeEvaluator<E>
extends java.lang.Object
implements Evaluator<org.apache.directory.api.ldap.model.filter.ScopeNode>

Evaluates base level scope assertions 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 Store	db the entry db storing entries
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
BaseLevelScopeEvaluator(Store db, org.apache.directory.api.ldap.model.filter.ScopeNode node) Creates a one level 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 one level scope while taking alias dereferencing into account.
boolean	evaluate(IndexEntry<?,java.lang.String> indexEntry) Asserts whether or not a candidate has one level scope while taking alias dereferencing into account.
java.lang.String	getBaseId() Gets the id of the search base associated with the ScopeNode expression.
org.apache.directory.api.ldap.model.filter.ScopeNode	getExpression() Gets the expression used by this expression Evaluator.
boolean	isDereferencing() Gets whether or not dereferencing is enabled for this evaluator.
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

dereferencing

private final boolean dereferencing

True if the scope requires alias dereferencing while searching

db

private final Store db

the entry db storing entries

Constructor Detail

BaseLevelScopeEvaluator

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

Creates a one level 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

evaluate

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

Asserts whether or not a candidate has one level scope while taking alias dereferencing into account. TODO - terribly inefficient - would benefit from exposing the id of an entry within the Entry Evaluates whether or not a candidate, satisfies the expression associated with this Evaluator .

Specified by:

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

Parameters:

candidate - the candidate entry

Returns:

true if filter selects the candidate false otherwise

Throws:

java.lang.Exception - if there are faults during evaluation

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 one 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 candidate to assert

Returns:

true if the candidate is within one level scope

Throws:

java.lang.Exception - if db lookups fail

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

See Also:

Evaluator.evaluate(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()

Gets the id of the search base associated with the ScopeNode expression.

Returns:

identifier of the search base

isDereferencing

public boolean isDereferencing()

Gets whether or not dereferencing is enabled for this evaluator.

Returns:

true if dereferencing is enabled, false otherwise

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()