com.attivio.sdk.search.fields

Class Locate

java.lang.Object

com.attivio.sdk.search.fields.FieldExpression

com.attivio.sdk.search.fields.Locate

All Implemented Interfaces:

Serializable, Cloneable

public class Locate
extends FieldExpression

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
Locate(FieldExpression search, FieldExpression string)
Locate(FieldExpression search, FieldExpression string, FieldExpression startPosition)
Locate(FieldExpression search, FieldExpression string, FieldExpression startPosition, String alias)

Method Summary

Modifier and Type	Method and Description
Locate	clone()
boolean	equalsIgnoreAlias(FieldExpression other) Returns true if other is the same as this, with the exception of alias.
FieldExpression	getSearch() Get the search string.
FieldExpression	getStartPosition() Get the starting position to begin the search.
FieldExpression	getString() Get the string to be searched.
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	rewrite(QueryHandler handler, boolean recursive) Rewrite any query objects in this FieldExpression using handler.
FieldExpression	rewriteChildren(FieldExpressionHandler handler) Traverse this FieldExpression using handler to visit/rewrite direct child elements if this expression.
void	setSearch(FieldExpression value) Set the search string.
void	setStartPosition(FieldExpression value) Set the starting position to begin the search.
void	setString(FieldExpression value) Set the string to be searched.
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.FieldExpression

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

Methods inherited from class java.lang.Object

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

Constructor Detail

Locate

public Locate(FieldExpression search,
              FieldExpression string)

Locate

public Locate(FieldExpression search,
              FieldExpression string,
              FieldExpression startPosition)

Locate

public Locate(FieldExpression search,
              FieldExpression string,
              FieldExpression startPosition,
              String alias)

Method Detail

getSearch

public FieldExpression getSearch()

Get the search string.

setSearch

public void setSearch(FieldExpression value)

Set the search string.

getString

public FieldExpression getString()

Get the string to be searched.

setString

public void setString(FieldExpression value)

Set the string to be searched.

getStartPosition

public FieldExpression getStartPosition()

Get the starting position to begin the search.

setStartPosition

public void setStartPosition(FieldExpression value)

Set the starting position to begin the search.

getType

public SchemaField.Type getType(Schema schema)

Resolve the type for this expression.

Specified by:

getType in class FieldExpression

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

rewrite

public void rewrite(QueryHandler handler,
                    boolean recursive)

Rewrite any query objects in this FieldExpression using handler.

Overrides:

rewrite in class FieldExpression

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

equalsIgnoreAlias

public final 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

clone

public Locate clone()

Overrides:

clone 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