org.apache.directory.api.ldap.model.filter

Class ScopeNode

java.lang.Object

org.apache.directory.api.ldap.model.filter.AbstractExprNode

org.apache.directory.api.ldap.model.filter.ScopeNode

All Implemented Interfaces:

Cloneable, ExprNode

public class ScopeNode
extends AbstractExprNode

Node used not to represent a published assertion but an assertion on the scope of the search.

Author:

Apache Directory Project

Field Summary

Fields

Modifier and Type	Field and Description
private AliasDerefMode	aliasDerefAliases the alias dereferencing mode
private Dn	baseDn the search base
private String	baseId the search ID
private SearchScope	scope the scope of this node

Fields inherited from class org.apache.directory.api.ldap.model.filter.AbstractExprNode

annotations, assertionType

Constructor Summary

Constructors

Constructor and Description
ScopeNode(AliasDerefMode aliasDerefAliases, Dn baseDn, String baseId, SearchScope scope) Creates a new ScopeNode object.

Method Summary

Modifier and Type	Method and Description
Object	accept(FilterVisitor visitor) Element/node accept method for visitor pattern.
boolean	equals(Object obj)
Dn	getBaseDn() Gets the base dn.
String	getBaseId() Gets the base ID.
AliasDerefMode	getDerefAliases() Gets the alias dereferencing mode type safe enumeration.
SearchScope	getScope() Gets the search scope.
int	hashCode()
boolean	isLeaf() Always returns true since a scope node has no children.
boolean	isSchemaAware() Tells if this Node is Schema aware.
String	toString()

Methods inherited from class org.apache.directory.api.ldap.model.filter.AbstractExprNode

clone, get, getAnnotations, getAssertionType, printRefinementToBuffer, set

Methods inherited from class java.lang.Object

finalize, getClass, notify, notifyAll, wait, wait, wait

Field Detail

scope

private final SearchScope scope

the scope of this node

baseDn

private final Dn baseDn

the search base

baseId

private final String baseId

the search ID

aliasDerefAliases

private final AliasDerefMode aliasDerefAliases

the alias dereferencing mode

Constructor Detail

ScopeNode

public ScopeNode(AliasDerefMode aliasDerefAliases,
                 Dn baseDn,
                 String baseId,
                 SearchScope scope)

Creates a new ScopeNode object.

Parameters:

aliasDerefAliases - the alias dereferencing mode

baseDn - the search base

baseId - the search ID

scope - the search scope

Method Detail

isLeaf

public boolean isLeaf()

Always returns true since a scope node has no children.

Returns:

true

See Also:

ExprNode.isLeaf()

getScope

public SearchScope getScope()

Gets the search scope.

Returns:

the search scope

getBaseDn

public Dn getBaseDn()

Gets the base dn.

Returns:

the base dn

getBaseId

public String getBaseId()

Gets the base ID.

Returns:

the base ID

getDerefAliases

public AliasDerefMode getDerefAliases()

Gets the alias dereferencing mode type safe enumeration.

Returns:

the alias dereferencing enumeration constant.

accept

public Object accept(FilterVisitor visitor)

Description copied from interface: ExprNode

Element/node accept method for visitor pattern.

Parameters:

visitor - the filter expression tree structure visitor

Returns:

The modified element

See Also:

ExprNode.accept( FilterVisitor)

isSchemaAware

public boolean isSchemaAware()

Tells if this Node is Schema aware.

Returns:

true if the Node is SchemaAware

equals

public boolean equals(Object obj)

Overrides:

equals in class AbstractExprNode

Returns:

true if both objects are equal

See Also:

Object.equals(Object)

hashCode

public int hashCode()

Overrides:

hashCode in class AbstractExprNode

Returns:

the instance's hash code

See Also:

Object.hashCode()

toString

public String toString()

Overrides:

toString in class AbstractExprNode

Returns:

A string representing the AndNode

See Also:

Object.toString()