Package com.attivio.sdk.search.fields

Class UserDefinedField

java.lang.Object

com.attivio.sdk.search.fields.FieldExpression

com.attivio.sdk.search.fields.UserDefinedField

All Implemented Interfaces:

java.io.Serializable, java.lang.Cloneable

public class UserDefinedField
extends FieldExpression

FieldExpression for generically modeling a user defined field implementation.

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
UserDefinedField(java.lang.String name)
UserDefinedField(java.lang.String name, FieldExpression... args)

Method Summary

Modifier and Type	Method	Description
UserDefinedField	addArgument(FieldExpression value)	Add an argument.
UserDefinedField	clone()
boolean	equals(java.lang.Object other)
FieldExpression	forEachField(java.util.function.Function<FieldExpression,FieldExpression> handler)	Applies handler for each FieldExpression argument.
java.util.List<FieldExpression>	getArguments()	Get the arguments.
java.lang.String	getName()	Get the name of the User Defined Function to evaluate.
java.lang.Object	getParameter(java.lang.String key)	Get a parameter.
boolean	getParameter(java.lang.String key, boolean defaultValue)	Get a boolean parameter, returning defaultValue if parameter does not exist or is not a boolean.
double	getParameter(java.lang.String key, double defaultValue)	Get a double parameter, returning defaultValue if parameter does not exist or is not a double.
int	getParameter(java.lang.String key, int defaultValue)	Get an int parameter, returning defaultValue if parameter does not exist or is not an int.
long	getParameter(java.lang.String key, long defaultValue)	Get a long parameter, returning defaultValue if parameter does not exist or is not a long.
java.lang.String	getParameter(java.lang.String key, java.lang.String defaultValue)	Get a String parameter, returning defaultValue if parameter does not exist.
java.util.Date	getParameter(java.lang.String key, java.util.Date defaultValue)	Get a Date parameter, returning defaultValue if parameter is not a Date.
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.
UserDefinedField	removeParameter(java.lang.String key)	Remove a parameter.
void	rewrite(QueryHandler handler, boolean recursive)	Rewrite any query objects in this FieldExpression using handler.
void	setArguments(FieldExpression... value)	Set the arguments.
void	setArguments(java.util.List<FieldExpression> value)	Set the arguments.
void	setName(java.lang.String value)	Set the name of the User Defined Function to evaluate.
UserDefinedField	setParameter(java.lang.String key, java.lang.Boolean value)	Set a parameter.
UserDefinedField	setParameter(java.lang.String key, java.lang.Number value)	Set a parameter.
UserDefinedField	setParameter(java.lang.String key, java.lang.String value)	Set a parameter.
UserDefinedField	setParameter(java.lang.String key, java.util.Date value)	Set a parameter.
protected void	toString(java.lang.StringBuilder buffer, FieldExpression.StringMode mode)	Writes the string representation of this field expression to buffer.
static UserDefinedField	valueOf(StringParser parser)

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

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

Methods inherited from class java.lang.Object

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

Constructor Detail

UserDefinedField

public UserDefinedField(java.lang.String name)

UserDefinedField

public UserDefinedField(java.lang.String name,
                        FieldExpression... args)

Method Detail

getName

public java.lang.String getName()

Get the name of the User Defined Function to evaluate.

setName

public void setName(java.lang.String value)

Set the name of the User Defined Function to evaluate.

getArguments

public java.util.List<FieldExpression> getArguments()

Get the arguments.

setArguments

public void setArguments(java.util.List<FieldExpression> value)

Set the arguments.

setArguments

public void setArguments(FieldExpression... value)

Set the arguments.

addArgument

public UserDefinedField addArgument(FieldExpression value)

Add an argument.

getParameter

public java.lang.Object getParameter(java.lang.String key)

Get a parameter.

getParameter

public java.lang.String getParameter(java.lang.String key,
                                     java.lang.String defaultValue)

Get a String parameter, returning defaultValue if parameter does not exist.

getParameter

public java.util.Date getParameter(java.lang.String key,
                                   java.util.Date defaultValue)

Get a Date parameter, returning defaultValue if parameter is not a Date.

getParameter

public int getParameter(java.lang.String key,
                        int defaultValue)

Get an int parameter, returning defaultValue if parameter does not exist or is not an int.

getParameter

public long getParameter(java.lang.String key,
                         long defaultValue)

Get a long parameter, returning defaultValue if parameter does not exist or is not a long.

getParameter

public double getParameter(java.lang.String key,
                           double defaultValue)

Get a double parameter, returning defaultValue if parameter does not exist or is not a double.

getParameter

public boolean getParameter(java.lang.String key,
                            boolean defaultValue)

Get a boolean parameter, returning defaultValue if parameter does not exist or is not a boolean.

setParameter

public UserDefinedField setParameter(java.lang.String key,
                                     java.lang.String value)

Set a parameter.

setParameter

public UserDefinedField setParameter(java.lang.String key,
                                     java.lang.Boolean value)

Set a parameter.

setParameter

public UserDefinedField setParameter(java.lang.String key,
                                     java.util.Date value)

Set a parameter.

setParameter

public UserDefinedField setParameter(java.lang.String key,
                                     java.lang.Number value)

Set a parameter.

removeParameter

public UserDefinedField removeParameter(java.lang.String key)

Remove a parameter.

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

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

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

clone

public UserDefinedField clone()

Overrides:

clone in class FieldExpression

valueOf

public static UserDefinedField valueOf(StringParser parser)