public interface Column
DataModel
,
DataModelFactory
Modifier and Type | Method and Description |
---|---|
java.lang.String |
getColumnLabel()
Returns the label of the column or an empty string
if there is no label associated with the column.
|
java.lang.String |
getColumnName()
Returns the name of the column.
|
ExtendedMeasure |
getExtendedMeasure()
Returns additional metadata that is specific for this field's measurement.
|
ExtendedStorage |
getExtendedStorage()
Returns additional metadata for this field's storage or
null
if no additional storage metadata is defined. |
java.lang.Object |
getFalseFlag()
Returns the "false" indicator value for the column, or
null if either
the value is not known or the column is not a flag. |
java.lang.Object |
getLowerBound()
Returns the lower bound value for the values in the column, or
null
if either the value is not known or the column is not continuous. |
MeasureType |
getMeasureType()
Returns the measure type for the column.
|
MissingValueDefinition |
getMissingValueDefinition()
Returns the missing value definition for the column or
null . |
ModelingRole |
getModelingRole()
Returns the modeling role for the column.
|
ModelOutputMetadata |
getModelOutputMetadata()
Returns the model output column role for the column if
it is a model output column or
null |
java.lang.Object[] |
getSetValues()
Returns an array of valid values for the column, or
null
if either the values are not known or the column is not a set. |
StorageType |
getStorageType()
Returns the storage type for the column.
|
java.lang.Object |
getTrueFlag()
Returns the "true" indicator value for the column, or
null if either
the value is not known or the column is not a flag. |
java.lang.Object |
getUpperBound()
Returns the upper bound value for the values in the column, or
null
if either the value is not known or the column is not continuous. |
java.lang.String |
getValueLabel(java.lang.Object value)
Returns the label for the value in the column or an empty string
if there is no label associated with the value.
|
boolean |
hasMissingValueDefinition()
Returns
true if the column has a missing value definition. |
boolean |
isList()
Returns
true if this field is a list field. |
boolean |
isMeasureContinuous()
Returns
true if the column is continuous. |
boolean |
isMeasureDiscrete()
Returns
true if the column is discrete. |
boolean |
isModelOutputColumn()
Returns
true if this is a model output column. |
boolean |
isStorageDatetime()
Returns
true if the column's storage is a time, date or timestamp value. |
boolean |
isStorageNumeric()
Returns
true if the column's storage is an integer or a real number. |
boolean |
isValidValue(java.lang.Object value)
Returns
true if the specified value is valid for this
storage and valid when the valid column values are known. |
java.lang.String getColumnName()
StorageType getStorageType()
MeasureType getMeasureType()
boolean isList()
true
if this field is a list field.true
if this field is a list field, false
otherwise.getExtendedStorage()
,
getExtendedMeasure()
ExtendedStorage getExtendedStorage()
null
if no additional storage metadata is defined.null
isList()
,
getExtendedMeasure()
ExtendedMeasure getExtendedMeasure()
null
if no additional metadata is defined.null
isList()
,
getExtendedStorage()
ModelingRole getModelingRole()
boolean isMeasureDiscrete()
true
if the column is discrete. Columns that are either a set
or a flag are considered discrete.true
if the column is either a set or a flag type,
false
otherwise.boolean isMeasureContinuous()
true
if the column is continuous.true
if the column is continuous, false
otherwise.boolean isStorageNumeric()
true
if the column's storage is an integer or a real number.true
if the column's storage is an integer or a real number,
false
otherwise.boolean isStorageDatetime()
true
if the column's storage is a time, date or timestamp value.true
if the column's storage is a time, date or timestamp value,
false
otherwise.java.lang.Object getLowerBound()
null
if either the value is not known or the column is not continuous.null
java.lang.Object getUpperBound()
null
if either the value is not known or the column is not continuous.null
java.lang.Object[] getSetValues()
null
if either the values are not known or the column is not a set.null
java.lang.Object getTrueFlag()
null
if either
the value is not known or the column is not a flag.null
java.lang.Object getFalseFlag()
null
if either
the value is not known or the column is not a flag.null
boolean isValidValue(java.lang.Object value)
true
if the specified value is valid for this
storage and valid when the valid column values are known.value
- the valuetrue
if the specified value is valid for this
storage and valid when the valid column values are knownboolean hasMissingValueDefinition()
true
if the column has a missing value definition.true
if the column has missing value definitionMissingValueDefinition getMissingValueDefinition()
null
.null
java.lang.String getColumnLabel()
java.lang.String getValueLabel(java.lang.Object value)
value
- the valueboolean isModelOutputColumn()
true
if this is a model output column.true
if this is a model output columnModelOutputMetadata getModelOutputMetadata()
null
null
Copyright © 2014 Integral Solutions Ltd. All Rights Reserved.