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

Class SubstringEvaluator

java.lang.Object

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

All Implemented Interfaces:

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

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

Evaluates substring filter assertions on an entry.

Author:

Apache Directory Project

Constructor Summary

Constructors

Constructor and Description
SubstringEvaluator(org.apache.directory.api.ldap.model.filter.SubstringNode node, Store db, org.apache.directory.api.ldap.model.schema.SchemaManager schemaManager) Creates a new SubstringEvaluator for substring expressions.

Method Summary

Methods

Modifier and Type	Method and Description
boolean	evaluate(org.apache.directory.api.ldap.model.entry.Entry entry) Evaluates whether or not a candidate, satisfies the expression associated with this Evaluator .
boolean	evaluate(IndexEntry<?,String> indexEntryQM) Evaluates a candidate to determine if a filter expression selects it.
org.apache.directory.api.ldap.model.filter.SubstringNode	getExpression() Gets the expression used by this expression Evaluator.
Pattern	getPattern()
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

SubstringEvaluator

public SubstringEvaluator(org.apache.directory.api.ldap.model.filter.SubstringNode node,
                  Store db,
                  org.apache.directory.api.ldap.model.schema.SchemaManager schemaManager)
                   throws Exception

Creates a new SubstringEvaluator for substring expressions.

Parameters:

node - the substring expression node

db - the database this evaluator uses

schemaManager - the schema manager

Throws:

Exception - if there are failures accessing resources and the db

Method Detail

evaluate

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

Description copied from interface: Evaluator

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.SubstringNode>

Parameters:

indexEntryQM - 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

evaluate

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

Description copied from interface: Evaluator

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.SubstringNode>

Parameters:

entry - the candidate entry

Returns:

true if filter selects the candidate false otherwise

Throws:

Exception - if there are faults during evaluation

getPattern

public Pattern getPattern()

getExpression

public org.apache.directory.api.ldap.model.filter.SubstringNode 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.SubstringNode>

Returns:

the AST for the expression

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.SubstringNode>

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