com.attivio.sdk.search.query.phrase

Class ScopeTerm

java.lang.Object

com.attivio.sdk.search.query.phrase.Phrase

com.attivio.sdk.search.query.phrase.ScopeTerm

All Implemented Interfaces:

Serializable, Cloneable

public final class ScopeTerm
extends Phrase

Phrase that matches a named scope.

See Also:

Serialized Form

Nested Class Summary

Nested classes/interfaces inherited from class com.attivio.sdk.search.query.phrase.Phrase

Phrase.Parameter

Field Summary

Fields inherited from class com.attivio.sdk.search.query.phrase.Phrase

parameters

Constructor Summary

Constructors

Constructor and Description
ScopeTerm() Constructor.
ScopeTerm(String text) Constructor.

Method Summary

Modifier and Type	Method and Description
ScopeTerm	clone()
boolean	equals(Object other)
int	getEndOffset() Get the end offset (0 indexed, exclusive) for this term in the original query string.
int	getStartOffset() Get the start offset (0 indexed, inclusive) for this term in the original query string.
String	getText()
int	hashCode()
Phrase	rewriteChildren(PhraseHandler handler) Rewrite any children of this phrase using handler.
void	setText(String value)
void	toString(StringBuilder buffer, boolean compact) Appends the string representation of this query to buffer.

Methods inherited from class com.attivio.sdk.search.query.phrase.Phrase

containsParameters, containsParameters, copyParameters, getBoost, getParameter, getParameter, getParameter, getParameter, getParameterInternal, isMatchAll, parameters, parseIntParameter, removeParameter, rewrite, setBoost, setParameter, setParameters, toArray, toString, toString

Methods inherited from class java.lang.Object

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

Constructor Detail

ScopeTerm

public ScopeTerm()

Constructor.

ScopeTerm

public ScopeTerm(String text)

Constructor.

Method Detail

getStartOffset

public int getStartOffset()

Get the start offset (0 indexed, inclusive) for this term in the original query string.

This value is set during parsing and indicates the start offset into the original query string that this term represents. In general, offsets should not be set/modified by query transformers and it is recommended that start and end offsets are set to zero when cloning.

NOTE: if Phrase.getStartOffset() == Phrase.getEndOffset(), this indicates that the term did not come from a parsed query string.

Specified by:

getStartOffset in class Phrase

getEndOffset

public int getEndOffset()

Get the end offset (0 indexed, exclusive) for this term in the original query string.

This value is set during parsing and indicates the end offset of the original query string that this term represents. In general, offsets should not be set/modified by query transformers and it is recommended that start and end offsets are set to zero when cloning.

NOTE: if Phrase.getStartOffset() == Phrase.getEndOffset(), this indicates that the term did not come from a parsed query string.

Specified by:

getEndOffset in class Phrase

getText

public String getText()

setText

public void setText(String value)

rewriteChildren

public Phrase rewriteChildren(PhraseHandler handler)

Description copied from class: Phrase

Rewrite any children of this phrase using handler.

Returns the modified phrase, which may be null if all children were removed by handler.

This method may have no effect if this Phrase represents a leaf in the tree.

NOTE: child phrases are not recursively traversed.

Specified by:

rewriteChildren in class Phrase

hashCode

public int hashCode()

Overrides:

hashCode in class Phrase

equals

public boolean equals(Object other)

Overrides:

equals in class Phrase

clone

public ScopeTerm clone()

Overrides:

clone in class Phrase

toString

public void toString(StringBuilder buffer,
                     boolean compact)

Appends the string representation of this query to buffer.

Specified by:

toString in class Phrase