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:

Serializable, 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 inherited from class com.attivio.sdk.search.fields.FieldExpression

alias, EMPTY_ARRAY

Constructor Summary

Constructors

Constructor and Description
ScopeField(HighlightMode mode, String fieldName, String scope) Construct a new field source for fieldName
ScopeField(HighlightMode mode, String fieldName, String scope, String alias) Construct a new ScopeField for fieldName
ScopeField(String fieldName, String scope) Construct a new field source for fieldName
ScopeField(String fieldName, String scope, String alias) Construct a new ScopeField for fieldName

Method Summary

Modifier and Type	Method and Description
boolean	equalsIgnoreAlias(FieldExpression other) Returns true if other is the same as this, with the exception of alias.
String	getFieldName() Get the name of the field to return values for.
HighlightMode	getMode()
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.
FieldExpression	rewriteChildren(FieldExpressionHandler handler) Traverse this FieldExpression using handler to visit/rewrite direct child elements if this expression.
void	setFieldName(String value) Set the name of the field to return.
void	setMode(HighlightMode value)
void	setScope(String value)
protected void	toString(StringBuilder buffer, FieldExpression.StringMode stringmode) Writes the string representation of this field expression to buffer.

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

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

Methods inherited from class java.lang.Object

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

Constructor Detail

ScopeField

public ScopeField(String fieldName,
                  String scope)

Construct a new field source for fieldName

ScopeField

public ScopeField(HighlightMode mode,
                  String fieldName,
                  String scope)

Construct a new field source for fieldName

ScopeField

public ScopeField(String fieldName,
                  String scope,
                  String alias)

Construct a new ScopeField for fieldName

ScopeField

public ScopeField(HighlightMode mode,
                  String fieldName,
                  String scope,
                  String alias)

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

Get the name of the field to return values for.

Overrides:

getFieldName in class FieldExpression

setFieldName

public void setFieldName(String value)

Set the name of the field to return.

getScope

public String getScope()

setScope

public void setScope(String value)

getMode

public HighlightMode getMode()

setMode

public void setMode(HighlightMode value)

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

toString

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

Writes the string representation of this field expression to buffer.

NOTE: the alias will not be written to buffer by this function.

Specified by:

toString in class FieldExpression

equalsIgnoreAlias

public boolean equalsIgnoreAlias(FieldExpression other)

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

Specified by:

equalsIgnoreAlias in class FieldExpression

hashCode

public int hashCode()

Overrides:

hashCode in class FieldExpression