com.metamatrix.metadata.runtime.api
Interface Group

All Superinterfaces:

MetadataObject, java.io.Serializable

All Known Implementing Classes:

BasicGroup

public interface Group
extends MetadataObject

Instances of this interface represent Groups in a Model. The values of a Group are analogous to a Table in a database.

Method Summary

java.lang.String	getAlias() Return the alias.
java.lang.String	getDeleteQueryPlan() Return the DELETE query plan for the group if it is a virtual group.
java.lang.String	getDescription() Return the group description.
java.util.List	getElementIDs() Returns an ordered list of ElementID's for this group.
java.lang.String	getInsertQueryPlan() Return the INSERT query plan for the group if it is a virtual group.
java.util.Collection	getKeyIDs() Returns the KeyID's identified for this group.
java.lang.String	getMappingDocument() Return the mapping document if this group represents a virtual document.
java.lang.String	getNameInSource() Returns the name-in-soure for this group.
java.lang.String	getPath() Return the path to the group.
java.lang.String	getQueryPlan() Return the query plan for the group if it is a virtual group.
short	getTableType()
java.lang.String	getUpdateQueryPlan() Return the UPDATE query plan for the group if it is a virtual group.
java.util.Collection	getXMLSchemas() If this group represents a virtual document, return a Collection of string representations of XML Schemas that are referenced by it.
boolean	hasNameInSource() Returns whether the name-in-soure is defined for this element.
boolean	isDeleteAllowed() Returns the deleteAllowed.
boolean	isInsertAllowed() Returns the insertAllowed.
boolean	isPhysical() Return boolean indicating if this a physical model.
boolean	isSystemTable()
boolean	isUpdateAllowed() Returns the updateAllowed.
boolean	isVirtualDocument() Whether this group represents a virtual document.
boolean	supportsUpdate() Return boolean indicating if the model supports UPDATE operations in the sql.

Methods inherited from interface com.metamatrix.metadata.runtime.api.MetadataObject

clone, compareTo, equals, getFullName, getID, getName, getProperties, getVirtualDatabaseID, toString

Method Detail

getPath

java.lang.String getPath()

Return the path to the group.

Returns:

String

getNameInSource

java.lang.String getNameInSource()

Returns the name-in-soure for this group.

Returns:

String is the name in source

hasNameInSource

boolean hasNameInSource()

Returns whether the name-in-soure is defined for this element.

Returns:

true if this element has the name in source; false otherwise.

getDescription

java.lang.String getDescription()

Return the group description.

Returns:

String

getAlias

java.lang.String getAlias()

Return the alias.

Returns:

String alias

getElementIDs

java.util.List getElementIDs()

Returns an ordered list of ElementID's for this group.

Returns:

List of ElementID's

getKeyIDs

java.util.Collection getKeyIDs()

Returns the KeyID's identified for this group.

Returns:

Collection of KeyID's

isPhysical

boolean isPhysical()

Return boolean indicating if this a physical model.

Returns:

boolean true if is is a physical model

getQueryPlan

java.lang.String getQueryPlan()

Return the query plan for the group if it is a virtual group.

Returns:

String

getUpdateQueryPlan

java.lang.String getUpdateQueryPlan()

Return the UPDATE query plan for the group if it is a virtual group.

Returns:

String

getInsertQueryPlan

java.lang.String getInsertQueryPlan()

Return the INSERT query plan for the group if it is a virtual group.

Returns:

String

getDeleteQueryPlan

java.lang.String getDeleteQueryPlan()

Return the DELETE query plan for the group if it is a virtual group.

Returns:

String

isDeleteAllowed

boolean isDeleteAllowed()

Returns the deleteAllowed.

Returns:

boolean

isInsertAllowed

boolean isInsertAllowed()

Returns the insertAllowed.

Returns:

boolean

isUpdateAllowed

boolean isUpdateAllowed()

Returns the updateAllowed.

Returns:

boolean

isSystemTable

boolean isSystemTable()

Returns:

boolean true indicates this is a RuntimeMetadata System table

getTableType

short getTableType()

Returns:

short indicating table type (i.e., TABLE, SYSTEM, VIEW)

See Also:

MetadataConstants.TABLE_TYPES

supportsUpdate

boolean supportsUpdate()

Return boolean indicating if the model supports UPDATE operations in the sql.

Returns:

boolean

getMappingDocument

java.lang.String getMappingDocument()

Return the mapping document if this group represents a virtual document.

Returns:

the mapping document string.

isVirtualDocument

boolean isVirtualDocument()

Whether this group represents a virtual document.

Returns:

true if this group represents a virtual document. False otherwise.

getXMLSchemas

java.util.Collection getXMLSchemas()

If this group represents a virtual document, return a Collection of string representations of XML Schemas that are referenced by it.

Returns:

Collection of String