org.youscope.common.table

Class TemporaryRow

java.lang.Object

org.youscope.common.table.TemporaryRow

All Implemented Interfaces:

java.io.Serializable, java.lang.Cloneable, java.lang.Iterable<TableEntry<?>>, RowView

public class TemporaryRow
extends java.lang.Object
implements java.io.Serializable, java.lang.Cloneable, RowView

A temporary row is a row not yet added to the table. Different to normal table rows, a temporary row allows for null values for each of column. A temporary row can, thus, be used to comfortably initialize one by one the values in a table row. Afterwards, a temporary row can be added to the table, which is the moment when the checking for null values for columns not allowing null entries is performed.

Author:

Moritz Lang

See Also:

Serialized Form

Constructor Summary

Constructors

Constructor and Description
TemporaryRow(ColumnDefinition<?>... columnDefinitions) Creates a temporary row with columns in agreement with the given column definitions.

Method Summary

Modifier and Type	Method and Description
protected TemporaryRow	clone()
boolean	equals(java.lang.Object obj)
<T extends java.io.Serializable> TableEntry<T>	get(ColumnDefinition<T> columnDefinition) Returns the table entry corresponding to the given column definition.
TableEntry<?>	get(int column) Returns the entry in the given column.
<T extends java.io.Serializable> TableEntry<? extends T>	get(int column, java.lang.Class<T> valueType) Returns the entry in the given column with the given value type.
TableEntry<?>	get(java.lang.String columnName) Returns the entry with the given column name.
<T extends java.io.Serializable> TableEntry<? extends T>	get(java.lang.String columnName, java.lang.Class<T> valueType) Returns the entry in the column with the given column name, having the given value type.
ColumnDefinition<?>	getColumnDefinition(int column) Returns the definition of the column with the given index.
java.lang.String	getColumnName(int column) Returns the name of the column with the given index.
int	getNumColumns() Returns the number of entries (i.e.
int	getSize() Returns the number of entries (i.e.
<T extends java.io.Serializable> T	getValue(ColumnDefinition<T> columnDefinition) Returns the value of the table entry corresponding to the given column definition.
java.io.Serializable	getValue(int column) Returns the value of the entry in the given column.
<T extends java.io.Serializable> T	getValue(int column, java.lang.Class<T> valueType) Returns the value of the entry in the given column, having the given value type.
java.io.Serializable	getValue(java.lang.String columnName) Returns the value of the entry in the column with the given column name.
<T extends java.io.Serializable> T	getValue(java.lang.String columnName, java.lang.Class<T> valueType) Returns the value of the entry in the column with the given column name, having the given value type.
java.lang.Class<? extends java.io.Serializable>	getValueType(int column) Returns the class in which the values of the given column is encoded.
int	hashCode()
java.util.Iterator<TableEntry<?>>	iterator()

Methods inherited from class java.lang.Object

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

Methods inherited from interface java.lang.Iterable

forEach, spliterator

Constructor Detail

TemporaryRow

public TemporaryRow(ColumnDefinition<?>... columnDefinitions)
             throws java.lang.NullPointerException,
                    TableException

Creates a temporary row with columns in agreement with the given column definitions. All column values are initialized to null.

Parameters:

columnDefinitions - The definition of the columns of this row.

Throws:

java.lang.NullPointerException - Thrown if columnDefinitions are null.

TableException - Thrown if temporary table could not be constructed.

Method Detail

clone

protected TemporaryRow clone()

Overrides:

clone in class java.lang.Object

hashCode

public int hashCode()

Overrides:

hashCode in class java.lang.Object

equals

public boolean equals(java.lang.Object obj)

Overrides:

equals in class java.lang.Object

iterator

public java.util.Iterator<TableEntry<?>> iterator()

Specified by:

iterator in interface java.lang.Iterable<TableEntry<?>>

getValueType

public java.lang.Class<? extends java.io.Serializable> getValueType(int column)
                                                             throws java.lang.IndexOutOfBoundsException

Description copied from interface: RowView

Returns the class in which the values of the given column is encoded.

Specified by:

getValueType in interface RowView

Parameters:

column - The column index of the entry.

Returns:

Value type.

Throws:

java.lang.IndexOutOfBoundsException - Thrown if column index is invalid.

getColumnName

public java.lang.String getColumnName(int column)
                               throws java.lang.IndexOutOfBoundsException

Description copied from interface: RowView

Returns the name of the column with the given index.

Specified by:

getColumnName in interface RowView

Parameters:

column - The column index of the entry.

Returns:

Name of column.

Throws:

java.lang.IndexOutOfBoundsException - Thrown if column index is invalid.

getColumnDefinition

public ColumnDefinition<?> getColumnDefinition(int column)
                                        throws java.lang.IndexOutOfBoundsException

Description copied from interface: RowView

Returns the definition of the column with the given index.

Specified by:

getColumnDefinition in interface RowView

Parameters:

column - The column index of the entry.

Returns:

column definition.

Throws:

java.lang.IndexOutOfBoundsException - Thrown if column index is invalid.

getSize

public int getSize()

Description copied from interface: RowView

Returns the number of entries (i.e. columns) in this row. Same as RowView.getNumColumns().

Specified by:

getSize in interface RowView

Returns:

number of columns.

getNumColumns

public int getNumColumns()

Description copied from interface: RowView

Returns the number of entries (i.e. columns) in this row. Same as RowView.getSize().

Specified by:

getNumColumns in interface RowView

Returns:

number of columns.

get

public TableEntry<?> get(int column)
                  throws java.lang.IndexOutOfBoundsException

Description copied from interface: RowView

Returns the entry in the given column.

Specified by:

get in interface RowView

Parameters:

column - The column of the entry.

Returns:

The entry at the given column.

Throws:

java.lang.IndexOutOfBoundsException - Thrown if column index is invalid.

get

public <T extends java.io.Serializable> TableEntry<? extends T> get(int column,
                                                                    java.lang.Class<T> valueType)
                                                             throws java.lang.IndexOutOfBoundsException,
                                                                    TableException

Description copied from interface: RowView

Returns the entry in the given column with the given value type.

Specified by:

get in interface RowView

Parameters:

column - The column of the entry.

valueType - The value type of the entry. Must be a super-class of the actual value type.

Returns:

The entry at the given column.

Throws:

java.lang.IndexOutOfBoundsException - Thrown if column index is invalid.

TableException - Thrown if entry type is incompatible.

get

public TableEntry<?> get(java.lang.String columnName)
                  throws TableException

Description copied from interface: RowView

Returns the entry with the given column name.

Specified by:

get in interface RowView

Parameters:

columnName - The column name of the entry.

Returns:

The entry at the column with the given column name.

Throws:

TableException - Thrown if column with the given name does not exist.

get

public <T extends java.io.Serializable> TableEntry<? extends T> get(java.lang.String columnName,
                                                                    java.lang.Class<T> valueType)
                                                             throws TableException

Description copied from interface: RowView

Returns the entry in the column with the given column name, having the given value type.

Specified by:

get in interface RowView

Parameters:

columnName - The column name of the entry.

valueType - The value type of the entry. Must be a super-class of the actual value type.

Returns:

The entry at the column with the given column name.

Throws:

TableException - Thrown if entry type is incompatible, or column with the given name does not exist.

getValue

public java.io.Serializable getValue(int column)
                              throws java.lang.IndexOutOfBoundsException

Description copied from interface: RowView

Returns the value of the entry in the given column.

Specified by:

getValue in interface RowView

Parameters:

column - The column of the entry.

Returns:

The value of the entry at the given column.

Throws:

java.lang.IndexOutOfBoundsException - Thrown if column index is invalid.

getValue

public java.io.Serializable getValue(java.lang.String columnName)
                              throws TableException

Description copied from interface: RowView

Returns the value of the entry in the column with the given column name.

Specified by:

getValue in interface RowView

Parameters:

columnName - The column name of the entry.

Returns:

The value of the entry at the column with the given column name.

Throws:

TableException - Thrown if column with the given name does not exist.

getValue

public <T extends java.io.Serializable> T getValue(int column,
                                                   java.lang.Class<T> valueType)
                                            throws java.lang.IndexOutOfBoundsException,
                                                   TableException

Description copied from interface: RowView

Returns the value of the entry in the given column, having the given value type.

Specified by:

getValue in interface RowView

Parameters:

column - The column of the entry.

valueType - The value type of the entry. Must be a super-class of the actual value type.

Returns:

The value of the entry at the given column.

Throws:

java.lang.IndexOutOfBoundsException - Thrown if column index is invalid.

TableException - Thrown if entry type is not of the given valueType.

getValue

public <T extends java.io.Serializable> T getValue(java.lang.String columnName,
                                                   java.lang.Class<T> valueType)
                                            throws TableException

Description copied from interface: RowView

Returns the value of the entry in the column with the given column name, having the given value type.

Specified by:

getValue in interface RowView

Parameters:

columnName - The column name of the entry.

valueType - The value type of the entry. Must be a super-class of the actual value type.

Returns:

The value of the entry at the column with the given column name.

Throws:

TableException - Thrown if entry type is not of the given valueType, or if a column with the given name does not exist.

get

public <T extends java.io.Serializable> TableEntry<T> get(ColumnDefinition<T> columnDefinition)
                                                   throws TableException,
                                                          java.lang.NullPointerException

Description copied from interface: RowView

Returns the table entry corresponding to the given column definition.

Specified by:

get in interface RowView

Parameters:

columnDefinition - the definition of the column to return the entry of.

Returns:

The entry corresponding to the column definition.

Throws:

TableException - thrown if there is no entry corresponding to the definition, or if entry has different value type.

java.lang.NullPointerException - thrown if columnDefinition is null.

getValue

public <T extends java.io.Serializable> T getValue(ColumnDefinition<T> columnDefinition)
                                            throws TableException,
                                                   java.lang.NullPointerException

Description copied from interface: RowView

Returns the value of the table entry corresponding to the given column definition.

Specified by:

getValue in interface RowView

Parameters:

columnDefinition - the definition of the column to return the value of the entry of.

Returns:

The value of the entry corresponding to the column definition.

Throws:

TableException - thrown if there is no entry corresponding to the definition, or if entry has different value type.

java.lang.NullPointerException - thrown if columnDefinition is null.