com.attivio.sdk.search.query.phrase

Interface PhraseHandler

All Known Subinterfaces:

PhraseHandler

public interface PhraseHandler

Handler interface used for traversing a Phrase tree.

Custom traversal/modification of phrases can be created by implementing this interface and passing it to Phrase.rewrite(PhraseHandler) or Phrase.rewriteChildren(PhraseHandler).

Method Summary

Modifier and Type	Method and Description
Phrase	handlePhrase(Phrase phrase) Method called for handling an encountered Phrase during traversal.

Method Detail

handlePhrase

Phrase handlePhrase(Phrase phrase)

Method called for handling an encountered Phrase during traversal.

Return the passed in phrase if modified in place or no modification to tree should be made. Return a new Phrase instance to replace the passed in phrase in the query tree. Return null to remove the phrase from the tree.

NOTE: returning a new Phrase instance or null will result in stopping any recursive traversal.