Column Objects

This defines the properties of a set of columns. Applications that wish to construct Column instances must do so using the DataModelFactory rather than implementing the interface directly.

c.getColumnLabel() : string

Returns the label of the column or an empty string if there is no label associated with the column.

c.getColumnName() : string

Returns the name of the column.

c.getFalseFlag() : Object

Returns the "false" indicator value for the column, or None if either the value is not known or the column is not a flag.

c.getLowerBound() : Object

Returns the lower bound value for the values in the column, or None if either the value is not known or the column is not continuous.

c.getMeasureType() : MeasureType

Returns the measure type for the column.

c.getMissingValueDefinition() : MissingValueDefinition

Returns the missing value definition for the column or None.

c.getModelOutputMetadata() : ModelOutputMetadata

Returns the model output column role for the column if it is a model output column or None.

c.getModelingRole() : ModelingRole

Returns the modeling role for the column.

c.getSetValues() : Object[]

Returns an array of valid values for the column, or None if either the values are not known or the column is not a set.

c.getStorageType() : StorageType

Returns the storage type for the column.

c.getTrueFlag() : Object

Returns the "true" indicator value for the column, or None if either the value is not known or the column is not a flag.

c.getUpperBound() : Object

Returns the upper bound value for the values in the column, or None if either the value is not known or the column is not continuous.

c.getValueLabel(value) : string

value (Object) : the value

Returns the label for the value in the column or an empty string if there is no label associated with the value.

c.hasMissingValueDefinition() : boolean

Returns True if the column has a missing value definition.

c.isMeasureDiscrete() : boolean

Returns True if the column is discrete. Columns that are either a set or a flag are considered discrete.

c.isModelOutputColumn() : boolean

Returns True if this is a model output column.

c.isStorageDatetime() : boolean

Returns True if the column's storage is a time, date or timestamp value.

c.isStorageNumeric() : boolean

Returns True if the column's storage is an integer or a real number.

c.isValidValue(value) : boolean

value (Object) : the value

Returns True if the specified value is valid for this storage and valid when the valid column values are known.

d.getExtendedMeasure(name) : ExtendedMeasure

name (string) : the column name

Returns additional metadata that is specific for this field. For example, geospatial fields may return a geospatial-specific descriptor that defines the metadata necessary for the correct interpretation of the values.

Exceptions:

DataModelException : if the named column does not exist

d.getExtendedStorage(name) : ExtendedStorage

name (string) : the field name

Returns additional metadata for this field's storage or None if no additional storage metadata is defined.

d.isList(name) : boolean

name (string) :

Returns True if this field is a list field.