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

Evaluates base level scope assertions on candidates using an entry database.

Author:

Apache Directory Project

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

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 one level scope while taking alias dereferencing into account.
boolean	evaluate(IndexEntry<?,String> indexEntry) Asserts whether or not a candidate has one level scope while taking alias dereferencing into account.
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.
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

BaseLevelScopeEvaluator

public BaseLevelScopeEvaluator(Store db,
                       org.apache.directory.api.ldap.model.filter.ScopeNode node)
                        throws 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:

Exception - on db access failure

Method Detail

evaluate

public boolean evaluate(org.apache.directory.api.ldap.model.entry.Entry candidate)
                 throws 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:

Exception - if there are faults during evaluation

evaluate

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

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