org.apache.directory.server.xdbm.search
Interface SearchEngine<E,ID>

All Known Implementing Classes:

DefaultSearchEngine

public interface SearchEngine<E,ID>

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

Author:

Apache Directory Project

Field Summary

static String	ALIASMODE_KEY
static String	ALWAYS
static String	FINDING
static String	NEVER
static String	SEARCHING

Method Summary

IndexCursor<ID,E,ID>	cursor(org.apache.directory.shared.ldap.model.name.Dn base, org.apache.directory.shared.ldap.model.message.AliasDerefMode aliasDerefMode, org.apache.directory.shared.ldap.model.filter.ExprNode filter, SearchControls searchCtls) Conducts a search on a database.
Evaluator<? extends org.apache.directory.shared.ldap.model.filter.ExprNode,org.apache.directory.shared.ldap.model.entry.Entry,ID>	evaluator(org.apache.directory.shared.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

cursor

IndexCursor<ID,E,ID> cursor(org.apache.directory.shared.ldap.model.name.Dn base,
                            org.apache.directory.shared.ldap.model.message.AliasDerefMode aliasDerefMode,
                            org.apache.directory.shared.ldap.model.filter.ExprNode filter,
                            SearchControls searchCtls)
                            throws Exception

Conducts a search on a database.

Parameters:

base - the search base

aliasDerefMode - the alias dereferencing mode to use

filter - the search filter AST root

searchCtls - the JNDI search controls

Returns:

enumeration over SearchResults

Throws:

Exception - if the search fails

evaluator

Evaluator<? extends org.apache.directory.shared.ldap.model.filter.ExprNode,org.apache.directory.shared.ldap.model.entry.Entry,ID> evaluator(org.apache.directory.shared.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