org.apache.directory.server.xdbm.search

Interface SearchEngine

All Known Implementing Classes:

DefaultSearchEngine

public interface SearchEngine

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

Author:

Apache Directory Project

Field Summary

Fields

Modifier and Type	Field and Description
static String	ALIASMODE_KEY
static String	ALWAYS
static String	FINDING
static String	NEVER
static String	SEARCHING

Method Summary

Methods

Modifier and Type	Method and Description
PartitionSearchResult	computeResult(org.apache.directory.api.ldap.model.schema.SchemaManager schemaManager, org.apache.directory.server.core.api.interceptor.context.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.

Field Detail

ALIASMODE_KEY

static final String ALIASMODE_KEY

See Also:

Constant Field Values

ALWAYS

static final String ALWAYS

See Also:

Constant Field Values

NEVER

static final String NEVER

See Also:

Constant Field Values

FINDING

static final String FINDING

See Also:

Constant Field Values

SEARCHING

static final String SEARCHING

See Also:

Constant Field Values

Method Detail

getOptimizer

Optimizer getOptimizer()

Gets the optimizer for this DefaultSearchEngine.

Returns:

the optimizer

computeResult

PartitionSearchResult computeResult(org.apache.directory.api.ldap.model.schema.SchemaManager schemaManager,
                                  org.apache.directory.server.core.api.interceptor.context.SearchOperationContext searchContext)
                                    throws Exception

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

Parameters:

The - SchemaManager instance

searchContext - the search context

Returns:

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

Throws:

Exception - if the search fails

evaluator

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

Builds an Evaluator for a filter expression.

Parameters:

filter - the filter root AST node

Returns:

true if the filter passes the entry, false otherwise

Throws:

Exception - if something goes wrong while accessing the db