org.youscope.common.table

Class ColumnDefinition<T extends java.io.Serializable>

java.lang.Object

org.youscope.common.table.ColumnDefinition<T>

Type Parameters:

T - type of column entries.

All Implemented Interfaces:

java.io.Serializable

public final class ColumnDefinition<T extends java.io.Serializable>
extends java.lang.Object
implements java.io.Serializable

Definition of a table column. This definition is immutable. A table column definition is composed of a column name, and a value type, i.e. the type (class) column entries must implement.

Author:

Moritz Lang

See Also:

Serialized Form

Constructor Summary

Constructors

Constructor and Description
ColumnDefinition(java.lang.String columnName, java.lang.String columnDescription, java.lang.Class<T> valueType, boolean nullAllowed) Creates a new Column definition with the given column name and value type.

Method Summary

Modifier and Type	Method and Description
static ColumnDefinition<java.lang.Boolean>	createBooleanColumnDefinition(java.lang.String columnName, java.lang.String columnDescription, boolean nullAllowed) Creates a new Column definition for Boolean value types.
static <T extends java.io.Serializable> ColumnDefinition<T>	createColumnDefinition(java.lang.String columnName, java.lang.String columnDescription, java.lang.Class<T> valueType, boolean nullAllowed) Creates a new Column definition with the given column name and value type.
static ColumnDefinition<java.lang.Double>	createDoubleColumnDefinition(java.lang.String columnName, java.lang.String columnDescription, boolean nullAllowed) Creates a new Column definition for Double value types.
static ColumnDefinition<java.lang.Float>	createFloatColumnDefinition(java.lang.String columnName, java.lang.String columnDescription, boolean nullAllowed) Creates a new Column definition for Float value types.
static ColumnDefinition<java.lang.Integer>	createIntegerColumnDefinition(java.lang.String columnName, java.lang.String columnDescription, boolean nullAllowed) Creates a new Column definition for Integer value types.
static ColumnDefinition<java.lang.Long>	createLongColumnDefinition(java.lang.String columnName, java.lang.String columnDescription, boolean nullAllowed) Creates a new Column definition for Long value types.
static ColumnDefinition<java.lang.String>	createStringColumnDefinition(java.lang.String columnName, java.lang.String columnDescription, boolean nullAllowed) Creates a new Column definition for String value types.
boolean	equals(java.lang.Object obj)
java.lang.String	getColumnDescription() Returns a description of the meaning of the elements in this column.
java.lang.String	getColumnName() Returns the name (header) of the column.
java.lang.Class<T>	getValueType() Returns the class in which the values of this column are encoded.
int	hashCode()
boolean	isNullAllowed() Returns true if entries in the column might have null values.
java.lang.String	toString()

Methods inherited from class java.lang.Object

clone, finalize, getClass, notify, notifyAll, wait, wait, wait

Constructor Detail

ColumnDefinition

public ColumnDefinition(java.lang.String columnName,
                        java.lang.String columnDescription,
                        java.lang.Class<T> valueType,
                        boolean nullAllowed)
                 throws TableException,
                        java.lang.NullPointerException

Creates a new Column definition with the given column name and value type. Currently, YouScope only supports a limited set of value types for tables. Thus, this function throws a TableException if given value type is currently not supported by YouScope. See TableHelper for supported column types. See also createDoubleColumnDefinition(String, String, boolean), createIntegerColumnDefinition(String, String, boolean), createStringColumnDefinition(String, String, boolean), createBooleanColumnDefinition(String, String, boolean), createFloatColumnDefinition(String, String, boolean), createLongColumnDefinition(String, String, boolean) to create column definitions for value types by default supported by YouScope. Therefore, these functions do not throw TableExceptions.

Parameters:

columnName - Name (header) of this column. Should be a single and short line.

columnDescription - Description of the meaning of the elements in this column. Might contain multiple lines (separated by line breaks).

valueType - Type of entries in the column.

nullAllowed - True if the values of entries in this column might be null, false if null is forbidden.

Throws:

TableException - Thrown if value type is currently not supported by YouScope.

java.lang.NullPointerException - Thrown if either columnName, columnDescription or valueType is null.

Method Detail

getValueType

public java.lang.Class<T> getValueType()

Returns the class in which the values of this column are encoded.

Returns:

Value type.

createColumnDefinition

public static <T extends java.io.Serializable> ColumnDefinition<T> createColumnDefinition(java.lang.String columnName,
                                                                                          java.lang.String columnDescription,
                                                                                          java.lang.Class<T> valueType,
                                                                                          boolean nullAllowed)
                                                                                   throws TableException,
                                                                                          java.lang.NullPointerException

Creates a new Column definition with the given column name and value type. Currently, YouScope only supports a limited set of value types for tables. Thus, this function throws a TableException if given value type is currently not supported by YouScope. See TableHelper for supported column types. See also createDoubleColumnDefinition(String, String, boolean), createIntegerColumnDefinition(String, String, boolean) and createStringColumnDefinition(String, String, boolean) to create column definitions for value types by default supported by YouScope Therefore, these functions do not throw TableExceptions.

Parameters:

columnName - Name (header) of this column. Should be a single and short line.

columnDescription - Description of the meaning of the elements in this column. Might contain multiple lines (separated by line breaks).

valueType - Type of entries in the column.

nullAllowed - True if the values of entries in this column might be null, false if null is forbidden.

Returns:

newly created column definition.

Throws:

TableException - Thrown if value type is currently not supported by YouScope.

java.lang.NullPointerException - Thrown if either columnName, columnDescription or valueType is null.

createStringColumnDefinition

public static ColumnDefinition<java.lang.String> createStringColumnDefinition(java.lang.String columnName,
                                                                              java.lang.String columnDescription,
                                                                              boolean nullAllowed)
                                                                       throws java.lang.NullPointerException

Creates a new Column definition for String value types.

Parameters:

columnName - Name (header) of this column. Should be a single and short line.

columnDescription - Description of the meaning of the elements in this column. Might contain multiple lines (separated by line breaks).

nullAllowed - True if the values of entries in this column might be null, false if null is forbidden.

Returns:

newly created column definition.

Throws:

java.lang.NullPointerException - Thrown if either columnName, columnDescription or valueType is null.

createIntegerColumnDefinition

public static ColumnDefinition<java.lang.Integer> createIntegerColumnDefinition(java.lang.String columnName,
                                                                                java.lang.String columnDescription,
                                                                                boolean nullAllowed)
                                                                         throws java.lang.NullPointerException

Creates a new Column definition for Integer value types.

Parameters:

columnName - Name (header) of this column. Should be a single and short line.

columnDescription - Description of the meaning of the elements in this column. Might contain multiple lines (separated by line breaks).

nullAllowed - True if the values of entries in this column might be null, false if null is forbidden.

Returns:

newly created column definition.

Throws:

java.lang.NullPointerException - Thrown if either columnName, columnDescription or valueType is null.

createDoubleColumnDefinition

public static ColumnDefinition<java.lang.Double> createDoubleColumnDefinition(java.lang.String columnName,
                                                                              java.lang.String columnDescription,
                                                                              boolean nullAllowed)
                                                                       throws java.lang.NullPointerException

Creates a new Column definition for Double value types.

Parameters:

columnName - Name (header) of this column. Should be a single and short line.

columnDescription - Description of the meaning of the elements in this column. Might contain multiple lines (separated by line breaks).

nullAllowed - True if the values of entries in this column might be null, false if null is forbidden.

Returns:

newly created column definition.

Throws:

java.lang.NullPointerException - Thrown if either columnName, columnDescription or valueType is null.

createFloatColumnDefinition

public static ColumnDefinition<java.lang.Float> createFloatColumnDefinition(java.lang.String columnName,
                                                                            java.lang.String columnDescription,
                                                                            boolean nullAllowed)
                                                                     throws java.lang.NullPointerException

Creates a new Column definition for Float value types.

Parameters:

columnName - Name (header) of this column. Should be a single and short line.

columnDescription - Description of the meaning of the elements in this column. Might contain multiple lines (separated by line breaks).

nullAllowed - True if the values of entries in this column might be null, false if null is forbidden.

Returns:

newly created column definition.

Throws:

java.lang.NullPointerException - Thrown if either columnName, columnDescription or valueType is null.

createLongColumnDefinition

public static ColumnDefinition<java.lang.Long> createLongColumnDefinition(java.lang.String columnName,
                                                                          java.lang.String columnDescription,
                                                                          boolean nullAllowed)
                                                                   throws java.lang.NullPointerException

Creates a new Column definition for Long value types.

Parameters:

columnName - Name (header) of this column. Should be a single and short line.

columnDescription - Description of the meaning of the elements in this column. Might contain multiple lines (separated by line breaks).

nullAllowed - True if the values of entries in this column might be null, false if null is forbidden.

Returns:

newly created column definition.

Throws:

java.lang.NullPointerException - Thrown if either columnName, columnDescription or valueType is null.

createBooleanColumnDefinition

public static ColumnDefinition<java.lang.Boolean> createBooleanColumnDefinition(java.lang.String columnName,
                                                                                java.lang.String columnDescription,
                                                                                boolean nullAllowed)
                                                                         throws java.lang.NullPointerException

Creates a new Column definition for Boolean value types.

Parameters:

columnName - Name (header) of this column. Should be a single and short line.

columnDescription - Description of the meaning of the elements in this column. Might contain multiple lines (separated by line breaks).

nullAllowed - True if the values of entries in this column might be null, false if null is forbidden.

Returns:

newly created column definition.

Throws:

java.lang.NullPointerException - Thrown if either columnName, columnDescription or valueType is null.

getColumnName

public java.lang.String getColumnName()

Returns the name (header) of the column.

Returns:

Name of column.

getColumnDescription

public java.lang.String getColumnDescription()

Returns a description of the meaning of the elements in this column.

Returns:

description of column content.

isNullAllowed

public boolean isNullAllowed()

Returns true if entries in the column might have null values. False otherwise.

Returns:

true if column entries's values might be null.

toString

public java.lang.String toString()

Overrides:

toString 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