public class MatchingFields extends FieldExpression
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.
FieldExpression.StringModealias, EMPTY_ARRAY| Constructor and Description |
|---|
MatchingFields()
Construct a new MatchingFields.
|
MatchingFields(String alias)
Construct a new MatchingFields.
|
| Modifier and Type | Method and Description |
|---|---|
boolean |
equalsIgnoreAlias(FieldExpression other)
Returns
true if other is the same as this, with the exception of alias. |
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. |
FieldExpression |
rewriteChildren(FieldExpressionHandler handler)
Traverse this FieldExpression using
handler to visit/rewrite direct child elements if this expression. |
void |
setLabel(String value)
Get the name of the query parameter that will be used to label matching subqueries.
|
protected void |
toString(StringBuilder buffer,
FieldExpression.StringMode mode)
Writes the string representation of this field expression to
buffer. |
as, clone, containsAlias, copyOf, equals, equalsIgnoreAlias, getAlias, getDefaultAlias, getFieldName, handleFieldExpression, isConstant, quote, rewrite, rewrite, setAlias, toString, toStringpublic MatchingFields()
public MatchingFields(String alias)
public String getLabel()
If null, matching subqueries will be collected and labeled by field name.
public void setLabel(String value)
If null, matching subqueries will be collected and labeled by field name.
public boolean hasChildren()
true if this field expression has any sub FieldExpressions.hasChildren in class FieldExpressionpublic boolean isConstant()
true if this field expression evaluates to a constant value.isConstant in class FieldExpressionpublic SchemaField.Type getType(Schema schema)
getType in class FieldExpressionpublic FieldExpression rewriteChildren(FieldExpressionHandler handler)
handler to visit/rewrite direct child elements if this expression.
NOTE: this method traverses direct child expressions (if any) only.
rewriteChildren in class FieldExpressionprotected void toString(StringBuilder buffer, FieldExpression.StringMode mode)
buffer.
NOTE: the alias will not be written to buffer by this function.
toString in class FieldExpressionpublic boolean equalsIgnoreAlias(FieldExpression other)
true if other is the same as this, with the exception of alias.equalsIgnoreAlias in class FieldExpressionpublic int hashCode()
hashCode in class FieldExpressionCopyright © 2018 Attivio, Inc. All Rights Reserved.
PATENT NOTICE: Attivio, Inc. Software Related Patents. With respect to the Attivio software product(s) being used, the following patents apply: Querying Joined Data Within A Search Engine Index: United States Patent No.(s): 8,073,840. Ordered Processing of Groups of Messages: U.S. Patent No.(s) 8,495,656. Signal processing approach to sentiment analysis for entities in documents: U.S. Patent No.(s) 8,725,494. Other U.S. and International Patents Pending.