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(org.apache.directory.server.core.api.partition.PartitionTxn partitionTxn, 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) Evaluates whether or not a candidate, satisfies the expression associated with this Evaluator .
boolean	evaluate(org.apache.directory.server.core.api.partition.PartitionTxn partitionTxn, IndexEntry<?,String> indexEntry) Evaluates a candidate to determine if a filter expression selects it.
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(org.apache.directory.server.core.api.partition.PartitionTxn partitionTxn,
                             Store db,
                             org.apache.directory.api.ldap.model.filter.ScopeNode node)
                      throws org.apache.directory.api.ldap.model.exception.LdapException

Creates a subtree scope node evaluator for search expressions.

Parameters:

partitionTxn - The transaction to use

db - the database used to evaluate scope node

node - the scope node

Throws:

org.apache.directory.api.ldap.model.exception.LdapException - on db access failure

Method Detail

evaluate

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

Evaluates a candidate to determine if a filter expression selects it. If an IndexEntry does has a null reference to the entry object, this Evaluator may set it if it has to access the full entry within the master table of the store. Subsequent evaluations on the IndexEntry then need not access the store to retreive the entry if they need to access it's attributes.

Specified by:

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

Parameters:

partitionTxn - The transaction to use

indexEntry - the index record of the entry to evaluate

Returns:

true if filter selects the candidate false otherwise

Throws:

org.apache.directory.api.ldap.model.exception.LdapException - if there are faults during evaluation

evaluate

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

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:

org.apache.directory.api.ldap.model.exception.LdapException - if there are faults during evaluation

getExpression

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

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

Returns:

The base ID

isDereferencing

public boolean isDereferencing()

Returns:

true if dereferencing

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