Package | Description |
---|---|
com.spss.psapi.data |
This provides support for metadata such as the names, values and types of data.
|
Modifier and Type | Class and Description |
---|---|
class |
ColumnCountException
A
ColumnCountException is thrown when the number of columns in the data
did not match the number of columns specified in the data model. |
class |
InvalidColumnValueException
An
InvalidColumnValueException is thrown when the value supplied for a column
is not consistent with its storage type. |
class |
UnknownColumnException
An
UnknownColumnException is thrown when a column name is used that does not
exist in the data model. |
Modifier and Type | Method and Description |
---|---|
Column |
DataModelFactory.createColumn(java.lang.String name,
java.lang.String label,
Column sourceColumn)
Returns a
Column with the specified name and labels but with all
other attributes the same as source column. |
Column |
DataModelFactory.createModelOutputColumn(java.lang.String prefix,
java.lang.String basename,
Column sourceColumn,
ModelOutputMetadata modelOutputMetadata)
Returns a new
Column with the same type metadata as the
source column along with the associated model output metadata. |
Column |
DataModelFactory.createModelOutputColumn(java.lang.String prefix,
java.lang.String basename,
StorageType storageType,
MeasureType measureType,
ModelOutputMetadata modelOutputMetadata)
Returns a new
Column with the specified type metadata and
associated model output metadata. |
RowSet |
RowSetFactory.createRow(java.util.List values,
DataModel dataModel)
Returns a RowSet consisting of a single row of values which are supplied
as a list.
|
RowSet |
RowSetFactory.createRow(java.lang.Object[] values,
DataModel dataModel)
Returns a RowSet consisting of a single row of values which are supplied
as a list.
|
java.lang.String |
DataModelFactory.dataModelToXML(DataModel dataModel)
Returns an XML format string containing the supplied data model in a
serializable format.
|
DataModel |
DataModelFactory.extendDataModel(Column[] columns,
DataModel initialDataModel)
Returns a
DataModel consisting of the columns appended to the
supplied data model. |
DataModel |
DataModelFactory.extendDataModel(Column column,
DataModel initialDataModel)
Returns a
DataModel consisting of the column appended to the
supplied data model. |
DataModel |
DataModelFactory.extendDataModel(DataModel addition,
DataModel initialDataModel)
Returns a
DataModel consisting of the initial data model with
the additions appended. |
DataModel |
DataModelFactory.extractDataModel(MeasureType[] measureTypes,
DataModel initialDataModel)
Returns a
DataModel consisting of columns in the
source data model that have the supplied measure type(s). |
DataModel |
DataModelFactory.extractDataModel(ModelingRole[] modelingRoles,
DataModel initialDataModel)
Returns a
DataModel consisting of columns in the
source data model that have the supplied modeling role(s). |
DataModel |
DataModelFactory.extractDataModel(StorageType[] storageTypes,
DataModel initialDataModel)
Returns a
DataModel consisting of columns in the
source data model that have the supplied storage type(s). |
DataModel |
DataModelFactory.extractDataModel(java.lang.String[] names,
DataModel initialDataModel)
Returns a
DataModel consisting of the named columns extracted from the
source data model. |
Column |
DataModel.getColumn(java.lang.String name)
Returns the column with the specified name.
|
java.lang.String |
DataModel.getColumnLabel(java.lang.String name)
Returns the label of the named column or an empty string
if there is no label associated with the column.
|
ExtendedMeasure |
DataModel.getExtendedMeasure(java.lang.String name)
Returns additional metadata that is specific for this field.
|
ExtendedStorage |
DataModel.getExtendedStorage(java.lang.String name)
Returns additional metadata for this field's storage or
null
if no additional storage metadata is defined. |
java.lang.Object |
DataModel.getFalseFlag(java.lang.String name)
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 |
DataModel.getLowerBound(java.lang.String name)
Returns the lower bound value for the values in the named column, or
null
if either the value is not known or the column is not continuous. |
MeasureType |
DataModel.getMeasureType(java.lang.String name)
Returns the measure type for values in the named column.
|
MissingValueDefinition |
DataModel.getMissingValueDefinition(java.lang.String name)
Returns the missing value definition for the column or
null . |
ModelingRole |
DataModel.getModelingRole(java.lang.String name)
Returns the modeling role for the named column.
|
java.lang.Object[] |
DataModel.getSetValues(java.lang.String name)
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 |
DataModel.getStorageType(java.lang.String name)
Returns the storage type for values in the named column.
|
java.lang.Object |
DataModel.getTrueFlag(java.lang.String name)
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 |
DataModel.getUpperBound(java.lang.String name)
Returns the upper bound value for the values in the named column, or
null
if either the value is not known or the column is not continuous. |
java.lang.String |
DataModel.getValueLabel(java.lang.String name,
java.lang.Object value)
Returns the label for the value in the named column or an empty string
if there is no label associated with the value.
|
boolean |
DataModel.hasMissingValueDefinition(java.lang.String name)
Returns
true if the column has a missing value definition. |
boolean |
DataModel.isList(java.lang.String name)
Returns
true if this field is a list field. |
boolean |
DataModel.isMeasureDiscrete(java.lang.String name)
Returns
true if the column is discrete. |
boolean |
DataModel.isModelOutputColumn(java.lang.String name)
Returns
true if this is a model output column. |
boolean |
DataModel.isStorageDatetime(java.lang.String name)
Returns
true if the column's storage is a time, date or timestamp value. |
boolean |
DataModel.isStorageNumeric(java.lang.String name)
Returns
true if the column's storage is an integer or a real number. |
boolean |
DataModel.isValidValue(java.lang.String name,
java.lang.Object value)
Returns
true if the specified value is valid for this
storage and valid when the valid column values are known. |
DataModel |
DataModel.modifyColumns(java.util.Collection<Column> modifiedColumns)
Creates and returns a new data model based on this data model with the specified columns
modified.
|
DataModel |
DataModel.removeColumns(java.util.Collection<java.lang.String> columnNames)
Creates and returns a new data model based on this data model with the specified columns
modified.
|
DataModel |
DataModelFactory.removeFromDataModel(MeasureType[] measureTypes,
DataModel initialDataModel)
Returns a
DataModel consisting of the source data model with
columns of the supplied measure type(s) removed. |
DataModel |
DataModelFactory.removeFromDataModel(ModelingRole[] modelingRoles,
DataModel initialDataModel)
Returns a
DataModel consisting of the source data model with
columns of the supplied modeling roles(s) removed. |
DataModel |
DataModelFactory.removeFromDataModel(StorageType[] storageTypes,
DataModel initialDataModel)
Returns a
DataModel consisting of the source data model with
columns of the supplied storage type(s) removed. |
DataModel |
DataModelFactory.removeFromDataModel(java.lang.String[] names,
DataModel initialDataModel)
Returns a
DataModel consisting of the source data model with the named columns removed. |
DataModel |
DataModel.renameColumns(java.util.Map<java.lang.String,java.lang.String> modifiedNames)
Creates and returns a new data model based on this data model with the specified columns
renamed.
|
DataModel |
DataModelFactory.toDataModel(Column[] columns)
Returns a
DataModel containing the supplied columns. |
DataModel |
DataModelFactory.xmlToDataModel(java.lang.String xml)
Returns a
DataModel defined by the supplied XML string. |
Copyright © 2014 Integral Solutions Ltd. All Rights Reserved.