com.attivio.sdk.search.query.phrase

Class PhraseOr

java.lang.Object

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

com.attivio.sdk.search.query.phrase.PhraseOr

All Implemented Interfaces:

Serializable, Cloneable

public final class PhraseOr
extends Phrase

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

Modifier and Type	Field and Description
protected List<Phrase>	terms List of terms for matching.

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

parameters

Constructor Summary

Constructors

Constructor and Description
PhraseOr() Constructor
PhraseOr(List<Phrase> terms) Constructor
PhraseOr(Phrase... terms) Constructor
PhraseOr(Phrase term1, Phrase term2) Constructor
PhraseOr(String... terms) Constructor

Method Summary

Modifier and Type	Method and Description
void	addTerm(Phrase term) Add term to this phrase.
void	addTerm(String term) Add a SearchTerm to this phrase.
void	addTerms(List<Phrase> terms) Add terms to this phrase.
void	addTerms(Phrase[] terms) Add terms to this phrase.
void	addTerms(Phrase[] terms, int offset, int length) Add
PhraseOr	clone()
protected Phrase	clone(Phrase[] terms, int length) Clone to facilitate rewrite().
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.
List<Phrase>	getTerms() Get the terms for this phrase.
int	hashCode()
Phrase	rewrite(PhraseHandler handler) Recursively rewrite this phrase using handler.
Phrase	rewriteChildren(PhraseHandler handler) Rewrite any children of this phrase using handler.
void	setTerms(List<Phrase> value) Set the terms for this phrase.
void	setTerms(Phrase... args) Set the terms for this phrase.
void	setTerms(String... args) Set the terms for this phrase.
int	size() Get the number of terms in this phrase.
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, setBoost, setParameter, setParameters, toArray, toString, toString

Methods inherited from class java.lang.Object

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

Field Detail

terms

protected List<Phrase> terms

List of terms for matching.

Constructor Detail

PhraseOr

public PhraseOr()

Constructor

PhraseOr

public PhraseOr(String... terms)

Constructor

PhraseOr

public PhraseOr(Phrase... terms)

Constructor

PhraseOr

public PhraseOr(Phrase term1,
                Phrase term2)

Constructor

PhraseOr

public PhraseOr(List<Phrase> terms)

Constructor

Method Detail

clone

protected Phrase clone(Phrase[] terms,
                       int length)

Clone to facilitate rewrite().

addTerm

public void addTerm(Phrase term)

Add term to this phrase.

hashCode

public int hashCode()

equals

public boolean equals(Object other)

clone

public PhraseOr clone()

toString

public void toString(StringBuilder buffer,
                     boolean compact)

Appends the string representation of this query to buffer.

Specified by:

toString in class Phrase

getStartOffset

public int getStartOffset()

Description copied from class: Phrase

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

Description copied from class: Phrase

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

size

public int size()

Get the number of terms in this phrase.

getTerms

public List<Phrase> getTerms()

Get the terms for this phrase.

setTerms

public void setTerms(List<Phrase> value)

Set the terms for this phrase.

setTerms

public void setTerms(String... args)

Set the terms for this phrase.

setTerms

public void setTerms(Phrase... args)

Set the terms for this phrase.

addTerm

public void addTerm(String term)

Add a SearchTerm to this phrase.

addTerms

public void addTerms(Phrase[] terms)

Add terms to this phrase.

addTerms

public void addTerms(Phrase[] terms,
                     int offset,
                     int length)

Add

length terms from terms starting at offset.

addTerms

public void addTerms(List<Phrase> terms)

Add terms to this phrase.

rewrite

public Phrase rewrite(PhraseHandler handler)

Recursively rewrite this phrase using handler.

NOTE: If a phrase has any children, the phrase itself will be passed to handler first, prior to its children. If handler returns a new phrase, its children will not be traversed automatically.

Overrides:

rewrite in class Phrase

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