DataModel Objects

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

d.columnGroupIterator() : Iterator

Returns an iterator that returns each column group in turn.

d.columnIterator() : Iterator

Returns an iterator that returns each column in the "natural" insert order. The iterator returns instances of Column.

d.contains(name) : boolean

name (string) : the column name

Returns True if a column with the supplied name exists in this DataModel, False otherwise.

d.getColumn(name) : Column
name (string) : 

Returns the column with the specified name.

Exceptions:

DataModelException : if the named column does not exist

d.getColumnCount() : int

Returns the number of columns in this set.

d.getColumnGroup(name) : ColumnGroup
name (string) : 

Returns the named column group or None if no such column group exists.

d.getColumnGroupCount() : int

Returns the number of column groups in this data model.

d.getColumnLabel(name) : string

name (string) : the column name

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

Exceptions:

DataModelException : if the named column does not exist

d.getFalseFlag(name) : Object

name (string) : the column name

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

Exceptions:

DataModelException : if the named column does not exist

d.getLowerBound(name) : Object

name (string) : the column name

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

Exceptions:

DataModelException : if the named column does not exist

d.getMeasureType(name) : MeasureType

name (string) : the column name

Returns the measure type for values in the named column.

Exceptions:

DataModelException : if the named column does not exist

d.getMissingValueDefinition(name) : MissingValueDefinition

name (string) : the column name

Returns the missing value definition for the column or None.

Exceptions:

DataModelException : if the named column does not exist

d.getModelingRole(name) : ModelingRole

name (string) : the column name

Returns the modeling role for the named column.

Exceptions:

DataModelException : if the named column does not exist

d.getSetValues(name) : Object[]

name (string) : the column name

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.

Exceptions:

DataModelException : if the named column does not exist

d.getStorageType(name) : StorageType

name (string) : the column name

Returns the storage type for values in the named column.

Exceptions:

DataModelException : if the named column does not exist

d.getTrueFlag(name) : Object

name (string) : the column name

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

Exceptions:

DataModelException : if the named column does not exist

d.getUpperBound(name) : Object

name (string) : the column name

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

Exceptions:

DataModelException : if the named column does not exist

d.getValueLabel(name, value) : string

name (string) : the column name

value (Object) : the value

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

Exceptions:

DataModelException : if the named column does not exist

d.hasMissingValueDefinition(name) : boolean

name (string) : the column name

Returns True if the column has a missing value definition.

Exceptions:

DataModelException : if the named column does not exist

d.isMeasureDiscrete(name) : boolean

name (string) : the column name

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

Exceptions:

DataModelException : if the named column does not exist

d.isModelOutputColumn(name) : boolean

name (string) : the column name

Returns True if this is a model output column.

Exceptions:

DataModelException : if the named column does not exist

d.isStorageDatetime(name) : boolean

name (string) : the column name

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

Exceptions:

DataModelException : if the named column does not exist

d.isStorageNumeric(name) : boolean

name (string) : the column name

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

Exceptions:

DataModelException : if the named column does not exist

d.isValidValue(name, value) : boolean

name (string) : the column name

value (Object) : the value

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

Exceptions:

DataModelException : if the named column does not exist

d.nameIterator() : Iterator

Returns an iterator that returns the name of each column in the "natural" insert order.

d.toArray() : Column[]

Returns the data model as an array of columns. The columns are ordered in their natural/insert order.