org.eobjects.analyzer.data
Interface InputColumn<E>

Package class diagram package InputColumn
Type Parameters:
E - the data type of the column. See DataTypeFamily for available values.
All Superinterfaces:
java.lang.Comparable<InputColumn<E>>
All Known Subinterfaces:
MutableInputColumn<E>
All Known Implementing Classes:
AbstractInputColumn, MetaModelInputColumn, MockInputColumn, TransformedInputColumn

public interface InputColumn<E>
extends java.lang.Comparable<InputColumn<E>>

Represents a column that is used to retrieve values from a row of data. A column can be either physical (based directly on a database column) or virtual if the values yielded by this column are have been transformed (eg. tokenized, sampled etc.)

See Also:
DataTypeFamily

Method Summary
 java.lang.Class<? extends E> getDataType()
          The Data type stored in this column represented as a Java type.
 DataTypeFamily getDataTypeFamily()
           
 java.lang.String getName()
           
 dk.eobjects.metamodel.schema.Column getPhysicalColumn()
           
 boolean isPhysicalColumn()
           
 boolean isVirtualColumn()
           
 
Methods inherited from interface java.lang.Comparable
compareTo
 

Method Detail

getName

java.lang.String getName()
Returns:
the name of this column

isPhysicalColumn

boolean isPhysicalColumn()
Returns:
true if this InputColumn is based on a physical column that can be natively queried.

isVirtualColumn

boolean isVirtualColumn()
Returns:
true if this InputColumn is virtual (ie. the opposite of physical).

getPhysicalColumn

dk.eobjects.metamodel.schema.Column getPhysicalColumn()
                                                      throws java.lang.IllegalStateException
Returns:
the underlying physical column.
Throws:
java.lang.IllegalStateException - if isPhysicalColumn() is false

getDataType

java.lang.Class<? extends E> getDataType()
The Data type stored in this column represented as a Java type. Notice that for most purposes you should ud getDataTypeFamily as it is limited to the actual supported families of data types (eg. File is not a supported data type, but Integer, Float, String etc. are).

Returns:
the data type of this column.

getDataTypeFamily

DataTypeFamily getDataTypeFamily()
Returns:
the family of datatypes that matches column's data type. This value should be corresponding to the type-parameter .