org.apache.directory.shared.ldap.filter
Class ScopeNode

java.lang.Object
  org.apache.directory.shared.ldap.filter.AbstractExprNode
      org.apache.directory.shared.ldap.filter.ScopeNode

All Implemented Interfaces:

java.lang.Cloneable, ExprNode

public class ScopeNode
extends AbstractExprNode

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

Version:

$Rev: 746607 $

Author:

Apache Directory Project

Field Summary

Fields inherited from class org.apache.directory.shared.ldap.filter.AbstractExprNode

annotations, assertionType

Constructor Summary

ScopeNode(AliasDerefMode aliasDerefAliases, java.lang.String baseDn, SearchScope scope)
Creates a new ScopeNode object.

Method Summary

java.lang.Object	accept(FilterVisitor visitor) Element/node accept method for visitor pattern.
ExprNode	clone() Makes a full clone in new memory space of the current node and children
java.lang.String	getBaseDn() Gets the base dn.
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.
java.lang.String	toString()

Methods inherited from class org.apache.directory.shared.ldap.filter.AbstractExprNode

equals, escapeFilterValue, get, getAnnotations, getAssertionType, printRefinementToBuffer, set

Methods inherited from class java.lang.Object

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

Constructor Detail

ScopeNode

public ScopeNode(AliasDerefMode aliasDerefAliases,
                 java.lang.String baseDn,
                 SearchScope scope)

Creates a new ScopeNode object.

Parameters:

aliasDerefAliases - the alias dereferencing mode

baseDn - the search base

scope - the search scope

Method Detail

clone

public ExprNode clone()

Makes a full clone in new memory space of the current node and children

Specified by:

clone in interface ExprNode

Overrides:

clone in class AbstractExprNode

Returns:

the clone

isLeaf

public boolean isLeaf()

Always returns true since a scope node has no children.

Specified by:

isLeaf in interface ExprNode

Specified by:

isLeaf in class AbstractExprNode

Returns:

true

See Also:

ExprNode.isLeaf()

getScope

public SearchScope getScope()

Gets the search scope.

Returns:

the search scope

getBaseDn

public java.lang.String getBaseDn()

Gets the base dn.

Returns:

the base dn

getDerefAliases

public AliasDerefMode getDerefAliases()

Gets the alias dereferencing mode type safe enumeration.

Returns:

the alias dereferencing enumeration constant.

accept

public java.lang.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( org.apache.directory.shared.ldap.filter.FilterVisitor)

hashCode

public int hashCode()

Overrides:

hashCode in class AbstractExprNode

Returns:

the instance's hash code

See Also:

Object.hashCode()

toString

public java.lang.String toString()

Overrides:

toString in class AbstractExprNode

Returns:

A string representing the AndNode

See Also:

Object.toString()