org.apache.directory.server.xdbm.search

Class PartitionSearchResult

java.lang.Object

org.apache.directory.server.xdbm.search.PartitionSearchResult

public class PartitionSearchResult
extends java.lang.Object

A class containing the result of a search :

• A set of candidate UUIDs
• A set of aliased entry if we have any
• A flag telling if we are dereferencing aliases or not
• A hierarchy of evaluators to use to validate the candidates

Field Summary

Fields

Modifier and Type	Field and Description
private org.apache.directory.api.ldap.model.message.AliasDerefMode	aliasDerefMode The flag indicating if we are dereferencing the aliases.
private java.util.Set<java.lang.String>	candidateSet The set of candidate UUIDs
private Evaluator<? extends org.apache.directory.api.ldap.model.filter.ExprNode>	evaluator The evaluator to validate the candidates
private org.apache.directory.api.ldap.model.cursor.SetCursor<IndexEntry<java.lang.String,java.lang.String>>	resultSet The set of candidate UUIDs selected by the search
private org.apache.directory.api.ldap.model.schema.SchemaManager	schemaManager The SchemaManager

Constructor Summary

Constructors

Constructor and Description
PartitionSearchResult(org.apache.directory.api.ldap.model.schema.SchemaManager schemaManager) Create a PartitionSearchResult instance

Method Summary

Modifier and Type	Method and Description
java.util.Set<java.lang.String>	getCandidateSet()
Evaluator<? extends org.apache.directory.api.ldap.model.filter.ExprNode>	getEvaluator()
org.apache.directory.api.ldap.model.cursor.SetCursor<IndexEntry<java.lang.String,java.lang.String>>	getResultSet()
org.apache.directory.api.ldap.model.schema.SchemaManager	getSchemaManager()
boolean	isDerefAlways()
boolean	isDerefFinding()
boolean	isDerefInSearching()
boolean	isNeverDeref()
void	setAliasDerefMode(org.apache.directory.api.ldap.model.message.AliasDerefMode aliasDerefMode)
void	setCandidateSet(java.util.Set<java.lang.String> set)
void	setEvaluator(Evaluator<? extends org.apache.directory.api.ldap.model.filter.ExprNode> evaluator)
void	setResultSet(java.util.Set<IndexEntry<java.lang.String,java.lang.String>> set)
void	setSchemaManager(org.apache.directory.api.ldap.model.schema.SchemaManager schemaManager)
java.lang.String	toString()

Methods inherited from class java.lang.Object

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

Field Detail

resultSet

private org.apache.directory.api.ldap.model.cursor.SetCursor<IndexEntry<java.lang.String,java.lang.String>> resultSet

The set of candidate UUIDs selected by the search

candidateSet

private java.util.Set<java.lang.String> candidateSet

The set of candidate UUIDs

aliasDerefMode

private org.apache.directory.api.ldap.model.message.AliasDerefMode aliasDerefMode

The flag indicating if we are dereferencing the aliases. Default to Never.

evaluator

private Evaluator<? extends org.apache.directory.api.ldap.model.filter.ExprNode> evaluator

The evaluator to validate the candidates

schemaManager

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

The SchemaManager

Constructor Detail

PartitionSearchResult

public PartitionSearchResult(org.apache.directory.api.ldap.model.schema.SchemaManager schemaManager)

Create a PartitionSearchResult instance

Method Detail

getResultSet

public org.apache.directory.api.ldap.model.cursor.SetCursor<IndexEntry<java.lang.String,java.lang.String>> getResultSet()

Returns:

the resultSet

setResultSet

public void setResultSet(java.util.Set<IndexEntry<java.lang.String,java.lang.String>> set)

Parameters:

resultSet - the resultSet to set

getCandidateSet

public java.util.Set<java.lang.String> getCandidateSet()

Returns:

the candidateSet

setCandidateSet

public void setCandidateSet(java.util.Set<java.lang.String> set)

Parameters:

candidateSet - the candidateSet to set

getEvaluator

public Evaluator<? extends org.apache.directory.api.ldap.model.filter.ExprNode> getEvaluator()

Returns:

the evaluator

setEvaluator

public void setEvaluator(Evaluator<? extends org.apache.directory.api.ldap.model.filter.ExprNode> evaluator)

Parameters:

evaluator - the evaluator to set

setAliasDerefMode

public void setAliasDerefMode(org.apache.directory.api.ldap.model.message.AliasDerefMode aliasDerefMode)

Parameters:

aliasDerefMode - the aliasDerefMode to set

isNeverDeref

public boolean isNeverDeref()

Returns:

True if the alias is never dereferenced

isDerefAlways

public boolean isDerefAlways()

Returns:

True if the alias is always dereferenced

isDerefInSearching

public boolean isDerefInSearching()

Returns:

True if the alias is dereferenced while searching

isDerefFinding

public boolean isDerefFinding()

Returns:

True if the alias is dereferenced while finding

getSchemaManager

public org.apache.directory.api.ldap.model.schema.SchemaManager getSchemaManager()

Returns:

the schemaManager

setSchemaManager

public void setSchemaManager(org.apache.directory.api.ldap.model.schema.SchemaManager schemaManager)

Parameters:

schemaManager - the schemaManager to set

toString

public java.lang.String toString()

Overrides:

toString in class java.lang.Object

See Also:

Object.toString()