com.attivio.sdk.search.query.phrase

Class TermRange

java.lang.Object

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

com.attivio.sdk.search.query.phrase.PhraseTerm

com.attivio.sdk.search.query.phrase.TermRange

All Implemented Interfaces:

TokenAnnotationSet, Serializable, Cloneable

public final class TermRange
extends PhraseTerm

Phrase that matches all terms in a range.

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.PhraseTerm

annotations, endOffset, startOffset

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

parameters

Constructor Summary

Constructors

Constructor and Description
TermRange() Constructor.
TermRange(Object lowerTerm, Object upperTerm) Constructor.
TermRange(Object lowerTerm, Object upperTerm, boolean includeLower, boolean includeUpper) Constructor.
TermRange(String lowerTerm, String upperTerm) Constructor.
TermRange(String lowerTerm, String upperTerm, boolean includeLower, boolean includeUpper) Constructor.

Method Summary

Modifier and Type	Method and Description
boolean	equals(Object other)
String	getLowerTerm() Get the term that specifies the lower bounds for this range.
String	getUpperTerm() Get the term that specifies the upper bounds for this range.
static TermRange	greaterThan(Object term) Creates a TermRange that matches all terms greater than term.
int	hashCode()
boolean	isIncludeLower() Get if the lower term should be included in the range.
boolean	isIncludeUpper() Get if the upper term should be included in the range.
boolean	isMatchAll() Returns true if this phrase will match all documents.
static TermRange	lessThan(Object term) Creates a TermRange that matches all terms less than term.
void	setIncludeLower(boolean value) Set if the lower term should be included in the range.
void	setIncludeUpper(boolean value) Set if the upper term should be included in the range.
void	setLowerTerm(Object value) Set the term that specifies the lower bounds for this range.
void	setLowerTerm(String value) Set the term that specifies the lower bounds for this range.
void	setParameter(String name, Object value) Set parameter name to value.
void	setUpperTerm(Object value) Set the term that specifies the upper bounds for this range.
void	setUpperTerm(String value) Set the term that specifies the upper bounds for this range.
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.PhraseTerm

containsAnnotation, containsParameters, getAnnotations, getEndOffset, getStartOffset, offsetGap, rewriteChildren, setAnnotation, setAnnotations, setEndOffset, setStartOffset, unsetAnnotation

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

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

Methods inherited from class java.lang.Object

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

Constructor Detail

TermRange

public TermRange()

Constructor.

TermRange

public TermRange(String lowerTerm,
                 String upperTerm)

Constructor.

TermRange

public TermRange(Object lowerTerm,
                 Object upperTerm)

Constructor.

TermRange

public TermRange(String lowerTerm,
                 String upperTerm,
                 boolean includeLower,
                 boolean includeUpper)

Constructor.

TermRange

public TermRange(Object lowerTerm,
                 Object upperTerm,
                 boolean includeLower,
                 boolean includeUpper)

Constructor.

Method Detail

isMatchAll

public boolean isMatchAll()

Returns true if this phrase will match all documents.

Overrides:

isMatchAll in class Phrase

setParameter

public void setParameter(String name,
                         Object value)

Set parameter name to value.

NOTE: name is case insensitive.

Overrides:

setParameter in class PhraseTerm

getLowerTerm

public String getLowerTerm()

Get the term that specifies the lower bounds for this range.

If this value is null, the lower bound is unbounded.

setLowerTerm

public void setLowerTerm(String value)

Set the term that specifies the lower bounds for this range.

If value is null, the lower bound will be unbounded.

setLowerTerm

public void setLowerTerm(Object value)

Set the term that specifies the lower bounds for this range.

If value is null, the lower bound will be unbounded.

getUpperTerm

public String getUpperTerm()

Get the term that specifies the upper bounds for this range.

If this value is null, the upper bound is unbounded.

setUpperTerm

public void setUpperTerm(String value)

Set the term that specifies the upper bounds for this range.

If value is null, the upper bound will be unbounded.

setUpperTerm

public void setUpperTerm(Object value)

Set the term that specifies the upper bounds for this range.

If value is null, the upper bound will be unbounded.

isIncludeLower

public boolean isIncludeLower()

Get if the lower term should be included in the range.

setIncludeLower

public void setIncludeLower(boolean value)

Set if the lower term should be included in the range.

isIncludeUpper

public boolean isIncludeUpper()

Get if the upper term should be included in the range.

setIncludeUpper

public void setIncludeUpper(boolean value)

Set if the upper term should be included in the range.

hashCode

public int hashCode()

Overrides:

hashCode in class PhraseTerm

equals

public boolean equals(Object other)

Overrides:

equals in class PhraseTerm

toString

public void toString(StringBuilder buffer,
                     boolean compact)

Appends the string representation of this query to buffer.

Specified by:

toString in class Phrase

lessThan

public static TermRange lessThan(Object term)

Creates a TermRange that matches all terms less than term.

greaterThan

public static TermRange greaterThan(Object term)

Creates a TermRange that matches all terms greater than term.