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 Object
implements 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 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.server.core.api.partition.PartitionTxn partitionTxn, 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.server.core.api.partition.PartitionTxn partitionTxn, 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

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.server.core.api.partition.PartitionTxn partitionTxn,
                                           org.apache.directory.api.ldap.model.schema.SchemaManager schemaManager,
                                           org.apache.directory.server.core.api.interceptor.context.SearchOperationContext searchContext)
                                    throws org.apache.directory.api.ldap.model.exception.LdapException

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

Specified by:

computeResult in interface SearchEngine

Parameters:

partitionTxn - The transaction to use

schemaManager - The SchemaManager instance

searchContext - the search context

Returns:

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

Throws:

org.apache.directory.api.ldap.model.exception.LdapException - if the search fails

evaluator

public Evaluator<? extends org.apache.directory.api.ldap.model.filter.ExprNode> evaluator(org.apache.directory.server.core.api.partition.PartitionTxn partitionTxn,
                                                                                          org.apache.directory.api.ldap.model.filter.ExprNode filter)
                                                                                   throws org.apache.directory.api.ldap.model.exception.LdapException

Builds an Evaluator for a filter expression.

Specified by:

evaluator in interface SearchEngine

Parameters:

partitionTxn - The transaction to use

filter - the filter root AST node

Returns:

true if the filter passes the entry, false otherwise

Throws:

org.apache.directory.api.ldap.model.exception.LdapException - if something goes wrong while accessing the db