com.attivio.sdk.search.fields

Class FieldExpressionHandler

java.lang.Object

com.attivio.sdk.search.fields.FieldExpressionHandler

Direct Known Subclasses:

FieldExpressionHandler

public abstract class FieldExpressionHandler
extends Object

FieldExpressionHandler is used for traversing and transforming field expressions.

Constructor Summary

Constructors

Constructor and Description
FieldExpressionHandler()

Method Summary

Modifier and Type	Method and Description
abstract FieldExpression	handleFieldExpression(FieldExpression field) Method called for every FieldExpression encountered while traversing a top level FieldExpression.

Methods inherited from class java.lang.Object

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

Constructor Detail

FieldExpressionHandler

public FieldExpressionHandler()

Method Detail

handleFieldExpression

public abstract FieldExpression handleFieldExpression(FieldExpression field)

Method called for every FieldExpression encountered while traversing a top level FieldExpression.

To delete the encountered FieldExpression from the tree, return null from this method.

To replace the encountered FieldExpression with a new value, return a new FieldExpression.

NOTE: if field has child nodes, this method will be called after the child nodes have been traversed.

CAUTION: any caller of this method must ensure that field is not null.

Parameters:

field - The FieldExpression currently being traversed.

Returns:

the FieldExpression to replace field in the tree. Return null to delete this FieldExpression.