Package com.attivio.sdk.search.fields

Class MatchingFields

java.lang.Object

com.attivio.sdk.search.fields.FieldExpression

com.attivio.sdk.search.fields.MatchingFields

All Implemented Interfaces:

java.io.Serializable, java.lang.Cloneable

public class MatchingFields
extends FieldExpression

FieldExpression to provide the list of fields that matched during query execution.

This is useful if performing an OR query across multiple fields, as this field expression will indicate what fields provided the match for the OR for each respective matching document.

PERFORMANCE NOTE: this field expression can be quite costly. It will cause the query execution to be upwards of 2x slower than normal query execution without requesting matching fields.

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

EMPTY_ARRAY

Constructor Summary

Constructors

Constructor	Description
MatchingFields()	Construct a new MatchingFields.

Method Summary

Modifier and Type	Method	Description
boolean	equals(java.lang.Object other)
java.lang.String	getLabel()	Get the name of the query parameter that will be used to label matching subqueries.
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	setLabel(java.lang.String value)	Get the name of the query parameter that will be used to label matching subqueries.
protected void	toString(java.lang.StringBuilder buffer, FieldExpression.StringMode mode)	Writes the string representation of this field expression to buffer.
static MatchingFields	valueOf(StringParser reader)

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

apply, clone, copyOf, forEachField, forEachPhrase, forEachQuery, getDefaultName, getFieldName, isConstant, parse, quote, rewrite, rewrite, rewriteChildren, toString, toString, valueOf

Methods inherited from class java.lang.Object

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

Constructor Detail

MatchingFields

public MatchingFields()

Construct a new MatchingFields.

Method Detail

getLabel

public java.lang.String getLabel()

Get the name of the query parameter that will be used to label matching subqueries.

If null, matching subqueries will be collected and labeled by field name.

setLabel

public void setLabel(java.lang.String value)

Get the name of the query parameter that will be used to label matching subqueries.

If null, matching subqueries will be collected and labeled by field name.

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

getType

public SchemaField.Type getType(Schema schema)

Resolve the type for this expression.

Specified by:

getType in class FieldExpression

toString

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

Writes the string representation of this field expression to buffer.

Specified by:

toString in class FieldExpression

equals

public boolean equals(java.lang.Object other)

Overrides:

equals in class java.lang.Object

hashCode

public int hashCode()

Overrides:

hashCode in class FieldExpression

valueOf

public static MatchingFields valueOf(StringParser reader)