com.attivio.sdk.search.query.phrase

Class WildcardTerm

java.lang.Object

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

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

com.attivio.sdk.search.query.phrase.WildcardTerm

All Implemented Interfaces:

TokenAnnotationSet, Serializable, Cloneable

public final class WildcardTerm
extends PhraseTerm

Phrase that matches all terms that match a wildcard expression.

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
WildcardTerm() Constructor
WildcardTerm(SearchTerm term) Constructor
WildcardTerm(String text) Constructor
WildcardTerm(String text, TokenAnnotation... annotation) Constructor
WildcardTerm(String text, TokenAnnotation annotation) Constructor

Method Summary

Modifier and Type	Method and Description
WildcardTerm	clone()
static boolean	containsWildcard(String text) Check if text contains any wildcard characters.
boolean	equals(Object other)
String	getText()
int	hashCode()
boolean	isMatchAll() Returns true if this phrase will match all documents.
static boolean	isMatchAll(String text) Check if text is a wildcard that matches everything.
static WildcardTerm	matchAll() Create a wildcard term that matches all documents.
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.PhraseTerm

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

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

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

WildcardTerm

public WildcardTerm()

Constructor

WildcardTerm

public WildcardTerm(String text)

Constructor

WildcardTerm

public WildcardTerm(String text,
                    TokenAnnotation annotation)

Constructor

WildcardTerm

public WildcardTerm(String text,
                    TokenAnnotation... annotation)

Constructor

WildcardTerm

public WildcardTerm(SearchTerm term)

Constructor

Method Detail

getText

public String getText()

setText

public void setText(String value)

isMatchAll

public boolean isMatchAll()

Returns true if this phrase will match all documents.

Overrides:

isMatchAll in class Phrase

clone

public WildcardTerm clone()

Overrides:

clone in class Phrase

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

matchAll

public static WildcardTerm matchAll()

Create a wildcard term that matches all documents.

isMatchAll

public static boolean isMatchAll(String text)

Check if text is a wildcard that matches everything.

containsWildcard

public static boolean containsWildcard(String text)

Check if text contains any wildcard characters.