org.springframework.xd.tuple

Interface Tuple

All Known Implementing Classes:

DefaultTuple

public interface Tuple

Data structure that stores a fixed number of ordered key-value pairs and adds convenience methods to access values in a type-safe manner. The structure is immutable once created and values to not need to be of the same type. When accessing values, Spring's type conversion system is used to convert the value type to the requested type. The type conversion system is extensible. Tuples are created using the TupleBuilder class.

Author:

Mark Pollack

Method Summary

Methods

Modifier and Type	Method and Description
java.math.BigDecimal	getBigDecimal(int index) Read the 'BigDecimal' value at index 'index'.
java.math.BigDecimal	getBigDecimal(int index, java.math.BigDecimal defaultValue) Read the 'BigDecimal' value at index 'index'.
java.math.BigDecimal	getBigDecimal(java.lang.String name) Read the 'BigDecimal' value from column with given 'name'.
java.math.BigDecimal	getBigDecimal(java.lang.String name, java.math.BigDecimal defaultValue) Read the 'BigDecimal' value from column with given 'name'.
boolean	getBoolean(int index) Read the 'boolean' value at index 'index'.
boolean	getBoolean(int index, java.lang.String trueValue) Read the 'boolean' value at index 'index'.
boolean	getBoolean(java.lang.String name) Read the 'boolean' value from field with given 'name'.
boolean	getBoolean(java.lang.String name, java.lang.String trueValue) Read the 'boolean' value from column with given 'name'.
byte	getByte(int index) Read the 'byte' value at index 'index'.
byte	getByte(int index, byte defaultValue) Read the 'byte' value at index 'index'.
byte	getByte(java.lang.String name) Read the 'byte' value from column with given 'name'.
byte	getByte(java.lang.String name, byte defaultValue) Read the 'byte' value from column with given 'name'.
char	getChar(int index) Read the 'char' value at index 'index'.
char	getChar(java.lang.String name) Read the 'char' value from field with given 'name'.
java.util.Date	getDate(int index) Read the java.util.Date value in default format at designated column index.
java.util.Date	getDate(int index, java.util.Date defaultValue) Read the java.util.Date value in default format at designated column index using the supplied defaultValue if the field value is a zero length string or null.
java.util.Date	getDate(java.lang.String name) Read the java.util.Date value in default format at designated column with given name.
java.util.Date	getDate(java.lang.String name, java.util.Date defaultValue) Read the java.util.Date value in default format at designated column with given name.
java.util.Date	getDateWithPattern(int index, java.lang.String pattern) Read the java.util.Date value in default format at designated column index.
java.util.Date	getDateWithPattern(int index, java.lang.String pattern, java.util.Date defaultValue) Read the java.util.Date value in default format at designated column index.
java.util.Date	getDateWithPattern(java.lang.String name, java.lang.String pattern) Read the java.util.Date value in given format from column with given name.
java.util.Date	getDateWithPattern(java.lang.String name, java.lang.String pattern, java.util.Date defaultValue) Read the java.util.Date value in given format from column with given name.
double	getDouble(int index) Read the 'double' value at index 'index'.
double	getDouble(int index, double defaultValue) Read the 'double' value at index 'index'.
double	getDouble(java.lang.String name) Read the 'double' value from column with given 'name'.
double	getDouble(java.lang.String name, double defaultValue) Read the 'double' value from column with given 'name'.
int	getFieldCount() Return the number of fields in this tuple.
java.util.List<java.lang.String>	getFieldNames() Return the fields names that can reference elements by name in this tuple
java.util.List<java.lang.Class>	getFieldTypes() Return the Java types of the fields in this tuple.
float	getFloat(int index) Read the 'float' value at index 'index'.
float	getFloat(int index, float defaultValue) Read the 'float' value at index 'index'.
float	getFloat(java.lang.String name) Read the 'float' value from column with given 'name'.
float	getFloat(java.lang.String name, float defaultValue) Read the 'float' value from column with given 'name'.
java.util.UUID	getId() Get the unique Id of this tuple, not included in comparisons for equality.
int	getInt(int index) Read the 'int' value at index 'index'.
int	getInt(int index, int defaultValue) Read the 'int' value at index 'index'.
int	getInt(java.lang.String name) Read the 'int' value from column with given 'name'.
int	getInt(java.lang.String name, int defaultValue) Read the 'int' value from column with given 'name'.
long	getLong(int index) Read the 'long' value at index 'index'.
long	getLong(int index, long defaultValue) Read the 'long' value at index 'index'.
long	getLong(java.lang.String name) Read the 'int' value from column with given 'name'.
long	getLong(java.lang.String name, long defaultValue) Read the 'long' value from column with given 'name'.
java.lang.String	getRawString(int index) Read the String value at index 'index' including trailing whitespace (don't trim).
java.lang.String	getRawString(java.lang.String name) Read the String value from column with given 'name' including trailing whitespace (don't trim).
short	getShort(int index) Read the 'short' value at index 'index'.
short	getShort(int index, short defaultValue) Read the 'short' value at index 'index'.
short	getShort(java.lang.String name) Read the 'short' value from column with given 'name'.
short	getShort(java.lang.String name, short defaultValue) Read the 'short' value from column with given 'name'.
java.lang.String	getString(int index) Read the String value given the index position
java.lang.String	getString(java.lang.String name) Read the String value given the field 'name'.
java.lang.Long	getTimestamp() Get the creation timestamp of this tuple, not included in comparisons for equality
Tuple	getTuple(int index) Read the Tuple value given the index position
Tuple	getTuple(java.lang.String name) Read the Tuple value given the field 'name'.
java.lang.Object	getValue(int index) Return the value of the field given the index position
<T> T	getValue(int index, java.lang.Class<T> valueClass) Return the value of the field given the index position
java.lang.Object	getValue(java.lang.String name) Return the value of the field given the name
<T> T	getValue(java.lang.String name, java.lang.Class<T> valueClass) Return the value of the field given the name
java.util.List<java.lang.Object>	getValues() Return the values for all the fields in this tuple
boolean	hasFieldName(java.lang.String name) Return true if the tuple contains a field of the given name
Tuple	select(java.lang.String expression) Use SpEL expression to return a subset of the tuple that matches the expression
int	size() Return the number of elements in this tuple.

Method Detail

size

int size()

Return the number of elements in this tuple.

Returns:

number of elements

getFieldNames

java.util.List<java.lang.String> getFieldNames()

Return the fields names that can reference elements by name in this tuple

Returns:

list of field names

getValues

java.util.List<java.lang.Object> getValues()

Return the values for all the fields in this tuple

Returns:

list of values.

hasFieldName

boolean hasFieldName(java.lang.String name)

Return true if the tuple contains a field of the given name

Parameters:

name - the name of the field

Returns:

true if present, otherwise false

getFieldTypes

java.util.List<java.lang.Class> getFieldTypes()

Return the Java types of the fields in this tuple.

Returns:

the Java types of the fields in this tuple.

getFieldCount

int getFieldCount()

Return the number of fields in this tuple.

Returns:

the number of fields in this tuple.

getValue

java.lang.Object getValue(java.lang.String name)

Return the value of the field given the name

Parameters:

name - the name of the field

Returns:

value of the field

Throws:

java.lang.IllegalArgumentException - if the name is not present

getValue

java.lang.Object getValue(int index)

Return the value of the field given the index position

Parameters:

index - position in the tuple

Returns:

value of the field

Throws:

java.lang.IndexOutOfBoundsException - if the index position is out of bounds.

getValue

<T> T getValue(java.lang.String name,
             java.lang.Class<T> valueClass)

Return the value of the field given the name

Parameters:

name - the field name

valueClass - Class to coerce the value into.

Returns:

value of the field

getValue

<T> T getValue(int index,
             java.lang.Class<T> valueClass)

Return the value of the field given the index position

Parameters:

index - position in the tuple

valueClass - Class to coerce the value into

Returns:

value of the field

getString

java.lang.String getString(java.lang.String name)

Read the String value given the field 'name'.

Parameters:

name - the field name.

Returns:

value of the field

getString

java.lang.String getString(int index)

Read the String value given the index position

Parameters:

index - position in the tuple

Returns:

value of the field

getTuple

Tuple getTuple(java.lang.String name)

Read the Tuple value given the field 'name'.

Parameters:

name - the field name.

Returns:

value of the field

getTuple

Tuple getTuple(int index)

Read the Tuple value given the index position

Parameters:

index - position in the tuple

Returns:

value of the field

getRawString

java.lang.String getRawString(int index)

Read the String value at index 'index' including trailing whitespace (don't trim).

Parameters:

index - the field index.

Throws:

java.lang.IndexOutOfBoundsException - if the index is out of bounds.

getRawString

java.lang.String getRawString(java.lang.String name)

Read the String value from column with given 'name' including trailing whitespace (don't trim).

Parameters:

name - the field name.

getChar

char getChar(int index)

Read the 'char' value at index 'index'.

Parameters:

index - the field index.

Throws:

java.lang.IndexOutOfBoundsException - if the index is out of bounds.

getChar

char getChar(java.lang.String name)

Read the 'char' value from field with given 'name'.

Parameters:

name - the field name.

Throws:

java.lang.IllegalArgumentException - if a field with given name is not defined.

getBoolean

boolean getBoolean(int index)

Read the 'boolean' value at index 'index'.

Parameters:

index - the field index.

Throws:

java.lang.IndexOutOfBoundsException - if the index is out of bounds.

getBoolean

boolean getBoolean(java.lang.String name)

Read the 'boolean' value from field with given 'name'.

Parameters:

name - the field name.

Throws:

java.lang.IllegalArgumentException - if a field with given name is not defined.

getBoolean

boolean getBoolean(int index,
                 java.lang.String trueValue)

Read the 'boolean' value at index 'index'.

Parameters:

index - the field index.

trueValue - the value that signifies true; case-sensitive.

Throws:

java.lang.IndexOutOfBoundsException - if the index is out of bounds, or if the supplied trueValue is null.

getBoolean

boolean getBoolean(java.lang.String name,
                 java.lang.String trueValue)

Read the 'boolean' value from column with given 'name'.

Parameters:

name - the field name.

trueValue - the value that signifies true; case-sensitive.

Throws:

java.lang.IllegalArgumentException - if a column with given name is not defined, or if the supplied trueValue is null.

getByte

byte getByte(int index)

Read the 'byte' value at index 'index'.

Parameters:

index - the field index.

Throws:

java.lang.IndexOutOfBoundsException - if the index is out of bounds.

getByte

byte getByte(java.lang.String name)

Read the 'byte' value from column with given 'name'.

Parameters:

name - the field name.

getByte

byte getByte(int index,
           byte defaultValue)

Read the 'byte' value at index 'index'. using the supplied defaultValue if the field value is a zero length string or null.

Parameters:

index - the field index.

defaultValue - the default value to return if field value is not found.

Throws:

java.lang.IndexOutOfBoundsException - if the index is out of bounds.

getByte

byte getByte(java.lang.String name,
           byte defaultValue)

Read the 'byte' value from column with given 'name'. using the supplied defaultValue if the field value is a zero length string or null.

Parameters:

name - the field name.

defaultValue - the default value to return if field value is not found.

getShort

short getShort(int index)

Read the 'short' value at index 'index'.

Parameters:

index - the field index.

Throws:

java.lang.IndexOutOfBoundsException - if the index is out of bounds.

getShort

short getShort(java.lang.String name)

Read the 'short' value from column with given 'name'.

Parameters:

name - the field name.

getShort

short getShort(int index,
             short defaultValue)

Read the 'short' value at index 'index'. using the supplied defaultValue if the field value is a zero length string or null.

Parameters:

index - the field index.

defaultValue - the default value to return if field value is not found.

Throws:

java.lang.IndexOutOfBoundsException - if the index is out of bounds.

getShort

short getShort(java.lang.String name,
             short defaultValue)

Read the 'short' value from column with given 'name'. using the supplied defaultValue if the field value is a zero length string or null.

Parameters:

name - the field name.

defaultValue - the default value to return if field value is not found.

getInt

int getInt(int index)

Read the 'int' value at index 'index'.

Parameters:

index - the field index.

Throws:

java.lang.IndexOutOfBoundsException - if the index is out of bounds.

getInt

int getInt(java.lang.String name)

Read the 'int' value from column with given 'name'.

Parameters:

name - the field name.

getInt

int getInt(int index,
         int defaultValue)

Read the 'int' value at index 'index'. using the supplied defaultValue if the field value is a zero length string or null.

Parameters:

index - the field index.

defaultValue - the default value to return if field value is not found.

Throws:

java.lang.IndexOutOfBoundsException - if the index is out of bounds.

getInt

int getInt(java.lang.String name,
         int defaultValue)

Read the 'int' value from column with given 'name'. using the supplied defaultValue if the field value is a zero length string or null.

Parameters:

name - the field name.

defaultValue - the default value to return if field value is not found.

getLong

long getLong(int index)

Read the 'long' value at index 'index'.

Parameters:

index - the field index.

Throws:

java.lang.IndexOutOfBoundsException - if the index is out of bounds.

getLong

long getLong(java.lang.String name)

Read the 'int' value from column with given 'name'.

Parameters:

name - the field name.

getLong

long getLong(int index,
           long defaultValue)

Read the 'long' value at index 'index'. using the supplied defaultValue if the field value is a zero length string or null.

Parameters:

index - the field index.

defaultValue - the default value to return if field value is not found.

Throws:

java.lang.IndexOutOfBoundsException - if the index is out of bounds.

getLong

long getLong(java.lang.String name,
           long defaultValue)

Read the 'long' value from column with given 'name'. using the supplied defaultValue if the field value is a zero length string or null.

Parameters:

name - the field name.

defaultValue - the default value to return if field value is not found.

getFloat

float getFloat(int index)

Read the 'float' value at index 'index'.

Parameters:

index - the field index.

Throws:

java.lang.IndexOutOfBoundsException - if the index is out of bounds.

getFloat

float getFloat(java.lang.String name)

Read the 'float' value from column with given 'name'.

Parameters:

name - the field name.

getFloat

float getFloat(int index,
             float defaultValue)

Read the 'float' value at index 'index'. using the supplied defaultValue if the field value is a zero length string or null.

Parameters:

index - the field index.

defaultValue - the default value to return if field value is not found.

Throws:

java.lang.IndexOutOfBoundsException - if the index is out of bounds.

getFloat

float getFloat(java.lang.String name,
             float defaultValue)

Read the 'float' value from column with given 'name'. using the supplied defaultValue if the field value is a zero length string or null.

Parameters:

name - the field name.

defaultValue - the default value to return if field value is not found.

getDouble

double getDouble(int index)

Read the 'double' value at index 'index'.

Parameters:

index - the field index.

Throws:

java.lang.IndexOutOfBoundsException - if the index is out of bounds.

getDouble

double getDouble(java.lang.String name)

Read the 'double' value from column with given 'name'.

Parameters:

name - the field name.

getDouble

double getDouble(int index,
               double defaultValue)

Read the 'double' value at index 'index'. using the supplied defaultValue if the field value is a zero length string or null.

Parameters:

index - the field index.

defaultValue - the default value to return if field value is not found.

Throws:

java.lang.IndexOutOfBoundsException - if the index is out of bounds.

getDouble

double getDouble(java.lang.String name,
               double defaultValue)

Read the 'double' value from column with given 'name'. using the supplied defaultValue if the field value is a zero length string or null.

Parameters:

name - the field name.

defaultValue - the default value to return if field value is not found.

getBigDecimal

java.math.BigDecimal getBigDecimal(int index)

Read the 'BigDecimal' value at index 'index'.

Parameters:

index - the field index.

Throws:

java.lang.IndexOutOfBoundsException - if the index is out of bounds.

getBigDecimal

java.math.BigDecimal getBigDecimal(java.lang.String name)

Read the 'BigDecimal' value from column with given 'name'.

Parameters:

name - the field name.

getBigDecimal

java.math.BigDecimal getBigDecimal(int index,
                                 java.math.BigDecimal defaultValue)

Read the 'BigDecimal' value at index 'index'. using the supplied defaultValue if the field value is a zero length string or null.

Parameters:

index - the field index.

defaultValue - the default value to return if field value is not found.

Throws:

java.lang.IndexOutOfBoundsException - if the index is out of bounds.

getBigDecimal

java.math.BigDecimal getBigDecimal(java.lang.String name,
                                 java.math.BigDecimal defaultValue)

Read the 'BigDecimal' value from column with given 'name'. using the supplied defaultValue if the field value is a zero length string or null.

Parameters:

name - the field name.

defaultValue - the default value to return if field value is not found.

getDate

java.util.Date getDate(int index)

Read the java.util.Date value in default format at designated column index.

Parameters:

index - the field index.

Throws:

java.lang.IndexOutOfBoundsException - if the index is out of bounds.

org.springframework.core.convert.ConversionFailedException - if the value is not parseable

getDate

java.util.Date getDate(java.lang.String name)

Read the java.util.Date value in default format at designated column with given name.

Parameters:

name - the field name.

Throws:

java.lang.IllegalArgumentException - if a column with given name is not defined

org.springframework.core.convert.ConversionFailedException - if the value is not parseable

getDate

java.util.Date getDate(int index,
                     java.util.Date defaultValue)

Read the java.util.Date value in default format at designated column index using the supplied defaultValue if the field value is a zero length string or null.

Parameters:

index - the field index.

defaultValue - the default value to return if field value is not found.

Throws:

java.lang.IndexOutOfBoundsException - if the index is out of bounds.

org.springframework.core.convert.ConversionFailedException - if the value is not parseable

getDate

java.util.Date getDate(java.lang.String name,
                     java.util.Date defaultValue)

Read the java.util.Date value in default format at designated column with given name. using the supplied defaultValue if the field value is a zero length string or null.

Parameters:

name - the field name.

defaultValue - the default value to return if field value is not found.

Throws:

java.lang.IllegalArgumentException - if a column with given name is not defined

org.springframework.core.convert.ConversionFailedException - if the value is not parseable

getDateWithPattern

java.util.Date getDateWithPattern(int index,
                                java.lang.String pattern)

Read the java.util.Date value in default format at designated column index.

Parameters:

index - the field index.

pattern - the pattern describing the date and time format

Throws:

java.lang.IndexOutOfBoundsException - if the index is out of bounds.

java.lang.IllegalArgumentException - if the date cannot be parsed.

getDateWithPattern

java.util.Date getDateWithPattern(java.lang.String name,
                                java.lang.String pattern)

Read the java.util.Date value in given format from column with given name.

Parameters:

name - the field name.

pattern - the pattern describing the date and time format

Throws:

java.lang.IllegalArgumentException - if a column with given name is not defined or if the specified field cannot be parsed

getDateWithPattern

java.util.Date getDateWithPattern(int index,
                                java.lang.String pattern,
                                java.util.Date defaultValue)

Read the java.util.Date value in default format at designated column index. using the supplied defaultValue if the field value is a zero length string or null.

Parameters:

index - the field index.

pattern - the pattern describing the date and time format

defaultValue - the default value to return if field value is not found.

Throws:

java.lang.IndexOutOfBoundsException - if the index is out of bounds.

java.lang.IllegalArgumentException - if the date cannot be parsed.

getDateWithPattern

java.util.Date getDateWithPattern(java.lang.String name,
                                java.lang.String pattern,
                                java.util.Date defaultValue)

Read the java.util.Date value in given format from column with given name. using the supplied defaultValue if the field value is a zero length string or null.

Parameters:

name - the field name.

pattern - the pattern describing the date and time format

defaultValue - the default value to return if field value is not found.

Throws:

java.lang.IllegalArgumentException - if a column with given name is not defined or if the specified field cannot be parsed

select

Tuple select(java.lang.String expression)

Use SpEL expression to return a subset of the tuple that matches the expression

Parameters:

expression - SpEL expression to select from a Map, e.g. ?[key.startsWith('b')]

Returns:

a new Tuple with data selected from the current instance.

getId

java.util.UUID getId()

Get the unique Id of this tuple, not included in comparisons for equality.

Returns:

unique Id

getTimestamp

java.lang.Long getTimestamp()

Get the creation timestamp of this tuple, not included in comparisons for equality

Returns:

creation timestamp