Class FormattedColumn<T>

java.lang.Object

org.refcodes.textual.ColumnWidthMetrics

org.refcodes.textual.ColumnFormatMetrics

org.refcodes.textual.ColumnSetupMetrics

org.refcodes.tabular.FormattedColumn<T>

Type Parameters:

T - The type managed by the FormattedColumn.

All Implemented Interfaces:

VisibleAccessor, VisibleAccessor.VisibleBuilder<ColumnSetupMetrics>, VisibleAccessor.VisibleMutator, VisibleAccessor.VisibleProperty, ColumnWidthAccessor, ColumnWidthAccessor.ColumnWidthBuilder<ColumnWidthMetrics>, ColumnWidthAccessor.ColumnWidthMutator, ColumnWidthAccessor.ColumnWidthProperty, KeyAccessor<String>, NameAccessor, NameAccessor.NameBuilder<ColumnSetupMetrics>, NameAccessor.NameMutator, NameAccessor.NameProperty, TypeAccessor<T>, Column<T>, HorizAlignTextModeAccessor.HorizAlignTextModeBuilder<ColumnFormatMetrics>, HorizAlignTextModeAccessor.HorizAlignTextModeMutator, MoreTextModeAccessor.MoreTextModeBuilder<ColumnFormatMetrics>, MoreTextModeAccessor.MoreTextModeMutator, SplitTextModeAccessor.SplitTextModeBuilder<ColumnFormatMetrics>, SplitTextModeAccessor.SplitTextModeMutator, TextFormatModeAccessor.TextFormatModeBuilder<ColumnFormatMetrics>, TextFormatModeAccessor.TextFormatModeMutator

public class FormattedColumn<T>
extends ColumnSetupMetrics
implements Column<T>

The FormattedColumn class enriches a Column with rendering metrics (as of the ColumnSetupMetrics) mostly for text-based output such as for generating output for a terminal / console.

Nested Class Summary

Nested classes/interfaces inherited from interface ColumnWidthAccessor

ColumnWidthAccessor.ColumnWidthBuilder<B>, ColumnWidthAccessor.ColumnWidthMutator, ColumnWidthAccessor.ColumnWidthProperty

Nested classes/interfaces inherited from interface KeyAccessor

KeyAccessor.KeyBuilder<K,B>, KeyAccessor.KeyMutator<K>, KeyAccessor.KeyProperty<K>

Nested classes/interfaces inherited from interface NameAccessor

NameAccessor.NameBuilder<B>, NameAccessor.NameMutator, NameAccessor.NameProperty

Nested classes/interfaces inherited from interface TypeAccessor

TypeAccessor.TypeBuilder<T,B>, TypeAccessor.TypeMutator<T>, TypeAccessor.TypeProperty<T>

Nested classes/interfaces inherited from interface VisibleAccessor

VisibleAccessor.VisibleBuilder<B>, VisibleAccessor.VisibleMutator, VisibleAccessor.VisibleProperty

Constructor Summary

Constructors

Modifier	Constructor	Description
protected	FormattedColumn(String aKey, Class<T> aType)	Instantiates a new formatted column decorator.
	FormattedColumn(String aKey, Class<T> aType, ColumnSetupMetrics aColumnSetupMetrics)	Wrapper for the provided ColumnSetupMetrics decorating it with additional Column functionality.
	FormattedColumn(Column<T> aColumn)	Wrapper for the provided Column decorating it with additional ColumnSetupMetrics functionality.
	FormattedColumn(Column<T> aColumn, ColumnSetupMetrics aColumnSetupMetrics)	Wrapper for the provided Column and the provided ColumnSetupMetrics decorating it with each other's additional functionality.

Method Summary

Modifier and Type	Method	Description
boolean	contains(Record<?> aRecord)	Tests whether the Record contains a value identified by the Column instance's key and where the value's type is assignable to the Column instance's type.
void	fromColumnFormatMetrics(ColumnFormatMetrics aColumnFormatMetrics)
void	fromColumnSetupMetrics(ColumnSetupMetrics aColumnSetupMetrics)
void	fromColumnWidthMetrics(ColumnWidthMetrics aColumnWidthMetrics)
T	fromStorageString(String aStringValue)	A Column implementation can provide its own text exchange format for the given objects.
T	fromStorageStrings(String[] aStringArray)	A Column implementation can provide its own text exchange format for the given objects.
T	get(Record<?> aRecord)	Retrieves a type correct value from the Record identified by the Column instance's key.
int	getColumnWidth()
ColumnWidthType	getColumnWidthType()
String	getHeaderEscapeCode()
EscapeCodeFactory	getHeaderEscapeCodeFactory()
HorizAlignTextMode	getHeaderHorizAlignTextMode()
MoreTextMode	getHeaderMoreTextMode()
SplitTextMode	getHeaderSplitTextMode()
TextFormatMode	getHeaderTextFormatMode()
String	getKey()
String	getName()
String	getRowEscapeCode()
EscapeCodeFactory	getRowEscapeCodeFactory()
HorizAlignTextMode	getRowHorizAlignTextMode()
MoreTextMode	getRowMoreTextMode()
SplitTextMode	getRowSplitTextMode()
TextFormatMode	getRowTextFormatMode()
Class<T>	getType()
void	hide()
boolean	isVisible()
T	remove(Record<?> aRecord)	Removes an entry (key and value pair) from the provided Record matching the key and the type of the Column.
void	setColumnWidth(int aColumnWidth)
void	setColumnWidthType(ColumnWidthType aColumnWidthType)
void	setEscapeCode(String aEscapeCode)
void	setEscapeCodeFactory(EscapeCodeFactory aEscapeCodeFactory)
void	setHeaderEscapeCode(String aEscapeCode)
void	setHeaderEscapeCodeFactory(EscapeCodeFactory aEscapeCodeFactory)
void	setHeaderHorizAlignTextMode(HorizAlignTextMode aHorizAlignTextMode)
void	setHeaderMoreTextMode(MoreTextMode aMoreTextMode)
void	setHeaderSplitTextMode(SplitTextMode aSplitTextMode)
void	setHeaderTextFormatMode(TextFormatMode aTextFormatMode)
void	setHorizAlignTextMode(HorizAlignTextMode aHorizAlignTextMode)
void	setMoreTextMode(MoreTextMode aMoreTextMode)
void	setName(String aName)
void	setRowEscapeCode(String aEscapeCode)
void	setRowEscapeCodeFactory(EscapeCodeFactory aEscapeCodeFactory)
void	setRowHorizAlignTextMode(HorizAlignTextMode aHorizAlignTextMode)
void	setRowMoreTextMode(MoreTextMode aMoreTextMode)
void	setRowSplitTextMode(SplitTextMode aSplitTextMode)
void	setRowTextFormatMode(TextFormatMode aTextFormatMode)
void	setSplitTextMode(SplitTextMode aSplitTextMode)
void	setTextFormatMode(TextFormatMode aTextFormatMode)
void	setVisible(boolean isVisible)
void	show()
String	toHeaderEscapeCode(Object aIdentifier)
String	toPrintable(T aValue)	A Column implementation can provide its own printable format of the given objects; for example a human readable text representation of the value (or in very https://www.metacodes.proized cases even enriched with ANSI escape codes).
String	toRowEscapeCode(Object aIdentifier)
String	toStorageString(T aValue)	A Column implementation can provide its own text exchange format for the given objects.
String[]	toStorageStrings(T aValue)	A Column implementation can provide its own text exchange format for the given objects.
ColumnSetupMetrics	withColumnWidth(int aColumnWidth)
ColumnSetupMetrics	withColumnWidthType(ColumnWidthType aColumnWidthType)
ColumnSetupMetrics	withEscapeCode(String aEscapeCode)
ColumnSetupMetrics	withEscapeCodeFactory(EscapeCodeFactory aEscapeCodeFactory)
ColumnSetupMetrics	withHeaderEscapeCode(String aEscapeCode)
ColumnSetupMetrics	withHeaderEscapeCodeFactory(EscapeCodeFactory aEscapeCodeFactory)
ColumnSetupMetrics	withHeaderHorizAlignTextMode(HorizAlignTextMode aHorizAlignTextMode)
ColumnSetupMetrics	withHeaderMoreTextMode(MoreTextMode aMoreTextMode)
ColumnSetupMetrics	withHeaderSplitTextMode(SplitTextMode aSplitTextMode)
ColumnSetupMetrics	withHeaderTextFormatMode(TextFormatMode aTextFormatMode)
ColumnSetupMetrics	withHide()
ColumnSetupMetrics	withHorizAlignTextMode(HorizAlignTextMode aHorizAlignTextMode)
ColumnSetupMetrics	withMoreTextMode(MoreTextMode aMoreTextMode)
ColumnSetupMetrics	withName(String aName)
ColumnSetupMetrics	withRowEscapeCode(String aEscapeCode)
ColumnSetupMetrics	withRowEscapeCodeFactory(EscapeCodeFactory aEscapeCodeFactory)
ColumnSetupMetrics	withRowHorizAlignTextMode(HorizAlignTextMode aHorizAlignTextMode)
ColumnSetupMetrics	withRowMoreTextMode(MoreTextMode aMoreTextMode)
ColumnSetupMetrics	withRowSplitTextMode(SplitTextMode aSplitTextMode)
ColumnSetupMetrics	withRowTextFormatMode(TextFormatMode aTextFormatMode)
ColumnSetupMetrics	withShow()
ColumnSetupMetrics	withSplitTextMode(SplitTextMode aSplitTextMode)
ColumnSetupMetrics	withTextFormatMode(TextFormatMode aTextFormatMode)
ColumnSetupMetrics	withVisible(boolean isVisible)

Methods inherited from class ColumnWidthMetrics

toString

Methods inherited from class Object

clone, equals, finalize, getClass, hashCode, notify, notifyAll, wait, wait, wait

Methods inherited from interface Column

getValue, toStorageString_

Methods inherited from interface ColumnWidthAccessor.ColumnWidthProperty

letColumnWidth

Methods inherited from interface NameAccessor.NameProperty

letName

Methods inherited from interface VisibleAccessor

isHidden

Methods inherited from interface VisibleAccessor.VisibleProperty

letVisible

Constructor Details

FormattedColumn

protected FormattedColumn(String aKey,
 Class<T> aType)

Instantiates a new formatted column decorator.

Parameters:

aKey - the key

aType - the type

FormattedColumn

public FormattedColumn(Column<T> aColumn)

Wrapper for the provided Column decorating it with additional ColumnSetupMetrics functionality.

Parameters:

aColumn - The Column to be decorated.

FormattedColumn

public FormattedColumn(String aKey,
 Class<T> aType,
 ColumnSetupMetrics aColumnSetupMetrics)

Wrapper for the provided ColumnSetupMetrics decorating it with additional Column functionality.

Parameters:

aKey - The key for the Column.

aType - The type to be used.

aColumnSetupMetrics - The ColumnSetupMetrics to be decorated.

FormattedColumn

public FormattedColumn(Column<T> aColumn,
 ColumnSetupMetrics aColumnSetupMetrics)

Wrapper for the provided Column and the provided ColumnSetupMetrics decorating it with each other's additional functionality.

Parameters:

aColumn - The Column to be decorated.

aColumnSetupMetrics - The ColumnSetupMetrics to be decorated.

Method Details

getName

public String getName()

Specified by:

getName in interface NameAccessor

Overrides:

getName in class ColumnSetupMetrics

isVisible

public boolean isVisible()

Specified by:

isVisible in interface VisibleAccessor

Overrides:

isVisible in class ColumnSetupMetrics

getColumnWidth

public int getColumnWidth()

Specified by:

getColumnWidth in interface ColumnWidthAccessor

Overrides:

getColumnWidth in class ColumnWidthMetrics

withVisible

public ColumnSetupMetrics withVisible(boolean isVisible)

Specified by:

withVisible in interface VisibleAccessor.VisibleBuilder<T>

Overrides:

withVisible in class ColumnSetupMetrics

setName

public void setName(String aName)

Specified by:

setName in interface NameAccessor.NameMutator

Overrides:

setName in class ColumnSetupMetrics

setVisible

public void setVisible(boolean isVisible)

Specified by:

setVisible in interface VisibleAccessor.VisibleMutator

Overrides:

setVisible in class ColumnSetupMetrics

setColumnWidth

public void setColumnWidth(int aColumnWidth)

Specified by:

setColumnWidth in interface ColumnWidthAccessor.ColumnWidthMutator

Overrides:

setColumnWidth in class ColumnWidthMetrics

withName

public ColumnSetupMetrics withName(String aName)

Specified by:

withName in interface NameAccessor.NameBuilder<T>

Overrides:

withName in class ColumnSetupMetrics

withColumnWidth

public ColumnSetupMetrics withColumnWidth(int aColumnWidth)

Specified by:

withColumnWidth in interface ColumnWidthAccessor.ColumnWidthBuilder<T>

Overrides:

withColumnWidth in class ColumnSetupMetrics

show

public void show()

Specified by:

show in interface VisibleAccessor.VisibleMutator

withShow

public ColumnSetupMetrics withShow()

Specified by:

withShow in interface VisibleAccessor.VisibleBuilder<T>

Overrides:

withShow in class ColumnSetupMetrics

getColumnWidthType

public ColumnWidthType getColumnWidthType()

Overrides:

getColumnWidthType in class ColumnWidthMetrics

hide

public void hide()

Specified by:

hide in interface VisibleAccessor.VisibleMutator

withHide

public ColumnSetupMetrics withHide()

Specified by:

withHide in interface VisibleAccessor.VisibleBuilder<T>

Overrides:

withHide in class ColumnSetupMetrics

withEscapeCode

public ColumnSetupMetrics withEscapeCode(String aEscapeCode)

Overrides:

withEscapeCode in class ColumnSetupMetrics

setColumnWidthType

public void setColumnWidthType(ColumnWidthType aColumnWidthType)

Overrides:

setColumnWidthType in class ColumnWidthMetrics

withHeaderEscapeCode

public ColumnSetupMetrics withHeaderEscapeCode(String aEscapeCode)

Overrides:

withHeaderEscapeCode in class ColumnSetupMetrics

fromColumnWidthMetrics

public void fromColumnWidthMetrics(ColumnWidthMetrics aColumnWidthMetrics)

Overrides:

fromColumnWidthMetrics in class ColumnWidthMetrics

withRowEscapeCode

public ColumnSetupMetrics withRowEscapeCode(String aEscapeCode)

Overrides:

withRowEscapeCode in class ColumnSetupMetrics

withColumnWidthType

public ColumnSetupMetrics withColumnWidthType(ColumnWidthType aColumnWidthType)

Overrides:

withColumnWidthType in class ColumnSetupMetrics

withHorizAlignTextMode

public ColumnSetupMetrics withHorizAlignTextMode(HorizAlignTextMode aHorizAlignTextMode)

Specified by:

withHorizAlignTextMode in interface HorizAlignTextModeAccessor.HorizAlignTextModeBuilder<T>

Overrides:

withHorizAlignTextMode in class ColumnSetupMetrics

withHeaderHorizAlignTextMode

public ColumnSetupMetrics withHeaderHorizAlignTextMode(HorizAlignTextMode aHorizAlignTextMode)

Overrides:

withHeaderHorizAlignTextMode in class ColumnSetupMetrics

withRowHorizAlignTextMode

public ColumnSetupMetrics withRowHorizAlignTextMode(HorizAlignTextMode aHorizAlignTextMode)

Overrides:

withRowHorizAlignTextMode in class ColumnSetupMetrics

withMoreTextMode

public ColumnSetupMetrics withMoreTextMode(MoreTextMode aMoreTextMode)

Specified by:

withMoreTextMode in interface MoreTextModeAccessor.MoreTextModeBuilder<T>

Overrides:

withMoreTextMode in class ColumnSetupMetrics

withHeaderMoreTextMode

public ColumnSetupMetrics withHeaderMoreTextMode(MoreTextMode aMoreTextMode)

Overrides:

withHeaderMoreTextMode in class ColumnSetupMetrics

setEscapeCodeFactory

public void setEscapeCodeFactory(EscapeCodeFactory aEscapeCodeFactory)

Overrides:

setEscapeCodeFactory in class ColumnFormatMetrics

withRowMoreTextMode

public ColumnSetupMetrics withRowMoreTextMode(MoreTextMode aMoreTextMode)

Overrides:

withRowMoreTextMode in class ColumnSetupMetrics

withTextFormatMode

public ColumnSetupMetrics withTextFormatMode(TextFormatMode aTextFormatMode)

Specified by:

withTextFormatMode in interface TextFormatModeAccessor.TextFormatModeBuilder<T>

Overrides:

withTextFormatMode in class ColumnSetupMetrics

withSplitTextMode

public ColumnSetupMetrics withSplitTextMode(SplitTextMode aSplitTextMode)

Specified by:

withSplitTextMode in interface SplitTextModeAccessor.SplitTextModeBuilder<T>

Overrides:

withSplitTextMode in class ColumnSetupMetrics

withHeaderSplitTextMode

public ColumnSetupMetrics withHeaderSplitTextMode(SplitTextMode aSplitTextMode)

Overrides:

withHeaderSplitTextMode in class ColumnSetupMetrics

withRowSplitTextMode

public ColumnSetupMetrics withRowSplitTextMode(SplitTextMode aSplitTextMode)

Overrides:

withRowSplitTextMode in class ColumnSetupMetrics

withHeaderTextFormatMode

public ColumnSetupMetrics withHeaderTextFormatMode(TextFormatMode aTextFormatMode)

Overrides:

withHeaderTextFormatMode in class ColumnSetupMetrics

withRowTextFormatMode

public ColumnSetupMetrics withRowTextFormatMode(TextFormatMode aTextFormatMode)

Overrides:

withRowTextFormatMode in class ColumnSetupMetrics

withEscapeCodeFactory

public ColumnSetupMetrics withEscapeCodeFactory(EscapeCodeFactory aEscapeCodeFactory)

Overrides:

withEscapeCodeFactory in class ColumnSetupMetrics

setHeaderEscapeCodeFactory

public void setHeaderEscapeCodeFactory(EscapeCodeFactory aEscapeCodeFactory)

Overrides:

setHeaderEscapeCodeFactory in class ColumnFormatMetrics

withHeaderEscapeCodeFactory

public ColumnSetupMetrics withHeaderEscapeCodeFactory(EscapeCodeFactory aEscapeCodeFactory)

Overrides:

withHeaderEscapeCodeFactory in class ColumnSetupMetrics

withRowEscapeCodeFactory

public ColumnSetupMetrics withRowEscapeCodeFactory(EscapeCodeFactory aEscapeCodeFactory)

Overrides:

withRowEscapeCodeFactory in class ColumnSetupMetrics

getHeaderEscapeCodeFactory

public EscapeCodeFactory getHeaderEscapeCodeFactory()

Overrides:

getHeaderEscapeCodeFactory in class ColumnFormatMetrics

fromColumnSetupMetrics

public void fromColumnSetupMetrics(ColumnSetupMetrics aColumnSetupMetrics)

Overrides:

fromColumnSetupMetrics in class ColumnSetupMetrics

toHeaderEscapeCode

public String toHeaderEscapeCode(Object aIdentifier)

Overrides:

toHeaderEscapeCode in class ColumnFormatMetrics

setRowEscapeCodeFactory

public void setRowEscapeCodeFactory(EscapeCodeFactory aEscapeCodeFactory)

Overrides:

setRowEscapeCodeFactory in class ColumnFormatMetrics

getRowEscapeCodeFactory

public EscapeCodeFactory getRowEscapeCodeFactory()

Overrides:

getRowEscapeCodeFactory in class ColumnFormatMetrics

toRowEscapeCode

public String toRowEscapeCode(Object aIdentifier)

Overrides:

toRowEscapeCode in class ColumnFormatMetrics

setEscapeCode

public void setEscapeCode(String aEscapeCode)

Overrides:

setEscapeCode in class ColumnFormatMetrics

setHeaderEscapeCode

public void setHeaderEscapeCode(String aEscapeCode)

Overrides:

setHeaderEscapeCode in class ColumnFormatMetrics

getHeaderEscapeCode

public String getHeaderEscapeCode()

Overrides:

getHeaderEscapeCode in class ColumnFormatMetrics

setRowEscapeCode

public void setRowEscapeCode(String aEscapeCode)

Overrides:

setRowEscapeCode in class ColumnFormatMetrics

getRowEscapeCode

public String getRowEscapeCode()

Overrides:

getRowEscapeCode in class ColumnFormatMetrics

setHorizAlignTextMode

public void setHorizAlignTextMode(HorizAlignTextMode aHorizAlignTextMode)

Specified by:

setHorizAlignTextMode in interface HorizAlignTextModeAccessor.HorizAlignTextModeMutator

Overrides:

setHorizAlignTextMode in class ColumnFormatMetrics

setHeaderHorizAlignTextMode

public void setHeaderHorizAlignTextMode(HorizAlignTextMode aHorizAlignTextMode)

Overrides:

setHeaderHorizAlignTextMode in class ColumnFormatMetrics

getHeaderHorizAlignTextMode

public HorizAlignTextMode getHeaderHorizAlignTextMode()

Overrides:

getHeaderHorizAlignTextMode in class ColumnFormatMetrics

setRowHorizAlignTextMode

public void setRowHorizAlignTextMode(HorizAlignTextMode aHorizAlignTextMode)

Overrides:

setRowHorizAlignTextMode in class ColumnFormatMetrics

getRowHorizAlignTextMode

public HorizAlignTextMode getRowHorizAlignTextMode()

Overrides:

getRowHorizAlignTextMode in class ColumnFormatMetrics

setMoreTextMode

public void setMoreTextMode(MoreTextMode aMoreTextMode)

Specified by:

setMoreTextMode in interface MoreTextModeAccessor.MoreTextModeMutator

Overrides:

setMoreTextMode in class ColumnFormatMetrics

setHeaderMoreTextMode

public void setHeaderMoreTextMode(MoreTextMode aMoreTextMode)

Overrides:

setHeaderMoreTextMode in class ColumnFormatMetrics

getHeaderMoreTextMode

public MoreTextMode getHeaderMoreTextMode()

Overrides:

getHeaderMoreTextMode in class ColumnFormatMetrics

setRowMoreTextMode

public void setRowMoreTextMode(MoreTextMode aMoreTextMode)

Overrides:

setRowMoreTextMode in class ColumnFormatMetrics

getRowMoreTextMode

public MoreTextMode getRowMoreTextMode()

Overrides:

getRowMoreTextMode in class ColumnFormatMetrics

setTextFormatMode

public void setTextFormatMode(TextFormatMode aTextFormatMode)

Specified by:

setTextFormatMode in interface TextFormatModeAccessor.TextFormatModeMutator

Overrides:

setTextFormatMode in class ColumnFormatMetrics

setSplitTextMode

public void setSplitTextMode(SplitTextMode aSplitTextMode)

Specified by:

setSplitTextMode in interface SplitTextModeAccessor.SplitTextModeMutator

Overrides:

setSplitTextMode in class ColumnFormatMetrics

setHeaderSplitTextMode

public void setHeaderSplitTextMode(SplitTextMode aSplitTextMode)

Overrides:

setHeaderSplitTextMode in class ColumnFormatMetrics

getHeaderSplitTextMode

public SplitTextMode getHeaderSplitTextMode()

Overrides:

getHeaderSplitTextMode in class ColumnFormatMetrics

setRowSplitTextMode

public void setRowSplitTextMode(SplitTextMode aSplitTextMode)

Overrides:

setRowSplitTextMode in class ColumnFormatMetrics

getRowSplitTextMode

public SplitTextMode getRowSplitTextMode()

Overrides:

getRowSplitTextMode in class ColumnFormatMetrics

setHeaderTextFormatMode

public void setHeaderTextFormatMode(TextFormatMode aTextFormatMode)

Overrides:

setHeaderTextFormatMode in class ColumnFormatMetrics

getHeaderTextFormatMode

public TextFormatMode getHeaderTextFormatMode()

Overrides:

getHeaderTextFormatMode in class ColumnFormatMetrics

setRowTextFormatMode

public void setRowTextFormatMode(TextFormatMode aTextFormatMode)

Overrides:

setRowTextFormatMode in class ColumnFormatMetrics

getRowTextFormatMode

public TextFormatMode getRowTextFormatMode()

Overrides:

getRowTextFormatMode in class ColumnFormatMetrics

fromColumnFormatMetrics

public void fromColumnFormatMetrics(ColumnFormatMetrics aColumnFormatMetrics)

Overrides:

fromColumnFormatMetrics in class ColumnFormatMetrics

getType

public Class<T> getType()

Specified by:

getType in interface TypeAccessor<T>

getKey

public String getKey()

Specified by:

getKey in interface KeyAccessor<T>

toStorageString

public String toStorageString(T aValue)

A Column implementation can provide its own text exchange format for the given objects. This method enables the Column to convert a value of the given type to a String and via Column.fromStorageString(String) back to the value (bijective). This method supports data sinks (such as relational databases) which allow only a single value in a row's entry: In case T is an array type, then the storage String representation of the elements in that array are represented by a single returned String. Question: Why does the detour through the method Column.toStorageString(Object) not function?!? Having this snippet in the code seems to be fine for the compiler ... trying Column.toStorageString_(Object) instead :-( In case a data sink (such as Amazon's SimpleDb) is to be addressed which provides dedicated support for multiple values in one row's entry, then the method Column.toStorageStrings(Object) may be used instead.

Specified by:

toStorageString in interface Column<T>

Parameters:

aValue - the element to be converted to a String.

Returns:

The String representation of the value.

toStorageStrings

public String[] toStorageStrings(T aValue)

A Column implementation can provide its own text exchange format for the given objects. This method enables the Column to convert a value of the given type to a String array and via Column.fromStorageStrings(String[]) back to the value (bijective). This method supports data sinks (such as Amazon's SimpleDb) which provide dedicated support for multiple values in a row's entry: In case T is an array type, then the storage String representations of the elements in that array may be placed in dedicated entries of the returned String array. In case T is not an array type then the returned String array may contain just one value. In case data sinks (such as relational databases) are to be addressed which allow only a single value in a row's entry, then the method Column.toStorageString(Object) may be used instead.

Specified by:

toStorageStrings in interface Column<T>

Parameters:

aValue - the element to be converted to a String array.

Returns:

The String array representation of the value.

fromStorageString

public T fromStorageString(String aStringValue)
                    throws ParseException

A Column implementation can provide its own text exchange format for the given objects. This method enables the Column to convert a String value to a value of the given type and via Column.toStorageString(Object) back to the String (bijective). This method supports data sinks (such as relational databases) which allow only a single value in a row's entry: In case T is an array type, then the storage String representation of the elements in that array are represented by the single passed String. In case a data sink (such as Amazon's SimpleDb) is to be addressed which provides dedicated support for multiple values in one row's entry, then the method Column.fromStorageStrings(String[]) may be used instead.

Specified by:

fromStorageString in interface Column<T>

Parameters:

aStringValue - The value to be converted to a type instance.

Returns:

The type representation of the value.

Throws:

ParseException - in case parsing the String was not possible

fromStorageStrings

public T fromStorageStrings(String[] aStringArray)
                     throws ParseException

A Column implementation can provide its own text exchange format for the given objects. This method enables the Column to convert a String array value to a value of the given type and via Column.toStorageStrings(Object) back to the String array (bijective). This method supports data sinks (such as Amazon's SimpleDb) which provide dedicated support for multiple values in a row's entry: In case T is an array type, then the storage String representations of the elements in that array may be placed in dedicated entries of the provided String array. In case T is not an array type then the passed String array may contain just one value. In case data sinks (such as relational databases) are to be addressed which allow only a single value in a row's entry, then the method Column.fromStorageString(String) may be used instead.

Specified by:

fromStorageStrings in interface Column<T>

Parameters:

aStringArray - The value to be converted to a type instance.

Returns:

The type representation of the value.

Throws:

ParseException - in case parsing the String was not possible

toPrintable

public String toPrintable(T aValue)

A Column implementation can provide its own printable format of the given objects; for example a human readable text representation of the value (or in very https://www.metacodes.proized cases even enriched with ANSI escape codes). This method enables the Column to convert a value of the given type to a human readable text. The human readable text, in comparison to the method Object.toString() (or Column.toStorageString(Object)) is not intended to be converted back to the actual value (not bijective). This method may be used a Header instance's method HeaderRow.toPrintable(Record).

Specified by:

toPrintable in interface Column<T>

Parameters:

aValue - the element to be converted to a human readable text.

Returns:

The human readable representation of the value.

contains

public boolean contains(Record<?> aRecord)

Tests whether the Record contains a value identified by the Column instance's key and where the value's type is assignable to the Column instance's type. Only if them both criteria match, then true is returned. False is returned if there is no such value or the value is not assignable to the Column instance's type.

Specified by:

contains in interface Column<T>

Parameters:

aRecord - The Record which to test if there is a value associated to the Column instance's key and if it can be casted to the Column instance's type.

Returns:

True in case the Record contains a value identified by the Column instance's key and where the value's type is assignable to the Column instance's type.

get

public T get(Record<?> aRecord)
      throws ColumnMismatchException

Retrieves a type correct value from the Record identified by the Column instance's key. In case the type of the Column instance does not match the value's type associated with the Column instance's key, then a ColumnMismatchException is thrown.

Specified by:

get in interface Column<T>

Parameters:

aRecord - The Record from which to retrieve the value associated to the Column instances key.

Returns:

The value from the Record associated to the Column instances key.

Throws:

ColumnMismatchException - in case the value in the Record associated with the Column instance's key does not fit the Column instance's type.

remove

public T remove(Record<?> aRecord)
         throws ColumnMismatchException

Removes an entry (key and value pair) from the provided Record matching the key and the type of the Column.

Specified by:

remove in interface Column<T>

Parameters:

aRecord - The Record from which to remove the related entry.

Returns:

The value related to the given Column instance's key or null if there was none such value found.

Throws:

ColumnMismatchException - in case the value in the Record associated with the Column instance's key does not fit the Column instance's type.