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

Class AssertionNode

java.lang.Object

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

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

All Implemented Interfaces:

Cloneable, ExprNode

public abstract class AssertionNode
extends AbstractExprNode

Node used for the application of arbitrary predicates on return candidates. Applies dynamic and programatic criteria for the selection of candidates for return. Nodes of this type may be introduced into the filter expression to provided the opportunity to constrain the search further without altering the search algorithm.

Author:

Apache Directory Project

Field Summary

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

annotations, assertionType, isSchemaAware

Constructor Summary

Constructors

Constructor and Description
AssertionNode(Assertion assertion) Creates an AssertionNode using an arbitrary candidate assertion.
AssertionNode(Assertion assertion, String desc) Creates an AssertionNode using an arbitrary candidate assertion with a descriptions used for filter AST walker dumps.

Method Summary

Modifier and Type	Method and Description
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
boolean	equals(Object obj)
Assertion	getAssertion() Gets the Assertion used by this assertion node.
int	hashCode()
boolean	isLeaf() Always returns true since an AssertionNode has no children.
StringBuilder	printRefinementToBuffer(StringBuilder buf) Default implementation for this method : just throw an exception.
String	toString()

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

escapeFilterValue, get, getAnnotations, getAssertionType, isSchemaAware, set

Methods inherited from class java.lang.Object

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

Constructor Detail

AssertionNode

public AssertionNode(Assertion assertion)

Creates an AssertionNode using an arbitrary candidate assertion.

Parameters:

assertion - the arbitrary selection logic.

AssertionNode

public AssertionNode(Assertion assertion,
                     String desc)

Creates an AssertionNode using an arbitrary candidate assertion with a descriptions used for filter AST walker dumps.

Parameters:

assertion - the arbitrary selection logic.

desc - the printout representation for filter prints.

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

getAssertion

public Assertion getAssertion()

Gets the Assertion used by this assertion node.

Returns:

the assertion used by this node

isLeaf

public boolean isLeaf()

Always returns true since an AssertionNode has no children.

Returns:

true if the node is a leaf,false otherwise

See Also:

ExprNode.isLeaf()

printRefinementToBuffer

public StringBuilder printRefinementToBuffer(StringBuilder buf)
                                      throws UnsupportedOperationException

Description copied from class: AbstractExprNode

Default implementation for this method : just throw an exception.

Specified by:

printRefinementToBuffer in interface ExprNode

Overrides:

printRefinementToBuffer in class AbstractExprNode

Parameters:

buf - the buffer to append to.

Returns:

The buffer in which the refinement has been appended

Throws:

UnsupportedOperationException - if this node isn't a part of a refinement.

See Also:

ExprNode.printRefinementToBuffer(StringBuilder)

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()

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 TODO - what is this modified element ?

Returns:

the modified element

See Also:

ExprNode.accept( FilterVisitor)

toString

public String toString()

Overrides:

toString in class AbstractExprNode

Returns:

A string representing the AndNode

See Also:

Object.toString()