org.apache.directory.server.core.api.subtree

Class SubtreeEvaluator

java.lang.Object

org.apache.directory.server.core.api.subtree.SubtreeEvaluator

public class SubtreeEvaluator
extends Object

An evaluator used to determine if an entry is included in the collection represented by a subtree specification.

Author:

Apache Directory Project

Constructor Summary

Constructors

Constructor and Description
SubtreeEvaluator(org.apache.directory.api.ldap.model.schema.SchemaManager schemaManager) Creates a subtreeSpecification evaluatior which can be used to determine if an entry is included within the collection of a subtree.

Method Summary

Modifier and Type	Method and Description
boolean	evaluate(org.apache.directory.api.ldap.model.subtree.SubtreeSpecification subtree, org.apache.directory.api.ldap.model.name.Dn apDn, org.apache.directory.api.ldap.model.name.Dn entryDn, org.apache.directory.api.ldap.model.entry.Entry entry) Determines if an entry is selected by a subtree specification.

Methods inherited from class java.lang.Object

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

Constructor Detail

SubtreeEvaluator

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

Creates a subtreeSpecification evaluatior which can be used to determine if an entry is included within the collection of a subtree.

Parameters:

schemaManager - The server schemaManager

Method Detail

evaluate

public boolean evaluate(org.apache.directory.api.ldap.model.subtree.SubtreeSpecification subtree,
                        org.apache.directory.api.ldap.model.name.Dn apDn,
                        org.apache.directory.api.ldap.model.name.Dn entryDn,
                        org.apache.directory.api.ldap.model.entry.Entry entry)
                 throws org.apache.directory.api.ldap.model.exception.LdapException

Determines if an entry is selected by a subtree specification.

Parameters:

subtree - the subtree specification

apDn - the distinguished name of the administrative point containing the subentry

entryDn - the distinguished name of the candidate entry

Returns:

true if the entry is selected by the specification, false if it is not

Throws:

org.apache.directory.api.ldap.model.exception.LdapException - if errors are encountered while evaluating selection