com.attivio.sdk.search.fields

Class PhraseMatch

java.lang.Object

com.attivio.sdk.search.fields.FieldExpression

com.attivio.sdk.search.fields.PhraseMatch

All Implemented Interfaces:

Serializable, Cloneable

public final class PhraseMatch
extends FieldExpression

FieldExpression that returns a boolean result indicating if a phrase matches a document.

See Also:

Serialized Form

Nested Class Summary

Nested classes/interfaces inherited from class com.attivio.sdk.search.fields.FieldExpression

FieldExpression.StringMode

Field Summary

Fields inherited from class com.attivio.sdk.search.fields.FieldExpression

alias, EMPTY_ARRAY

Constructor Summary

Constructors

Constructor and Description
PhraseMatch(String field, Phrase phrase)

Method Summary

Modifier and Type	Method and Description
protected void	appendParameters(StringBuilder buffer)
boolean	equalsIgnoreAlias(FieldExpression other) Returns true if other is the same as this, with the exception of alias.
String	getFieldName() Get the field to match against.
Phrase	getPhrase() Get the phrase to use for matching.
SchemaField.Type	getType(Schema schema) Resolve the type for this expression.
boolean	hasChildren() Returns true if this field expression has any sub FieldExpressions.
int	hashCode()
boolean	isConstant() Returns true if this field expression evaluates to a constant value.
void	rewrite(QueryHandler handler, boolean recursive) Rewrite any query objects in this FieldExpression using handler.
FieldExpression	rewriteChildren(FieldExpressionHandler handler) Traverse this FieldExpression using handler to visit/rewrite direct child elements if this expression.
void	setFieldName(String value) Set the field to match against.
void	setPhrase(Phrase value) Set the phrase to use for matching.
protected void	toString(StringBuilder buffer, FieldExpression.StringMode mode) Writes the string representation of this field expression to buffer.

Methods inherited from class com.attivio.sdk.search.fields.FieldExpression

as, clone, containsAlias, copyOf, equals, equalsIgnoreAlias, getAlias, getDefaultAlias, handleFieldExpression, isConstant, quote, rewrite, setAlias, toString, toString

Methods inherited from class java.lang.Object

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

Constructor Detail

PhraseMatch

public PhraseMatch(String field,
                   Phrase phrase)

Method Detail

getType

public SchemaField.Type getType(Schema schema)

Resolve the type for this expression.

Specified by:

getType in class FieldExpression

equalsIgnoreAlias

public boolean equalsIgnoreAlias(FieldExpression other)

Returns true if other is the same as this, with the exception of alias.

hashCode

public int hashCode()

getFieldName

public String getFieldName()

Get the field to match against.

Overrides:

getFieldName in class FieldExpression

setFieldName

public void setFieldName(String value)

Set the field to match against.

getPhrase

public Phrase getPhrase()

Get the phrase to use for matching.

setPhrase

public void setPhrase(Phrase value)

Set the phrase to use for matching.

hasChildren

public boolean hasChildren()

Returns true if this field expression has any sub FieldExpressions.

Specified by:

hasChildren in class FieldExpression

isConstant

public boolean isConstant()

Returns true if this field expression evaluates to a constant value.

Specified by:

isConstant in class FieldExpression

rewriteChildren

public FieldExpression rewriteChildren(FieldExpressionHandler handler)

Traverse this FieldExpression using handler to visit/rewrite direct child elements if this expression.

NOTE: this method traverses direct child expressions (if any) only.

Specified by:

rewriteChildren in class FieldExpression

rewrite

public void rewrite(QueryHandler handler,
                    boolean recursive)

Rewrite any query objects in this FieldExpression using handler.

Overrides:

rewrite in class FieldExpression

toString

protected void toString(StringBuilder buffer,
                        FieldExpression.StringMode mode)

Writes the string representation of this field expression to buffer.

NOTE: the alias will not be written to buffer by this function.

Specified by:

toString in class FieldExpression

appendParameters

protected void appendParameters(StringBuilder buffer)