Package com.attivio.sdk.search.fields

Class StoredField

java.lang.Object

com.attivio.sdk.search.fields.FieldExpression

com.attivio.sdk.search.fields.StoredField

All Implemented Interfaces:

java.io.Serializable, java.lang.Cloneable

public class StoredField
extends FieldExpression

FieldExpression for returning the values for a stored field.

NOTE: The special field "*" will return all stored fields. This is useful if you are requesting specific FieldExpressions and still want all stored fields returned.
EX: StoredField field = new StoredField("*");

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
StoredField(java.lang.String fieldName)	Construct a new field source for fieldName

Method Summary

Modifier and Type	Method	Description
boolean	equals(java.lang.Object other)
java.lang.String	getFieldName()	Get the name of the field to return values for.
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.
protected static void	quoteFieldName(java.lang.StringBuilder buffer, java.lang.String fieldName)
void	setFieldName(java.lang.String value)	Set the name of the field to return.
void	toString(java.lang.StringBuilder buffer, FieldExpression.StringMode mode)	Writes the string representation of this field expression to buffer.
static StoredField	valueOf(StringParser reader)

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

apply, clone, copyOf, forEachField, forEachPhrase, forEachQuery, getDefaultName, 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

StoredField

public StoredField(java.lang.String fieldName)

Construct a new field source for fieldName

Method Detail

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

getFieldName

public java.lang.String getFieldName()

Get the name of the field to return values for.

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

setFieldName

public void setFieldName(java.lang.String value)

Set the name of the field to return.

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

quoteFieldName

protected static void quoteFieldName(java.lang.StringBuilder buffer,
                                     java.lang.String fieldName)

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