com.attivio.sdk.search.fields

Class ClauseContext

java.lang.Object

com.attivio.sdk.search.fields.FieldExpression

com.attivio.sdk.search.fields.UnaryFieldExpression

com.attivio.sdk.search.fields.ClauseContext

All Implemented Interfaces:

Serializable, Cloneable

public class ClauseContext
extends UnaryFieldExpression

Selects a clause that fields should be extracted for.

Clauses can be named by setting the alias on a JoinClause. When clauses are named, fields for child documents from those clauses can be selected by wrapping a FieldExpression with a ClauseContext.

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 and Description
static String	ALL_CONTEXT Context to request field from all clauses.
static String	DEFAULT_CLAUSE_CONTEXT Default context name for clauses.
static String	ROOT_CONTEXT Context for root clause.

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

expression

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

alias, EMPTY_ARRAY

Constructor Summary

Constructors

Constructor and Description
ClauseContext(FieldExpression expression, String clause)
ClauseContext(FieldExpression expression, String clause, String alias)
ClauseContext(String field, String clause)
ClauseContext(String field, String clause, String alias)

Method Summary

Modifier and Type	Method and Description
ClauseContext	clone()
String	getClauseName() Get the name of the clause to select fields for.
SchemaField.Type	getType(Schema schema) Resolve the type for this expression.
int	hashCode()
boolean	isConstant() Returns true if this field expression evaluates to a constant value.
protected boolean	parametersEqual(FieldExpression other) Returns true if other's parameters are the same as this.
void	setClauseName(String value) Set the name of the clause to select fields for.
protected void	toString(StringBuilder buffer, FieldExpression.StringMode mode) Writes the string representation of this field expression to buffer.

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

clone, equalsIgnoreAlias, getExpression, getFieldName, hasChildren, rewrite, rewriteChildren, setExpression

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

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

Methods inherited from class java.lang.Object

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

Field Detail

ROOT_CONTEXT

public static final String ROOT_CONTEXT

Context for root clause.

See Also:

Constant Field Values

DEFAULT_CLAUSE_CONTEXT

public static final String DEFAULT_CLAUSE_CONTEXT

Default context name for clauses.

See Also:

Constant Field Values

ALL_CONTEXT

public static final String ALL_CONTEXT

Context to request field from all clauses.

See Also:

Constant Field Values

Constructor Detail

ClauseContext

public ClauseContext(String field,
                     String clause)

ClauseContext

public ClauseContext(FieldExpression expression,
                     String clause)

ClauseContext

public ClauseContext(String field,
                     String clause,
                     String alias)

ClauseContext

public ClauseContext(FieldExpression expression,
                     String clause,
                     String alias)

Method Detail

isConstant

public boolean isConstant()

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

Overrides:

isConstant in class UnaryFieldExpression

getClauseName

public String getClauseName()

Get the name of the clause to select fields for.

A clause name of * or null will select fields for all clauses.

setClauseName

public void setClauseName(String value)

Set the name of the clause to select fields for.

getType

public SchemaField.Type getType(Schema schema)

Resolve the type for this expression.

Specified by:

getType in class FieldExpression

toString

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

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

hashCode

public int hashCode()

Overrides:

hashCode in class UnaryFieldExpression

parametersEqual

protected boolean parametersEqual(FieldExpression other)

Returns true if other's parameters are the same as this.

Specified by:

parametersEqual in class UnaryFieldExpression

clone

public ClauseContext clone()

Overrides:

clone in class UnaryFieldExpression