org.youscope.common.table

Interface ColumnView<T extends java.io.Serializable>

Type Parameters:

T - A value type for which the columns entries are subclasses of. Example: if the getColumnDefinition().ColumnDefinition.getValueType() is Integer, T can be Integer or Number.

All Superinterfaces:

java.lang.Iterable<TableEntry<? extends T>>

public interface ColumnView<T extends java.io.Serializable>
extends java.lang.Iterable<TableEntry<? extends T>>

Represents a view on a column of a graph. Does itself not contain data, and should not be passed around (pass the graph, or a copy of the graph, instead).

Author:

Moritz Lang

Method Summary

Modifier and Type	Method and Description
TableEntry<? extends T>	get(int row) Returns the entry in the given row.
ColumnDefinition<? extends T>	getColumnDefinition() Returns the definition of this column.
java.lang.String	getColumnDescription() Returns a description of the meaning of the elements in this column.
java.lang.String	getColumnName() Returns the name of the column.
int	getNumRows() Returns the number of entries (i.e.
int	getSize() Returns the number of entries (i.e.
T	getValue(int row) Returns the value of the entry in the given row.
java.lang.Class<? extends T>	getValueType() Returns the class in which the values of this column are encoded.
boolean	isNullAllowed() Returns true if entries in the column might have null values.

Methods inherited from interface java.lang.Iterable

forEach, iterator, spliterator

Method Detail

getValueType

java.lang.Class<? extends T> getValueType()

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

Returns:

Value type.

getColumnName

java.lang.String getColumnName()

Returns the name of the column.

Returns:

Name of column.

getColumnDescription

java.lang.String getColumnDescription()

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

Returns:

description of column content.

isNullAllowed

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.

getColumnDefinition

ColumnDefinition<? extends T> getColumnDefinition()

Returns the definition of this column.

Returns:

column definition.

getSize

int getSize()

Returns the number of entries (i.e. rows) in this column. Same as getNumRows().

Returns:

number of rows.

getNumRows

int getNumRows()

Returns the number of entries (i.e. rows) in this column. Same as getSize().

Returns:

number of rows.

get

TableEntry<? extends T> get(int row)
                     throws java.lang.IndexOutOfBoundsException

Returns the entry in the given row.

Parameters:

row - The row of the entry.

Returns:

The entry at the given row.

Throws:

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

getValue

T getValue(int row)
    throws java.lang.IndexOutOfBoundsException

Returns the value of the entry in the given row.

Parameters:

row - The row of the entry.

Returns:

The value of the entry at the given row.

Throws:

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