com.metamatrix.modeler.core.metadata.runtime
Interface TableRecord

All Superinterfaces:
MetadataRecord, java.io.Serializable
All Known Implementing Classes:
TableRecordImpl

public interface TableRecord
extends MetadataRecord

TableRecord


Nested Class Summary
static interface TableRecord.TableRecordProperties
          Constants for perperties stored on a TableRecord
 
Nested classes/interfaces inherited from interface com.metamatrix.modeler.core.metadata.runtime.MetadataRecord
MetadataRecord.MetadataFieldNames, MetadataRecord.MetadataRecordProperties
 
Method Summary
 java.util.Collection getAccessPatternIDs()
          Get a list of identifiers for the access patterns in the table
 int getCardinality()
          Get a cardinality of the table in the table
 java.util.List getColumnIDs()
          Deprecated. columnIDs are no longer stored in the record. Columns can be retrieved by querying for all columns having the same qualified parent table name.
 java.util.Collection getForeignKeyIDs()
          Get a list of identifiers for the foreign keys in the table
 java.util.Collection getIndexIDs()
          Get a list of identifiers for the indexes in the table
 java.lang.Object getMaterializedStageTableID()
          Get a materialized staging table identifier for this table
 java.lang.Object getMaterializedTableID()
          Get a materialized table identifier for this table
 java.lang.Object getPrimaryKeyID()
          Get a primary key identifier in the table
 int getTableType()
          Return the table type of this table
 java.util.Collection getUniqueKeyIDs()
          Get a list of identifiers for the unique keys in the table
 boolean isMaterialized()
          Check if table represents a materialized table
 boolean isPhysical()
          Check if table represents a table in a physical model
 boolean isSystem()
          Check if table represents a table in a system model
 boolean isVirtual()
          Check if table represents a table in a virtual model
 boolean supportsUpdate()
          Check if UPDATE operations are supported on the table
 
Methods inherited from interface com.metamatrix.modeler.core.metadata.runtime.MetadataRecord
getEObject, getFullName, getModelName, getName, getNameInSource, getParentFullName, getParentPathString, getParentUUID, getPath, getPathString, getPropertyValue, getRecordType, getResourcePath, getUUID, setPropertyValue
 

Method Detail

supportsUpdate

boolean supportsUpdate()
Check if UPDATE operations are supported on the table

Returns:
true if the table can be used in an UPDATE

isVirtual

boolean isVirtual()
Check if table represents a table in a virtual model

Returns:
true if the table is virtual

isPhysical

boolean isPhysical()
Check if table represents a table in a physical model

Returns:
true if the table is physical

isSystem

boolean isSystem()
Check if table represents a table in a system model

Returns:
true if the table is system

isMaterialized

boolean isMaterialized()
Check if table represents a materialized table

Returns:
true if the table is materialized

getTableType

int getTableType()
Return the table type of this table

Returns:
a int value from the available table types
See Also:
MetadataConstants.TABLE_TYPES

getColumnIDs

java.util.List getColumnIDs()
Deprecated. columnIDs are no longer stored in the record. Columns can be retrieved by querying for all columns having the same qualified parent table name.

Get a list of identifiers for the columns in the table

Returns:
a list of identifiers

getIndexIDs

java.util.Collection getIndexIDs()
Get a list of identifiers for the indexes in the table

Returns:
a list of identifiers

getUniqueKeyIDs

java.util.Collection getUniqueKeyIDs()
Get a list of identifiers for the unique keys in the table

Returns:
a list of identifiers

getForeignKeyIDs

java.util.Collection getForeignKeyIDs()
Get a list of identifiers for the foreign keys in the table

Returns:
a list of identifiers

getMaterializedTableID

java.lang.Object getMaterializedTableID()
Get a materialized table identifier for this table

Returns:
an identifier for materialized table

getMaterializedStageTableID

java.lang.Object getMaterializedStageTableID()
Get a materialized staging table identifier for this table

Returns:
an identifier for materialized staging table

getPrimaryKeyID

java.lang.Object getPrimaryKeyID()
Get a primary key identifier in the table

Returns:
an identifier for the primary key

getAccessPatternIDs

java.util.Collection getAccessPatternIDs()
Get a list of identifiers for the access patterns in the table

Returns:
a list of identifiers

getCardinality

int getCardinality()
Get a cardinality of the table in the table

Returns:
the cardinality


Copyright © 2009. All Rights Reserved.