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

Evaluates substring filter assertions on an entry.

Field Summary

Fields

Modifier and Type	Field and Description
private org.apache.directory.api.ldap.model.schema.AttributeType	attributeType The AttributeType we will use for the evaluation
private Store	db Database used while evaluating candidates
private Index<java.lang.String,java.lang.String>	idx The index to use if any
private org.apache.directory.api.ldap.model.filter.SubstringNode	node The Substring expression
private org.apache.directory.api.ldap.model.schema.Normalizer	normalizer The associated normalizer
private java.util.regex.Pattern	regex The regular expression generated for the SubstringNode pattern
private org.apache.directory.api.ldap.model.schema.SchemaManager	schemaManager Reference to the SchemaManager

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

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<?,java.lang.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.
java.util.regex.Pattern	getPattern()
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

db

private final Store db

Database used while evaluating candidates

schemaManager

private final org.apache.directory.api.ldap.model.schema.SchemaManager schemaManager

Reference to the SchemaManager

node

private final org.apache.directory.api.ldap.model.filter.SubstringNode node

The Substring expression

regex

private final java.util.regex.Pattern regex

The regular expression generated for the SubstringNode pattern

attributeType

private final org.apache.directory.api.ldap.model.schema.AttributeType attributeType

The AttributeType we will use for the evaluation

normalizer

private final org.apache.directory.api.ldap.model.schema.Normalizer normalizer

The associated normalizer

idx

private final Index<java.lang.String,java.lang.String> idx

The index to use if any

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 java.lang.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:

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

Method Detail

evaluate

public boolean evaluate(IndexEntry<?,java.lang.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 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.api.ldap.model.filter.SubstringNode>

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

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