com.metamatrix.metadata.runtime.model
Class BasicGroup

java.lang.Object
  com.metamatrix.metadata.runtime.model.BasicMetadataObject
      com.metamatrix.metadata.runtime.model.BasicGroup

All Implemented Interfaces:

Group, MetadataObject, java.io.Serializable

public class BasicGroup
extends BasicMetadataObject
implements Group

See Also:

Serialized Form

Constructor Summary

BasicGroup(BasicGroupID groupID, BasicVirtualDatabaseID virtualDBID)
Call constructor to instantiate a runtime object by passing the RuntimeID that identifies the entity and the VIrtualDatabaseID that identifes the Virtual Database the object will be contained.

Method Summary

void	addElementID(ElementID elementID)
void	addElementID(int position, ElementID elementID)
void	addKeyID(KeyID keyID)
void	clearElementIDs()
void	clearKeyIDs()
boolean	containsElementID(ElementID elementID)
boolean	containsKeyID(KeyID keyID)
java.lang.String	getAlias() Return the alias.
java.lang.String	getDeleteQueryPlan() Returns the deleteQueryPlan.
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() Returns the insertQueryPlan.
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	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() Returns the updateQueryPlan.
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	hasDeleteQueryPlan()
boolean	hasInsertQueryPlan()
boolean	hasQueryPlan()
boolean	hasUpdateQueryPlan()
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.
void	removeElementID(ElementID elementID)
void	removeKeyID(KeyID keyID)
void	setAlias(java.lang.String alias)
void	setDeleteAllowed(boolean deleteAllowed) Sets the deleteAllowed.
void	setDeleteQueryPlan(java.lang.String deleteQueryPlan) Sets the deleteQueryPlan.
void	setDescription(java.lang.String description)
void	setElementIDs(java.util.List elements)
void	setHasDeleteQueryPlan(boolean hasDeleteQueryPlan) Sets the hasDeleteQueryPlan.
void	setHasInsertQueryPlan(boolean hasInsertQueryPlan) Sets the hasInsertQueryPlan.
void	setHasQueryPlan(boolean hasQueryPlan)
void	setHasUpdateQueryPlan(boolean hasUpdateQueryPlan) Sets the hasUpdateQueryPlan.
void	setInsertAllowed(boolean insertAllowed) Sets the insertAllowed.
void	setInsertQueryPlan(java.lang.String insertQueryPlan) Sets the insertQueryPlan.
void	setIsPhysical(boolean isPhysical)
void	setIsSystem(boolean isSystem)
void	setKeyIDs(java.util.Collection keys)
void	setMappingDocument(java.lang.String document)
void	setPath(java.lang.String path)
void	setQueryPlan(java.lang.String plan)
void	setSupportsUpdate(boolean sup_UPDATE)
void	setTableType(short type)
void	setUpdateAllowed(boolean updateAllowed) Sets the updateAllowed.
void	setUpdateQueryPlan(java.lang.String updateQueryPlan) Sets the updateQueryPlan.
void	setXMLSchemas(java.util.Collection xmlSchemas)
boolean	supportsUpdate() Return boolean indicating if the model supports UPDATE operations in the sql.
java.lang.String	toString() Returns a string representing the current state of the object.

Methods inherited from class com.metamatrix.metadata.runtime.model.BasicMetadataObject

addProperty, clone, compareTo, equals, getCurrentProperties, getFullName, getID, getName, getNameInSource, getProperties, getVirtualDatabaseID, hashCode, hasNameInSource, setID, setProperties

Methods inherited from class java.lang.Object

finalize, getClass, notify, notifyAll, wait, wait, wait

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

getNameInSource, hasNameInSource

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

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

Constructor Detail

BasicGroup

public BasicGroup(BasicGroupID groupID,
                  BasicVirtualDatabaseID virtualDBID)

Call constructor to instantiate a runtime object by passing the RuntimeID that identifies the entity and the VIrtualDatabaseID that identifes the Virtual Database the object will be contained.

Method Detail

getPath

public java.lang.String getPath()

Description copied from interface: Group

Return the path to the group.

Specified by:

getPath in interface Group

Overrides:

getPath in class BasicMetadataObject

Returns:

String

getDescription

public java.lang.String getDescription()

Description copied from interface: Group

Return the group description.

Specified by:

getDescription in interface Group

Returns:

String

getAlias

public java.lang.String getAlias()

Description copied from interface: Group

Return the alias.

Specified by:

getAlias in interface Group

Overrides:

getAlias in class BasicMetadataObject

Returns:

String alias

setAlias

public void setAlias(java.lang.String alias)

isPhysical

public boolean isPhysical()

Description copied from interface: Group

Return boolean indicating if this a physical model.

Specified by:

isPhysical in interface Group

Returns:

boolean true if is is a physical model

getTableType

public short getTableType()

Specified by:

getTableType in interface Group

Returns:

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

See Also:

MetadataConstants.TABLE_TYPES

getKeyIDs

public java.util.Collection getKeyIDs()

Description copied from interface: Group

Returns the KeyID's identified for this group.

Specified by:

getKeyIDs in interface Group

Returns:

Collection of KeyID's

getElementIDs

public java.util.List getElementIDs()

Description copied from interface: Group

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

Specified by:

getElementIDs in interface Group

Returns:

List of ElementID's

isSystemTable

public boolean isSystemTable()

Specified by:

isSystemTable in interface Group

Returns:

boolean true indicates this is a RuntimeMetadata System table

hasQueryPlan

public boolean hasQueryPlan()

getQueryPlan

public java.lang.String getQueryPlan()

Description copied from interface: Group

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

Specified by:

getQueryPlan in interface Group

Returns:

String

getMappingDocument

public java.lang.String getMappingDocument()

Description copied from interface: Group

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

Specified by:

getMappingDocument in interface Group

Returns:

the mapping document string.

supportsUpdate

public boolean supportsUpdate()

Description copied from interface: Group

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

Specified by:

supportsUpdate in interface Group

Returns:

boolean

isVirtualDocument

public boolean isVirtualDocument()

Description copied from interface: Group

Whether this group represents a virtual document.

Specified by:

isVirtualDocument in interface Group

Returns:

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

getXMLSchemas

public java.util.Collection getXMLSchemas()

Description copied from interface: Group

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

Specified by:

getXMLSchemas in interface Group

Returns:

Collection of String

setPath

public void setPath(java.lang.String path)

setDescription

public void setDescription(java.lang.String description)

setIsPhysical

public void setIsPhysical(boolean isPhysical)

setIsSystem

public void setIsSystem(boolean isSystem)

setQueryPlan

public void setQueryPlan(java.lang.String plan)

setTableType

public void setTableType(short type)

setKeyIDs

public void setKeyIDs(java.util.Collection keys)

clearKeyIDs

public void clearKeyIDs()

setElementIDs

public void setElementIDs(java.util.List elements)

clearElementIDs

public void clearElementIDs()

addKeyID

public void addKeyID(KeyID keyID)

containsKeyID

public boolean containsKeyID(KeyID keyID)

removeKeyID

public void removeKeyID(KeyID keyID)

addElementID

public void addElementID(ElementID elementID)

addElementID

public void addElementID(int position,
                         ElementID elementID)

containsElementID

public boolean containsElementID(ElementID elementID)

removeElementID

public void removeElementID(ElementID elementID)

setHasQueryPlan

public void setHasQueryPlan(boolean hasQueryPlan)

setMappingDocument

public void setMappingDocument(java.lang.String document)

setSupportsUpdate

public void setSupportsUpdate(boolean sup_UPDATE)

setXMLSchemas

public void setXMLSchemas(java.util.Collection xmlSchemas)

getDeleteQueryPlan

public java.lang.String getDeleteQueryPlan()

Returns the deleteQueryPlan.

Specified by:

getDeleteQueryPlan in interface Group

Returns:

String

getInsertQueryPlan

public java.lang.String getInsertQueryPlan()

Returns the insertQueryPlan.

Specified by:

getInsertQueryPlan in interface Group

Returns:

String

getUpdateQueryPlan

public java.lang.String getUpdateQueryPlan()

Returns the updateQueryPlan.

Specified by:

getUpdateQueryPlan in interface Group

Returns:

String

setDeleteQueryPlan

public void setDeleteQueryPlan(java.lang.String deleteQueryPlan)

Sets the deleteQueryPlan.

Parameters:

deleteQueryPlan - The deleteQueryPlan to set

setInsertQueryPlan

public void setInsertQueryPlan(java.lang.String insertQueryPlan)

Sets the insertQueryPlan.

Parameters:

insertQueryPlan - The insertQueryPlan to set

setUpdateQueryPlan

public void setUpdateQueryPlan(java.lang.String updateQueryPlan)

Sets the updateQueryPlan.

Parameters:

updateQueryPlan - The updateQueryPlan to set

setHasDeleteQueryPlan

public void setHasDeleteQueryPlan(boolean hasDeleteQueryPlan)

Sets the hasDeleteQueryPlan.

Parameters:

hasDeleteQueryPlan - The hasDeleteQueryPlan to set

hasDeleteQueryPlan

public boolean hasDeleteQueryPlan()

setHasInsertQueryPlan

public void setHasInsertQueryPlan(boolean hasInsertQueryPlan)

Sets the hasInsertQueryPlan.

Parameters:

hasInsertQueryPlan - The hasInsertQueryPlan to set

hasInsertQueryPlan

public boolean hasInsertQueryPlan()

setHasUpdateQueryPlan

public void setHasUpdateQueryPlan(boolean hasUpdateQueryPlan)

Sets the hasUpdateQueryPlan.

Parameters:

hasUpdateQueryPlan - The hasUpdateQueryPlan to set

hasUpdateQueryPlan

public boolean hasUpdateQueryPlan()

isDeleteAllowed

public boolean isDeleteAllowed()

Returns the deleteAllowed.

Specified by:

isDeleteAllowed in interface Group

Returns:

boolean

isInsertAllowed

public boolean isInsertAllowed()

Returns the insertAllowed.

Specified by:

isInsertAllowed in interface Group

Returns:

boolean

isUpdateAllowed

public boolean isUpdateAllowed()

Returns the updateAllowed.

Specified by:

isUpdateAllowed in interface Group

Returns:

boolean

setDeleteAllowed

public void setDeleteAllowed(boolean deleteAllowed)

Sets the deleteAllowed.

Parameters:

deleteAllowed - The deleteAllowed to set

setInsertAllowed

public void setInsertAllowed(boolean insertAllowed)

Sets the insertAllowed.

Parameters:

insertAllowed - The insertAllowed to set

setUpdateAllowed

public void setUpdateAllowed(boolean updateAllowed)

Sets the updateAllowed.

Parameters:

updateAllowed - The updateAllowed to set

toString

public java.lang.String toString()

Description copied from class: BasicMetadataObject

Returns a string representing the current state of the object.

Specified by:

toString in interface MetadataObject

Overrides:

toString in class BasicMetadataObject

Returns:

the string representation of this instance.