|
||||||||||
PREV CLASS NEXT CLASS | FRAMES NO FRAMES | |||||||||
SUMMARY: NESTED | FIELD | CONSTR | METHOD | DETAIL: FIELD | CONSTR | METHOD |
public interface MetadataSourceAPI
The DataAccessAPI is the common interface to access runtime metadata.
Method Summary | |
---|---|
java.util.Collection |
getAllModels()
Returns a Collection of Model s that represents all the models |
java.util.Collection |
getDisplayableModels()
Returns a Collection of type Model that represents all the models
that are considered displayable to the console |
java.util.List |
getElementsInGroup(GroupID groupID)
Returns an ordered List of type Element that are contained within the specified key id. |
java.util.Collection |
getGroupsInModel(ModelID modelID)
|
Model |
getModel(ModelID modelID)
return the specified model |
java.util.Collection |
getModelsForVisibility(boolean isVisible)
Returns a Collection of type Model that represents all the
models that are either visible or not visible |
java.util.Collection |
getProceduresInModel(ModelID modelID)
/** Returns a Collection of type Procedure for the specified model id. |
VirtualDatabase |
getVirtualDatabase()
Returns the VirtualDatabase based on the virtual database id. |
VirtualDatabaseID |
getVirtualDatabaseID()
Returns the VirtualDatabaseID . |
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 that exist this vdb |
Method Detail |
---|
boolean isModelDetailsLoaded()
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.
VirtualDatabase getVirtualDatabase() throws VirtualDatabaseException
VirtualDatabase
based on the virtual database id.
VirtualDatabaseException
- if an error occurs while trying to read the data.VirtualDatabaseID getVirtualDatabaseID() throws VirtualDatabaseDoesNotExistException, VirtualDatabaseException
VirtualDatabaseID
. This method does validate the existance of the virtual database by reading from the persistance storage before creating the id.
VirtualDatabaseDoesNotExistException
- exception if the virtual database does not exist
VirtualDatabaseException
- if an error occurs while trying to read the data.java.util.Collection getAllModels() throws VirtualDatabaseException
Collection
of Model
s that represents all the models
VirtualDatabaseException
- an error occurs while trying to read the data.java.util.Collection getDisplayableModels() throws VirtualDatabaseException
Collection
of type Model
that represents all the models
that are considered displayable to the console
vdbID
- is the VirtualDatabaseID
VirtualDatabaseException
- an error occurs while trying to read the data.boolean isVisible(java.lang.String resourcePath)
resourcePath
-
true
if the resource is visible.java.util.Collection getModelsForVisibility(boolean isVisible) throws VirtualDatabaseException
Collection
of type Model
that represents all the
models that are either visible or not visible
VirtualDatabaseException
- an error occurs while trying to read the data.Model getModel(ModelID modelID) throws VirtualDatabaseException
modelID
- is the unique id for the model
VirtualDatabaseException
- an error occurs while trying to read the data.java.util.List getElementsInGroup(GroupID groupID) throws VirtualDatabaseException
List
of type Element
that are contained within the specified key id.
groupID
- is the group from which the elements are containedvdbID
- is the VirtualDatabaseID
InvalidRuntimeIDException
- if the group does not exist
VirtualDatabaseTransactionException
- an error occurs while trying to read the data.
VirtualDatabaseException
java.util.Collection getProceduresInModel(ModelID modelID) throws VirtualDatabaseException
Collection
of type Procedure
for the specified model id.
modelName
- is the name of the Model
VirtualDatabaseException
- an error occurs while trying to read the data.java.util.Collection getGroupsInModel(ModelID modelID) throws VirtualDatabaseException
VirtualDatabaseException
|
||||||||||
PREV CLASS NEXT CLASS | FRAMES NO FRAMES | |||||||||
SUMMARY: NESTED | FIELD | CONSTR | METHOD | DETAIL: FIELD | CONSTR | METHOD |