Package org.refcodes.tabular

Class AbstractColumn<T>

  • Type Parameters:
    T - The type managed by the column.
    All Implemented Interfaces:
    java.lang.Cloneable, org.refcodes.mixin.KeyAccessor<T>, org.refcodes.mixin.TypeAccessor<T>, Column<T>
    Direct Known Subclasses:
    DateColumnImpl, ExceptionColumnImpl, IntegerColumn, ObjectColumn, StringColumn, StringsColumn

    public abstract class AbstractColumn<T>
extends java.lang.Object
implements Column<T>, java.lang.Cloneable
    The AbstractColumn is the default implementation for the Column interface. It implements amongst others the toStorageString(Object) and fromStorageString(String) methods leaving the developer to implement in sub-classes only the two methods Column.toStorageStrings(Object) as well as Column.fromStorageStrings(String[]) which are to do the actual conversions.

    Special care is taken when the type T is an array type:

    The method toStorageString(Object) returns a String with separated values (in terms of CSV) in case the type T is an array type. The delimiter of the values in this String then is the Delimiter.ARRAY character as we use the Delimiter.CSV when embedding the returned String in a CSV list (file).

    The method fromStorageString(String) interprets the passed String as separated values (in terms of CSV) in case the type T is an array type. It creates a String array from the String value; the delimiter of the values in the String used is the Delimiter.ARRAY character as we use the Delimiter.CSV when parsing a String in a CSV list (file).

    • Nested Class Summary

      • Nested classes/interfaces inherited from interface org.refcodes.mixin.KeyAccessor

        org.refcodes.mixin.KeyAccessor.KeyBuilder<K extends java.lang.Object,B extends org.refcodes.mixin.KeyAccessor.KeyBuilder<K,B>>, org.refcodes.mixin.KeyAccessor.KeyMutator<K extends java.lang.Object>, org.refcodes.mixin.KeyAccessor.KeyProperty<K extends java.lang.Object>

      • Nested classes/interfaces inherited from interface org.refcodes.mixin.TypeAccessor

        org.refcodes.mixin.TypeAccessor.TypeMutator<T extends java.lang.Object>, org.refcodes.mixin.TypeAccessor.TypeProperty<T extends java.lang.Object>

    • Constructor Summary

      Constructors 
      Constructor Description
      AbstractColumn​(java.lang.String aKey, java.lang.Class<T> aType)
      Constructs a column.

    • Method Summary

      All Methods Instance Methods Concrete Methods 
      Modifier and Type Method Description
      java.lang.Object clone​()
      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.
      T fromStorageString​(java.lang.String aStringValue)
      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.
      java.lang.String getKey​()
      java.lang.Class<T> getType​()
      T remove​(Record<?> aRecord)
      Removes an entry (key and value pair) from the provided Record matching the key and the type of the Column.
      java.lang.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 specialized cases even enriched with ANSI escape codes).
      java.lang.String toStorageString​(T aValue)
      A Column implementation can provide its own text exchange format for the given objects.

      • Methods inherited from class java.lang.Object

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

    • Constructor Detail

      • AbstractColumn

        public AbstractColumn​(java.lang.String aKey,
                      java.lang.Class<T> aType)
        Constructs a column.
        Parameters:
        aKey - The key describing the column.
        aType - The type describing the column.

    • Method Detail

      • toStorageString

        public java.lang.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. TODO: 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.

      • fromStorageString

        public T fromStorageString​(java.lang.String aStringValue)
                    throws java.text.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:
        java.text.ParseException - in case parsing the String was not possible

      • toPrintable

        public java.lang.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 specialized 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.

      • remove

        public T remove​(Record<?> aRecord)
         throws ColumnMismatchException
        Description copied from interface: Column
        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.

      • getType

        public java.lang.Class<T> getType​()
        Specified by:
        getType in interface org.refcodes.mixin.TypeAccessor<T>

      • getKey

        public java.lang.String getKey​()
        Specified by:
        getKey in interface org.refcodes.mixin.KeyAccessor<T>

      • clone

        public java.lang.Object clone​()
                       throws java.lang.CloneNotSupportedException
        Overrides:
        clone in class java.lang.Object
        Throws:
        java.lang.CloneNotSupportedException