org.apache.directory.server.xdbm.search.impl
Class SubstringEvaluator

java.lang.Object
  org.apache.directory.server.xdbm.search.impl.SubstringEvaluator

All Implemented Interfaces:

Evaluator<org.apache.directory.shared.ldap.filter.SubstringNode,ServerEntry>

public class SubstringEvaluator
extends java.lang.Object
implements Evaluator<org.apache.directory.shared.ldap.filter.SubstringNode,ServerEntry>

Evaluates substring filter assertions on an entry.

Version:

$Rev: 658798 $

Author:

Apache Directory Project

Constructor Summary

SubstringEvaluator(org.apache.directory.shared.ldap.filter.SubstringNode node, Store<ServerEntry> db, Registries registries)
Creates a new SubstringEvaluator for substring expressions.

Method Summary

boolean	evaluate(IndexEntry<?,ServerEntry> indexEntry) Evaluates a candidate to determine if a filter expression selects it.
boolean	evaluate(java.lang.Long id) Evaluates whether or not a candidate, specified by an id, satisfies the expression associated with this Evaluator .
boolean	evaluate(ServerEntry entry) Evaluates whether or not a candidate, satisfies the expression associated with this Evaluator .
org.apache.directory.shared.ldap.filter.SubstringNode	getExpression() Gets the expression used by this expression Evaluator.
java.util.regex.Pattern	getPattern()

Methods inherited from class java.lang.Object

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

Constructor Detail

SubstringEvaluator

public SubstringEvaluator(org.apache.directory.shared.ldap.filter.SubstringNode node,
                          Store<ServerEntry> db,
                          Registries registries)
                   throws java.lang.Exception

Creates a new SubstringEvaluator for substring expressions.

Parameters:

node - the substring expression node

db - the database this evaluator uses

registries - the set of registries

Throws:

java.lang.Exception - if there are failures accessing resources and the db

Method Detail

evaluate

public boolean evaluate(IndexEntry<?,ServerEntry> indexEntry)
                 throws java.lang.Exception

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.shared.ldap.filter.SubstringNode,ServerEntry>

Parameters:

indexEntry - the index record of the entry to evaluate

Returns:

true if filter selects the candidate false otherwise

Throws:

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

evaluate

public boolean evaluate(java.lang.Long id)
                 throws java.lang.Exception

Description copied from interface: Evaluator

Evaluates whether or not a candidate, specified by an id, satisfies the expression associated with this Evaluator .

Specified by:

evaluate in interface Evaluator<org.apache.directory.shared.ldap.filter.SubstringNode,ServerEntry>

Parameters:

id - the identifier for 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(ServerEntry entry)
                 throws java.lang.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.shared.ldap.filter.SubstringNode,ServerEntry>

Parameters:

entry - the candidate entry

Returns:

true if filter selects the candidate false otherwise

Throws:

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

getPattern

public java.util.regex.Pattern getPattern()

getExpression

public org.apache.directory.shared.ldap.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.shared.ldap.filter.SubstringNode,ServerEntry>

Returns:

the AST for the expression