Package com.attivio.sdk.search.fields

Class ScopeField

java.lang.Object

com.attivio.sdk.search.fields.FieldExpression

com.attivio.sdk.search.fields.ScopeField

All Implemented Interfaces:

java.io.Serializable, java.lang.Cloneable

public class ScopeField
extends FieldExpression

FieldExpression for returning scopes from a stored field.

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
static HighlightMode	DEFAULT_HIGHLIGHT_MODE

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

EMPTY_ARRAY

Constructor Summary

Constructors

Constructor	Description
ScopeField(HighlightMode mode, java.lang.String fieldName, java.lang.String scope)	Construct a new ScopeField for fieldName
ScopeField(java.lang.String fieldName, java.lang.String scope)	Construct a new ScopeField 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.
HighlightMode	getMode()
java.lang.String	getScope()
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	setFieldName(java.lang.String value)	Set the name of the field to return.
void	setMode(HighlightMode value)
void	setScope(java.lang.String value)
protected void	toString(java.lang.StringBuilder buffer, FieldExpression.StringMode stringmode)	Writes the string representation of this field expression to buffer.
static ScopeField	valueOf(HighlightMode mode, StringParser reader)
static ScopeField	valueOf(StringParser parser)

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

Field Detail

DEFAULT_HIGHLIGHT_MODE

public static final HighlightMode DEFAULT_HIGHLIGHT_MODE

Constructor Detail

ScopeField

public ScopeField(java.lang.String fieldName,
                  java.lang.String scope)

Construct a new ScopeField for fieldName

ScopeField

public ScopeField(HighlightMode mode,
                  java.lang.String fieldName,
                  java.lang.String scope)

Construct a new ScopeField 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

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

getFieldName

public java.lang.String getFieldName()

Get the name of the field to return values for.

Overrides:

getFieldName in class FieldExpression

setFieldName

public void setFieldName(java.lang.String value)

Set the name of the field to return.

getScope

public java.lang.String getScope()

setScope

public void setScope(java.lang.String value)

getMode

public HighlightMode getMode()

setMode

public void setMode(HighlightMode value)

toString

protected void toString(java.lang.StringBuilder buffer,
                        FieldExpression.StringMode stringmode)

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 ScopeField valueOf(StringParser parser)

valueOf

public static ScopeField valueOf(HighlightMode mode,
                                 StringParser reader)