sirius.web.data

Interface SmartRow

public interface SmartRow

A row of a dataset that supports multiple same-named columns. Values of this columns can be retrieved by

Method Summary

Modifier and Type	Method and Description
default boolean	contains(String name) Checks if a given column is present and filled in the complete dataset
<T> boolean	fillField(String name, Function<sirius.kernel.commons.Value,T> valueExtractor, Consumer<T> field, T defaultValue) Fills an object's field from the last Value of a given column
<T> boolean	fillField(String name, int n, Function<sirius.kernel.commons.Value,T> valueExtractor, Consumer<T> field, T defaultValue) Fills an object's field from the n-th Value of a given column
<T> boolean	fillFieldIfPresent(String name, Function<sirius.kernel.commons.Value,T> valueExtractor, Consumer<T> field) Fills an object's field from the last Value of a given column, but only if the column exists
<T> boolean	fillFieldIfPresent(String name, int n, Function<sirius.kernel.commons.Value,T> valueExtractor, Consumer<T> field) Fills an object's field from the n-th Value of a given column, but only if the column exists
Collection<sirius.kernel.commons.Value>	getAll() Retrieves the complete row
List<sirius.kernel.commons.Value>	getAll(String name) Retrieves all Values under a given column name
List<sirius.kernel.commons.Tuple<String,String>>	getColumnMapping() Returns tuples of the original column names and their mapped column names.
default sirius.kernel.commons.Value	getFirst(String name) Retrieves a Value from this row
sirius.kernel.commons.Value	getFirstOrDefault(String name, Object defaultValue) Retrieves a Value from this row
default sirius.kernel.commons.Value	getLast(String name) Retrieves a Value from this row
sirius.kernel.commons.Value	getLastOrDefault(String name, Object defaultValue) Retrieves a Value from this row
default sirius.kernel.commons.Value	getNth(String name, int n) Retrieves a Value from this row
sirius.kernel.commons.Value	getNthOrDefault(String name, int n, Object defaultValue) Retrieves a Value from this row
default int	size(String name) Retrieves the number of columns with the given name

Method Detail

getColumnMapping

List<sirius.kernel.commons.Tuple<String,String>> getColumnMapping()

Returns tuples of the original column names and their mapped column names.

Returns:

the original column names and their mapped column names. Contains nulls before the first row has been read!

getAll

@Nonnull
Collection<sirius.kernel.commons.Value> getAll()

Retrieves the complete row

Returns:

the complete row

getAll

@Nonnull
List<sirius.kernel.commons.Value> getAll(@Nonnull
                                                  String name)

Retrieves all Values under a given column name

Parameters:

name - of the column

Returns:

all values under the column with the given name

contains

default boolean contains(@Nonnull
                         String name)

Checks if a given column is present and filled in the complete dataset

Parameters:

name - of the column

Returns:

whether the dataset contains this column name (even if there is no value in this specific row)

size

default int size(@Nonnull
                 String name)

Retrieves the number of columns with the given name

Parameters:

name - of the column

Returns:

the number of columns with the given name

getFirst

@Nonnull
default sirius.kernel.commons.Value getFirst(@Nonnull
                                                      String name)

Retrieves a Value from this row

Parameters:

name - of the column

Returns:

the value of the first column with the given name or Value.EMPTY if no such column exists

getNth

@Nonnull
default sirius.kernel.commons.Value getNth(@Nonnull
                                                    String name,
                                                    int n)

Retrieves a Value from this row

Parameters:

name - of the column

n - the index of the column

Returns:

the value of the n-th column with the given name or Value.EMPTY if no such column exists

getLast

@Nonnull
default sirius.kernel.commons.Value getLast(@Nonnull
                                                     String name)

Retrieves a Value from this row

Parameters:

name - of the column

Returns:

the value of the last column with the given name or Value.EMPTY if no such column exists

getFirstOrDefault

@Nonnull
sirius.kernel.commons.Value getFirstOrDefault(@Nonnull
                                                       String name,
                                                       @Nullable
                                                       Object defaultValue)

Retrieves a Value from this row

Parameters:

name - the name of the column

defaultValue - returned if no column with the given name exists or the column contains an empty value

Returns:

the value of the last column with the given name or defaultValue if no such column exists

getNthOrDefault

@Nonnull
sirius.kernel.commons.Value getNthOrDefault(@Nonnull
                                                     String name,
                                                     int n,
                                                     @Nullable
                                                     Object defaultValue)

Retrieves a Value from this row

Parameters:

name - of the column

n - the index of the column

defaultValue - returned if no column with the given name exists or the column contains an empty value

Returns:

the value of the n-th column with the given name or defaultValue if no such column exists

getLastOrDefault

@Nonnull
sirius.kernel.commons.Value getLastOrDefault(@Nonnull
                                                      String name,
                                                      @Nullable
                                                      Object defaultValue)

Retrieves a Value from this row

Parameters:

name - of the column

defaultValue - returned if no column with the given name exists or the column contains an empty value

Returns:

the value of the last column with the given name or defaultValue if no such column exists

fillFieldIfPresent

<T> boolean fillFieldIfPresent(@Nonnull
                               String name,
                               @Nonnull
                               Function<sirius.kernel.commons.Value,T> valueExtractor,
                               @Nonnull
                               Consumer<T> field)

Fills an object's field from the last Value of a given column, but only if the column exists

Type Parameters:

T - type of the field to be filled

Parameters:

name - of the column

valueExtractor - casts the Value in this row to the target type of the field

field - the field to be filled (or any other Consumer)

Returns:

true if the field was filled

fillField

<T> boolean fillField(@Nonnull
                      String name,
                      @Nonnull
                      Function<sirius.kernel.commons.Value,T> valueExtractor,
                      @Nonnull
                      Consumer<T> field,
                      @Nullable
                      T defaultValue)

Fills an object's field from the last Value of a given column

Type Parameters:

T - type of the field to be filled

Parameters:

name - of the column

valueExtractor - casts the Value in this row to the target type of the field

field - the field to be filled (or any other Consumer)

defaultValue - will be used instead if the column does not exist

Returns:

true if the column exists

fillFieldIfPresent

<T> boolean fillFieldIfPresent(@Nonnull
                               String name,
                               int n,
                               @Nonnull
                               Function<sirius.kernel.commons.Value,T> valueExtractor,
                               @Nonnull
                               Consumer<T> field)

Fills an object's field from the n-th Value of a given column, but only if the column exists

Type Parameters:

T - type of the field to be filled

Parameters:

name - of the column

n - the index of the column

valueExtractor - casts the Value in this row to the target type of the field

field - the field to be filled (or any other Consumer)

Returns:

true if the field was filled

fillField

<T> boolean fillField(@Nonnull
                      String name,
                      int n,
                      @Nonnull
                      Function<sirius.kernel.commons.Value,T> valueExtractor,
                      @Nonnull
                      Consumer<T> field,
                      @Nullable
                      T defaultValue)

Fills an object's field from the n-th Value of a given column

Type Parameters:

T - type of the field to be filled

Parameters:

name - of the column

n - the index of the column

valueExtractor - casts the Value in this row to the target type of the field

field - the field to be filled (or any other Consumer)

defaultValue - will be used instead if the column does not exist

Returns:

true if the column exists