com.attivio.sdk.search.fields

Class SubString

java.lang.Object

com.attivio.sdk.search.fields.FieldExpression

com.attivio.sdk.search.fields.UnaryFieldExpression

com.attivio.sdk.search.fields.SubString

All Implemented Interfaces:

Serializable, Cloneable

public class SubString
extends UnaryFieldExpression

Substring field expression.

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.UnaryFieldExpression

expression

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

alias, EMPTY_ARRAY

Constructor Summary

Constructors

Constructor and Description
SubString(FieldExpression expression, int offset, int length)
SubString(FieldExpression expression, int offset, int length, String alias)
SubString(String fieldName, int offset, int length)
SubString(String fieldName, int offset, int length, String alias)

Method Summary

Modifier and Type	Method and Description
SubString	clone()
protected SubString	clone(FieldExpression e) Create a new instance of this FieldExpression, with a different argument.
int	getLength() Get the max length of the substring.
int	getOffset() Get the offset for the start of the substring.
SchemaField.Type	getType(Schema schema) Resolve the type for this expression.
int	hashCode()
protected boolean	parametersEqual(FieldExpression other) Returns true if other's parameters are the same as this.
void	setLength(int value) Set the max length of the substring.
void	setOffset(int value) Set the offset for the start of the substring.
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

equalsIgnoreAlias, getExpression, getFieldName, hasChildren, isConstant, 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

Constructor Detail

SubString

public SubString(String fieldName,
                 int offset,
                 int length)

SubString

public SubString(String fieldName,
                 int offset,
                 int length,
                 String alias)

SubString

public SubString(FieldExpression expression,
                 int offset,
                 int length)

SubString

public SubString(FieldExpression expression,
                 int offset,
                 int length,
                 String alias)

Method Detail

getType

public SchemaField.Type getType(Schema schema)

Resolve the type for this expression.

Specified by:

getType in class FieldExpression

getOffset

public int getOffset()

Get the offset for the start of the substring.

If offset is negative, the actual start offset will be computed on a per value basis to be valueLength + offset. For example, setting the offset to -4 and the length to 4 will extract the last for characters of each value.

setOffset

public void setOffset(int value)

Set the offset for the start of the substring.

getLength

public int getLength()

Get the max length of the substring.

setLength

public void setLength(int value)

Set the max length of the substring.

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 SubString clone()

Overrides:

clone in class UnaryFieldExpression

clone

protected SubString clone(FieldExpression e)

Create a new instance of this FieldExpression, with a different argument.

Overrides:

clone in class UnaryFieldExpression