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:

Serializable, Cloneable

Direct Known Subclasses:

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

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 and Description
protected FieldExpression	expression The expression that is the argument to this expression.

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

alias, EMPTY_ARRAY

Constructor Summary

Constructors

Constructor and Description
UnaryFieldExpression() Construct a new UnaryFieldExpression using the default alias.
UnaryFieldExpression(FieldExpression argument) Construct a new UnaryFieldExpression.
UnaryFieldExpression(FieldExpression argument, String alias) Construct a new UnaryFieldExpression.
UnaryFieldExpression(String alias) Construct a new UnaryFieldExpression with an alias.

Method Summary

Modifier and Type	Method and Description
FieldExpression	clone()
protected FieldExpression	clone(FieldExpression e) Create a new instance of this FieldExpression, with a different argument.
boolean	equalsIgnoreAlias(FieldExpression other) Returns true if other is the same as this, with the exception of alias.
FieldExpression	getExpression() Get the expression to apply the aggregation function to.
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.
protected abstract boolean	parametersEqual(FieldExpression other) Returns true if other's parameters are the same as this.
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	setExpression(FieldExpression expression) Set the expression to apply the aggregation function to.

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

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

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()

Construct a new UnaryFieldExpression using the default alias.

UnaryFieldExpression

public UnaryFieldExpression(String alias)

Construct a new UnaryFieldExpression with an alias.

UnaryFieldExpression

public UnaryFieldExpression(FieldExpression argument)

Construct a new UnaryFieldExpression.

UnaryFieldExpression

public UnaryFieldExpression(FieldExpression argument,
                            String alias)

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 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

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

equalsIgnoreAlias

public final boolean equalsIgnoreAlias(FieldExpression other)

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

Specified by:

equalsIgnoreAlias in class FieldExpression

parametersEqual

protected abstract boolean parametersEqual(FieldExpression other)

Returns true if other's parameters are the same as this.

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.