Package com.attivio.sdk.search.fields

Class QueryParameter

java.lang.Object

com.attivio.sdk.search.fields.FieldExpression

com.attivio.sdk.search.fields.QueryParameter

All Implemented Interfaces:

java.io.Serializable, java.lang.Cloneable

public class QueryParameter
extends FieldExpression

FieldExpression for returning a query parameter from a QueryRequest.

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
QueryParameter(java.lang.String name, Constant defaultValue)	Constructor

Method Summary

Modifier and Type	Method	Description
boolean	equals(java.lang.Object other)
Constant	getDefaultValue()	Get the default value if the query parameter is not specified/available.
java.lang.String	getName()	Get the name of the requested query parameter.
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	setDefaultValue(Constant value)	Set the default value if the query parameter is not specified/available.
void	setName(java.lang.String value)	Set the name of the requested query parameter.
void	toString(java.lang.StringBuilder buffer, FieldExpression.StringMode mode)	Writes the string representation of this field expression to buffer.
static QueryParameter	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

QueryParameter

public QueryParameter(java.lang.String name,
                      Constant defaultValue)

Constructor

Method Detail

isConstant

public boolean isConstant()

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

Specified by:

isConstant in class FieldExpression

hasChildren

public boolean hasChildren()

Returns true if this field expression has any sub FieldExpressions.

Specified by:

hasChildren in class FieldExpression

getType

public SchemaField.Type getType(Schema schema)

Resolve the type for this expression.

Specified by:

getType in class FieldExpression

getName

public java.lang.String getName()

Get the name of the requested query parameter.

setName

public void setName(java.lang.String value)

Set the name of the requested query parameter.

getDefaultValue

public Constant getDefaultValue()

Get the default value if the query parameter is not specified/available.

setDefaultValue

public void setDefaultValue(Constant value)

Set the default value if the query parameter is not specified/available.

toString

public 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 QueryParameter valueOf(StringParser reader)