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

Class DefaultSearchEngine

java.lang.Object

org.apache.directory.server.xdbm.search.impl.DefaultSearchEngine

All Implemented Interfaces:

SearchEngine

public class DefaultSearchEngine
extends java.lang.Object
implements SearchEngine

Given a search filter and a scope the search engine identifies valid candidate entries returning their ids.

Field Summary

Fields

Modifier and Type	Field and Description
private CursorBuilder	cursorBuilder creates Cursors over entries satisfying filter expressions
private Store	db the Database this DefaultSearchEngine operates on
private EvaluatorBuilder	evaluatorBuilder creates evaluators which check to see if candidates satisfy a filter expression
private static org.slf4j.Logger	LOG The logger
private Optimizer	optimizer the Optimizer used by this DefaultSearchEngine

Fields inherited from interface org.apache.directory.server.xdbm.search.SearchEngine

ALIASMODE_KEY, ALWAYS, FINDING, NEVER, SEARCHING

Constructor Summary

Constructors

Constructor and Description
DefaultSearchEngine(Store db, CursorBuilder cursorBuilder, EvaluatorBuilder evaluatorBuilder, Optimizer optimizer) Creates a DefaultSearchEngine for searching a Database without setting up the database.

Method Summary

Modifier and Type	Method and Description
PartitionSearchResult	computeResult(org.apache.directory.api.ldap.model.schema.SchemaManager schemaManager, SearchOperationContext searchContext) Conducts a search on a database.
Evaluator<? extends org.apache.directory.api.ldap.model.filter.ExprNode>	evaluator(org.apache.directory.api.ldap.model.filter.ExprNode filter) Builds an Evaluator for a filter expression.
Optimizer	getOptimizer() Gets the optimizer for this DefaultSearchEngine.

Methods inherited from class java.lang.Object

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

Field Detail

LOG

private static final org.slf4j.Logger LOG

The logger

optimizer

private final Optimizer optimizer

the Optimizer used by this DefaultSearchEngine

db

private final Store db

the Database this DefaultSearchEngine operates on

cursorBuilder

private final CursorBuilder cursorBuilder

creates Cursors over entries satisfying filter expressions

evaluatorBuilder

private final EvaluatorBuilder evaluatorBuilder

creates evaluators which check to see if candidates satisfy a filter expression

Constructor Detail

DefaultSearchEngine

public DefaultSearchEngine(Store db,
                           CursorBuilder cursorBuilder,
                           EvaluatorBuilder evaluatorBuilder,
                           Optimizer optimizer)

Creates a DefaultSearchEngine for searching a Database without setting up the database.

Parameters:

db - the btree based partition

cursorBuilder - an expression cursor builder

evaluatorBuilder - an expression evaluator builder

optimizer - an optimizer to use during search

Method Detail

getOptimizer

public Optimizer getOptimizer()

Gets the optimizer for this DefaultSearchEngine.

Specified by:

getOptimizer in interface SearchEngine

Returns:

the optimizer

computeResult

public PartitionSearchResult computeResult(org.apache.directory.api.ldap.model.schema.SchemaManager schemaManager,
                                           SearchOperationContext searchContext)
                                    throws java.lang.Exception

Conducts a search on a database. It returns a set of UUID we found for the given filter.

Specified by:

computeResult in interface SearchEngine

searchContext - the search context

Returns:

A set of UUID representing the full result, up to he sizeLimit

Throws:

java.lang.Exception - if the search fails

evaluator

public Evaluator<? extends org.apache.directory.api.ldap.model.filter.ExprNode> evaluator(org.apache.directory.api.ldap.model.filter.ExprNode filter)
                                                                                   throws java.lang.Exception

Description copied from interface: SearchEngine

Builds an Evaluator for a filter expression.

Specified by:

evaluator in interface SearchEngine

Parameters:

filter - the filter root AST node

Returns:

true if the filter passes the entry, false otherwise

Throws:

java.lang.Exception - if something goes wrong while accessing the db

See Also:

SearchEngine.evaluator(ExprNode)