com.metamatrix.metadata.runtime.api
Interface VirtualDatabaseMetadata

All Known Implementing Classes:

BasicVirtualDatabaseMetadata

public interface VirtualDatabaseMetadata

A VirtualDatabaseMetadata represent a virtual database in the repository. It provides a set of methods to retrive the information in the virtual database.

Method Summary

java.util.Collection	getAllModels() Return all models that are defined in the VDB regardless of type or visibility.
java.util.List	getALLPaths(java.util.Collection models)
java.util.Collection	getDisplayableModels() Return the models that are used for presentation purposes.
java.util.List	getElementsInGroup(GroupID groupID) Return an ordered list of ElementID's for the specified groupID.
java.util.Collection	getGroupsInModel(ModelID modelID) Obtain a collection of GroupID's for the specified modelID.
Model	getModel(java.lang.String name) Return model for the specified name
java.util.Collection	getProcedures(ModelID modelID) Obtain a collection of ProcedureID's for the specified modelID.
VirtualDatabase	getVirtualDatabase() Returns the VirtualDatabase for which this metadata object represents.
VirtualDatabaseID	getVirtualDatabaseID() Returns the VirtualDatabaseID that identifies the VirtualDatabaseMetadata.
boolean	isModelDetailsLoaded() Returns true if the metadata for the groups and elements have been loaded.
boolean	isVisible(java.lang.String resourcePath) Returns the visibility for a resource path.

Method Detail

isModelDetailsLoaded

boolean isModelDetailsLoaded()

Returns true if the metadata for the groups and elements have been loaded. The loading of the details are only used when the metadata tree is beind displayed. So to cut down on the overhead when it's never been asked for, the details are not loaded when only the models are needed by query processing.

Returns:

Since:

4.2

getProcedures

java.util.Collection getProcedures(ModelID modelID)
                                   throws VirtualDatabaseException

Obtain a collection of ProcedureID's for the specified modelID.

Parameters:

modelID - is the id for the Model

Returns:

Collection of ProcedureID's

Throws:

VirtualDatabaseException - if an error occurs while trying to read the data.

getDisplayableModels

java.util.Collection getDisplayableModels()
                                          throws VirtualDatabaseException

Return the models that are used for presentation purposes. This means the models indicate they are visible.

Returns:

Throws:

VirtualDatabaseException

Since:

4.2

getAllModels

java.util.Collection getAllModels()
                                  throws VirtualDatabaseException

Return all models that are defined in the VDB regardless of type or visibility.

Returns:

Throws:

VirtualDatabaseException

Since:

4.2

getModel

Model getModel(java.lang.String name)
               throws VirtualDatabaseException

Return model for the specified name

Returns:

Throws:

VirtualDatabaseException

Since:

4.2

isVisible

boolean isVisible(java.lang.String resourcePath)
                  throws VirtualDatabaseException

Returns the visibility for a resource path.

Parameters:

resourcePath -

Returns:

true if the resource is visible.

Throws:

VirtualDatabaseException

Since:

4.2

getElementsInGroup

java.util.List getElementsInGroup(GroupID groupID)
                                  throws VirtualDatabaseException

Return an ordered list of ElementID's for the specified groupID.

Parameters:

groupID - is the group for which the elements are to be obtained.

Returns:

List of Element's.

Throws:

VirtualDatabaseException - if an error occurs while trying to read the data.

getVirtualDatabase

VirtualDatabase getVirtualDatabase()
                                   throws VirtualDatabaseException

Returns the VirtualDatabase for which this metadata object represents.

Returns:

VirtualDatabase

Throws:

VirtualDatabaseException - if an error occurs while trying to read the data.

getVirtualDatabaseID

VirtualDatabaseID getVirtualDatabaseID()

Returns the VirtualDatabaseID that identifies the VirtualDatabaseMetadata.

Returns:

VirtualDatabaseID

getALLPaths

java.util.List getALLPaths(java.util.Collection models)
                           throws VirtualDatabaseException

Throws:

VirtualDatabaseException

getGroupsInModel

java.util.Collection getGroupsInModel(ModelID modelID)
                                      throws VirtualDatabaseException

Obtain a collection of GroupID's for the specified modelID.

Parameters:

modelID - is the id for the Model

Returns:

Collection of ProcedureID's

Throws:

VirtualDatabaseException - if an error occurs while trying to read the data.