Package org.talend.sdk.component.api.record

Interface Record

public interface Record

Nested Class Summary

Nested Classes

Modifier and Type	Interface	Description
static interface	Record.Builder	Allows to create a record with a fluent API.

Field Summary

Fields

Modifier and Type	Field	Description
static final String	RECORD_ERROR_SUPPORT
static final String	RECORD_NULLABLE_CHECK

Method Summary

Modifier and Type	Method	Description
<T> T	get(Class<T> expectedType, String name)	Access a record field value.
default <T> T	get(Class<T> expectedType, Schema.Entry entry)
default <T> Collection<T>	getArray(Class<T> type, String name)	See get(Class, String).
default boolean	getBoolean(String name)	See get(Class, String).
default byte[]	getBytes(String name)	See get(Class, String).
default ZonedDateTime	getDateTime(String name)	See get(Class, String).
default BigDecimal	getDecimal(String name)
default double	getDouble(String name)	See get(Class, String).
default float	getFloat(String name)	See get(Class, String).
default Instant	getInstant(String name)	See get(Class, String).
default int	getInt(String name)	See get(Class, String).
default long	getLong(String name)	See get(Class, String).
default <T> Optional<Collection<T>>	getOptionalArray(Class<T> type, String name)	See get(Class, String).
default Optional<Boolean>	getOptionalBoolean(String name)	See get(Class, String).
default Optional<byte[]>	getOptionalBytes(String name)	See get(Class, String).
default Optional<ZonedDateTime>	getOptionalDateTime(String name)	See get(Class, String).
default Optional<BigDecimal>	getOptionalDecimal(String name)	See get(Class, String).
default OptionalDouble	getOptionalDouble(String name)	See get(Class, String).
default OptionalDouble	getOptionalFloat(String name)	See get(Class, String).
default Optional<Instant>	getOptionalInstant(String name)	See get(Class, String).
default OptionalInt	getOptionalInt(String name)	See get(Class, String).
default OptionalLong	getOptionalLong(String name)	See get(Class, String).
default Optional<Record>	getOptionalRecord(String name)	See get(Class, String).
default Optional<String>	getOptionalString(String name)	See get(Class, String).
default Record	getRecord(String name)	See get(Class, String).
Schema	getSchema()
default String	getString(String name)	See get(Class, String).
default boolean	isValid()
default Record.Builder	withNewSchema(Schema schema)	Create a Builder with values of the record present in Schema.

Field Details

RECORD_ERROR_SUPPORT

static final String RECORD_ERROR_SUPPORT

See Also:

• Constant Field Values

RECORD_NULLABLE_CHECK

static final String RECORD_NULLABLE_CHECK

See Also:

• Constant Field Values

Method Details

getSchema

Schema getSchema()

Returns:

the schema of this record.

withNewSchema

default Record.Builder withNewSchema(Schema schema)

Create a Builder with values of the record present in Schema.

Parameters:

schema - new schema

Returns:

a Record.Builder

get

<T> T get(Class<T> expectedType,
 String name)

Access a record field value. IMPORTANT: it is always better to use the typed accessors and the optional flavor when the entry is nullable.

Type Parameters:

T - the type of expectedType.

Parameters:

expectedType - the expected type for the column.

name - the name of the column.

Returns:

the column value.

get

default <T> T get(Class<T> expectedType,
 Schema.Entry entry)

getString

default String getString(String name)

See get(Class, String).

Parameters:

name - entry name.

Returns:

the value of the entry in this record.

getInt

default int getInt(String name)

See get(Class, String).

Parameters:

name - entry name.

Returns:

the value of the entry in this record.

getLong

default long getLong(String name)

See get(Class, String).

Parameters:

name - entry name.

Returns:

the value of the entry in this record.

getDouble

default double getDouble(String name)

See get(Class, String).

Parameters:

name - entry name.

Returns:

the value of the entry in this record.

getFloat

default float getFloat(String name)

See get(Class, String).

Parameters:

name - entry name.

Returns:

the value of the entry in this record.

getBoolean

default boolean getBoolean(String name)

See get(Class, String).

Parameters:

name - entry name.

Returns:

the value of the entry in this record.

getBytes

default byte[] getBytes(String name)

See get(Class, String).

Parameters:

name - entry name.

Returns:

the value of the entry in this record.

getRecord

default Record getRecord(String name)

See get(Class, String).

Parameters:

name - entry name.

Returns:

the value of the entry in this record.

getArray

default <T> Collection<T> getArray(Class<T> type,
 String name)

See get(Class, String).

Type Parameters:

T - type of the collection elements.

Parameters:

type - type of the elements of the collection.

name - entry name.

Returns:

the value of the entry in this record.

getDateTime

default ZonedDateTime getDateTime(String name)

See get(Class, String).

Parameters:

name - entry name.

Returns:

the value of the entry in this record.

getInstant

default Instant getInstant(String name)

See get(Class, String).

Parameters:

name - entry name.

Returns:

the value of the entry in this record.

getDecimal

default BigDecimal getDecimal(String name)

getOptionalArray

default <T> Optional<Collection<T>> getOptionalArray(Class<T> type,
 String name)

See get(Class, String).

Type Parameters:

T - type of the collection elements.

Parameters:

type - type of the elements of the collection.

name - entry name.

Returns:

the value of the entry in this record.

getOptionalDateTime

default Optional<ZonedDateTime> getOptionalDateTime(String name)

See get(Class, String).

Parameters:

name - entry name.

Returns:

the value of the entry in this record.

getOptionalInstant

default Optional<Instant> getOptionalInstant(String name)

See get(Class, String).

Parameters:

name - entry name.

Returns:

the value of the entry in this record.

getOptionalDecimal

default Optional<BigDecimal> getOptionalDecimal(String name)

See get(Class, String).

Parameters:

name - entry name.

Returns:

the value of the entry in this record.

getOptionalString

default Optional<String> getOptionalString(String name)

See get(Class, String).

Parameters:

name - entry name.

Returns:

the value of the entry in this record.

getOptionalInt

default OptionalInt getOptionalInt(String name)

See get(Class, String).

Parameters:

name - entry name.

Returns:

the value of the entry in this record.

getOptionalLong

default OptionalLong getOptionalLong(String name)

See get(Class, String).

Parameters:

name - entry name.

Returns:

the value of the entry in this record.

getOptionalDouble

default OptionalDouble getOptionalDouble(String name)

See get(Class, String).

Parameters:

name - entry name.

Returns:

the value of the entry in this record.

getOptionalFloat

default OptionalDouble getOptionalFloat(String name)

See get(Class, String).

Parameters:

name - entry name.

Returns:

the value of the entry in this record.

getOptionalBoolean

default Optional<Boolean> getOptionalBoolean(String name)

See get(Class, String).

Parameters:

name - entry name.

Returns:

the value of the entry in this record.

getOptionalBytes

default Optional<byte[]> getOptionalBytes(String name)

See get(Class, String).

Parameters:

name - entry name.

Returns:

the value of the entry in this record.

getOptionalRecord

default Optional<Record> getOptionalRecord(String name)

See get(Class, String).

Parameters:

name - entry name.

Returns:

the value of the entry in this record.

isValid

default boolean isValid()