Package com.attivio.sdk.search.fields

Class UnaryFieldExpression

java.lang.Object

com.attivio.sdk.search.fields.FieldExpression

com.attivio.sdk.search.fields.UnaryFieldExpression

All Implemented Interfaces:

java.io.Serializable, java.lang.Cloneable

Direct Known Subclasses:

AggregateExpression, Cast, ClauseContext, Collate, DateExtract, DateFormat, Freshness, FuzzyMatch, GeoBoost, GeoDistance, LowerCase, MultiValueJoin, RegexMatch, StandardScore, StringLength, SubString, Teaser, TitleCase, Trim, UnaryMathExpression, UpperCase, WildcardMatch

public abstract class UnaryFieldExpression
extends FieldExpression

Abstract FieldExpression that takes a single FieldExpression as an argument.

See Also:

Serialized Form

Nested Class Summary

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

FieldExpression.StringMode

Field Summary

Fields

Modifier and Type	Field	Description
protected FieldExpression	expression	The expression that is the argument to this expression.

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

EMPTY_ARRAY

Constructor Summary

Constructors

Constructor	Description
UnaryFieldExpression()
UnaryFieldExpression(FieldExpression argument)	Construct a new UnaryFieldExpression.

Method Summary

Modifier and Type	Method	Description
FieldExpression	clone()
protected FieldExpression	clone(FieldExpression e)	Create a new instance of this FieldExpression, with a different argument.
boolean	equals(java.lang.Object other)
FieldExpression	forEachField(java.util.function.Function<FieldExpression,FieldExpression> handler)	Applies handler for each FieldExpression argument.
FieldExpression	getExpression()	Get the expression to apply the aggregation function to.
java.lang.String	getFieldName()	Get the field name 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.
void	setExpression(FieldExpression expression)	Set the expression to apply the aggregation function to.

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

apply, copyOf, forEachPhrase, forEachQuery, getDefaultName, getType, isConstant, parse, quote, rewrite, rewriteChildren, toString, toString, toString, valueOf

Methods inherited from class java.lang.Object

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

Field Detail

expression

protected FieldExpression expression

The expression that is the argument to this expression.

Constructor Detail

UnaryFieldExpression

public UnaryFieldExpression()

UnaryFieldExpression

public UnaryFieldExpression(FieldExpression argument)

Construct a new UnaryFieldExpression.

Method Detail

isConstant

public boolean isConstant()

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

Specified by:

isConstant in class FieldExpression

getExpression

public FieldExpression getExpression()

Get the expression to apply the aggregation function to.

setExpression

public void setExpression(FieldExpression expression)

Set the expression to apply the aggregation function to.

getFieldName

public java.lang.String getFieldName()

Get the field name for this expression.

This is used as a hint to the search engine to tie back to the schema. null may be returned if this expression contains no field. If this expression is composed of many fields, this can be either the "primary" field for the expression, or null.

Overrides:

getFieldName in class FieldExpression

hasChildren

public boolean hasChildren()

Returns true if this field expression has any sub FieldExpressions.

Specified by:

hasChildren 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

forEachField

public FieldExpression forEachField(java.util.function.Function<FieldExpression,FieldExpression> handler)

Applies handler for each FieldExpression argument.

Returns the modified FieldExpression, or null.

Overrides:

forEachField 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

clone

public FieldExpression clone()

Overrides:

clone in class FieldExpression

clone

protected FieldExpression clone(FieldExpression e)

Create a new instance of this FieldExpression, with a different argument.