com.metamatrix.query.metadata
Interface QueryMetadataInterface

All Known Implementing Classes:

BasicQueryMetadata, BasicQueryMetadataWrapper, MetadataConnectorMetadata, ServerRuntimeMetadata, TempMetadataAdapter, TransformationMetadata, TransformationMetadataFacade

public interface QueryMetadataInterface

This interface defines the way that query components access metadata. Any user of a query component will need to implement this interface. Many of these methods take or return things of type "Object". Typically, these objects represent a metadata-implementation-specific metadata ID.

Field Summary

static int

UNKNOWN_CARDINALITY Unknown cardinality.

Method Summary

java.lang.Object	addToMetadataCache(java.lang.Object metadataID, java.lang.String key, java.lang.Object value)
boolean	elementSupports(java.lang.Object elementID, int elementConstant) Determine whether the specified element supports some feature.
java.util.Collection	getAccessPatternsInGroup(java.lang.Object groupID) Get the access patterns for the specified group
byte[]	getBinaryVDBResource(java.lang.String resourcePath) Gets the contents of a VDB resource in binary form.
int	getCardinality(java.lang.Object groupID) Return the cardinality for this group
java.lang.String	getCharacterVDBResource(java.lang.String resourcePath) Gets the contents of a VDB resource as a String.
java.lang.Object	getDefaultValue(java.lang.Object elementID) Get the element's default value for an element symbol
java.lang.String	getDeletePlan(java.lang.Object groupID) Get procedure defining the delete plan for this group.
int	getDistinctValues(java.lang.Object elementID) Get the number of distinct values for this column.
java.lang.Object	getElementID(java.lang.String elementName) Get the metadata-implementation identifier object for the given element name.
java.util.List	getElementIDsInAccessPattern(java.lang.Object accessPattern) Get the elements in the access pattern
java.util.List	getElementIDsInGroupID(java.lang.Object groupID) Get list of metadata element IDs for a group ID
java.util.List	getElementIDsInIndex(java.lang.Object index) Get the elements in the index
java.util.List	getElementIDsInKey(java.lang.Object key) Get the elements in the key
int	getElementLength(java.lang.Object elementID) Get the element length for a given element ID.
java.lang.String	getElementType(java.lang.Object elementID) Get the element type name for an element symbol.
java.util.Properties	getExtensionProperties(java.lang.Object metadataID) Get all extension properties defined on this metadata object
java.util.Collection	getForeignKeysInGroup(java.lang.Object groupID) Get the foreign keys for the specified group
java.lang.String	getFormat(java.lang.Object elementID) Get the element's format
java.lang.Object	getFromMetadataCache(java.lang.Object metadataID, java.lang.String key)
java.lang.String	getFullElementName(java.lang.String fullGroupName, java.lang.String shortElementName) Get the fully qualified (unique) element name given the full group name and the short element name.
java.lang.String	getFullName(java.lang.Object metadataID) Get the fully qualified (unique) name of the metadata identifier specified.
java.lang.Object	getGroupID(java.lang.String groupName) Get the metadata-implementation identifier object for the given group name.
java.lang.Object	getGroupIDForElementID(java.lang.Object elementID) Get containg group ID given element ID
java.lang.String	getGroupName(java.lang.String fullElementName) Get the group name from a fully qualified element name.
java.util.Collection	getGroupsForPartialName(java.lang.String partialGroupName) Get a collection of group names that match the partially qualified group name.
java.util.Collection	getIndexesInGroup(java.lang.Object groupID) Get the indexes for the specified group
java.lang.String	getInsertPlan(java.lang.Object groupID) Get procedure defining the insert plan for this group.
MappingNode	getMappingNode(java.lang.Object groupID) Get the mapping node for the given groupID
java.lang.Object	getMaterialization(java.lang.Object groupID) Accquire the physical group ID (the Materialization) for the given virtual group ID, or null if the given virtual group has no Materialization.
java.lang.Object	getMaterializationStage(java.lang.Object groupID) Accquire the physical group ID that is used for the staging area for loading (the Materialization) for the given virtual group ID, or null if the given virtual group has no Materialization.
java.lang.Object	getMaximumValue(java.lang.Object elementID) Get the element's default value for an element symbol
int	getMaxSetSize(java.lang.Object modelID) Get the max set size for the specified model.
java.lang.Object	getMinimumValue(java.lang.Object elementID) Get the element's minimum value for an element symbol
java.lang.String	getModeledBaseType(java.lang.Object elementID) Get the design-time model base type of the element specified.
java.lang.String	getModeledPrimitiveType(java.lang.Object elementID) Get the design-time model primitive type of the element specified.
java.lang.String	getModeledType(java.lang.Object elementID) Get the design-time model type of the element specified.
java.lang.Object	getModelID(java.lang.Object groupOrElementID) Get the metadata-implementation identifier object for the model containing the specified group or element ID.
java.lang.String	getNameInSource(java.lang.Object metadataID) Get the name in source of the metadata identifier specified.
java.lang.String	getNativeType(java.lang.Object elementID) Get the native type of the element specified.
int	getNullValues(java.lang.Object elementID) Get the number of distinct values for this column.
int	getPosition(java.lang.Object elementID) Get the element's position in the group
int	getPrecision(java.lang.Object elementID) Get the element's precision
java.lang.Object	getPrimaryKeyIDForForeignKeyID(java.lang.Object foreignKeyID) Get the corresponding primary key ID for the specified foreign key ID
int	getRadix(java.lang.Object elementID) Get the element's radix
int	getScale(java.lang.Object elementID) Get the element's scale
java.lang.String	getShortElementName(java.lang.String fullElementName) Get the short (unique only to group) name of an element, given a fully qualified element name.
StoredProcedureInfo	getStoredProcedureInfoForProcedure(java.lang.String fullyQualifiedProcedureName) Get the the StoredProcedureInfo based on the fully qualified procedure name
java.util.Collection	getUniqueKeysInGroup(java.lang.Object groupID) Get the unique keys for the specified group (primary and unique keys)
java.lang.String	getUpdatePlan(java.lang.Object groupID) Get procedure defining the update plan for this group.
java.lang.String[]	getVDBResourcePaths() Gets the resource paths of all the resources in the VDB.
java.lang.String	getVirtualDatabaseName() Get the currently connected virtual database name.
QueryNode	getVirtualPlan(java.lang.Object groupID) Get virtual plan for a group symbol.
java.util.List	getXMLSchemas(java.lang.Object groupID) Get XML schemas for a document group.
java.util.Collection	getXMLTempGroups(java.lang.Object groupID) Return a list of all the temp groups used in this document.
boolean	groupSupports(java.lang.Object groupID, int groupConstant) Determine whether the specified group supports some feature.
boolean	hasMaterialization(java.lang.Object groupID) Determine whether given virtual group has an associated Materialization.
boolean	isProcedure(java.lang.Object groupID) Determine whether this is a procedure
boolean	isScalarGroup(java.lang.Object groupID)
boolean	isTemporaryTable(java.lang.Object groupID) Determine whether a group is a temporary table.
boolean	isVirtualGroup(java.lang.Object groupID) Determine whether a group is virtual or not.
boolean	isVirtualModel(java.lang.Object modelID) Determine whether a model is virtual or not.
boolean	isXMLGroup(java.lang.Object groupID) Determine whether a group is an XML virtual document.
boolean	modelSupports(java.lang.Object modelID, int modelConstant) Determine whether the specified model supports some feature.

Field Detail

UNKNOWN_CARDINALITY

static final int UNKNOWN_CARDINALITY

Unknown cardinality.

See Also:

Constant Field Values

Method Detail

getElementID

java.lang.Object getElementID(java.lang.String elementName)
                              throws MetaMatrixComponentException,
                                     QueryMetadataException

Get the metadata-implementation identifier object for the given element name.

Parameters:

elementName - Fully qualified element name

Returns:

Metadata identifier for this element

Throws:

QueryMetadataException - Metadata implementation detected a problem during the request

MetaMatrixComponentException - Unexpected internal system problem during request

getGroupID

java.lang.Object getGroupID(java.lang.String groupName)
                            throws MetaMatrixComponentException,
                                   QueryMetadataException

Get the metadata-implementation identifier object for the given group name.

Parameters:

groupName - Fully qualified group name

Returns:

Metadata identifier for this group

Throws:

QueryMetadataException - Metadata implementation detected a problem during the request

MetaMatrixComponentException - Unexpected internal system problem during request

getGroupsForPartialName

java.util.Collection getGroupsForPartialName(java.lang.String partialGroupName)
                                             throws MetaMatrixComponentException,
                                                    QueryMetadataException

Get a collection of group names that match the partially qualified group name.

Parameters:

partialGroupName - Partially qualified group name

Returns:

A collection of groups whose names are matched by the partial name.

Throws:

QueryMetadataException - Metadata implementation detected a problem during the request

MetaMatrixComponentException - Unexpected internal system problem during request

getModelID

java.lang.Object getModelID(java.lang.Object groupOrElementID)
                            throws MetaMatrixComponentException,
                                   QueryMetadataException

Get the metadata-implementation identifier object for the model containing the specified group or element ID.

Parameters:

groupOrElementID - Metadata group or element ID

Returns:

Metadata identifier for the model

Throws:

QueryMetadataException - Metadata implementation detected a problem during the request

MetaMatrixComponentException - Unexpected internal system problem during request

getFullName

java.lang.String getFullName(java.lang.Object metadataID)
                             throws MetaMatrixComponentException,
                                    QueryMetadataException

Get the fully qualified (unique) name of the metadata identifier specified. This metadata identifier was previously returned by some other method.

Parameters:

metadataID - Metadata identifier

Returns:

Metadata identifier for this model

Throws:

QueryMetadataException - Metadata implementation detected a problem during the request

MetaMatrixComponentException - Unexpected internal system problem during request

getFullElementName

java.lang.String getFullElementName(java.lang.String fullGroupName,
                                    java.lang.String shortElementName)
                                    throws MetaMatrixComponentException,
                                           QueryMetadataException

Get the fully qualified (unique) element name given the full group name and the short element name.

Parameters:

fullGroupName - Fully qualified group name

shortElementName - Short element name

Returns:

Unique element name for the specified group and element name

Throws:

QueryMetadataException - Metadata implementation detected a problem during the request

MetaMatrixComponentException - Unexpected internal system problem during request

getShortElementName

java.lang.String getShortElementName(java.lang.String fullElementName)
                                     throws MetaMatrixComponentException,
                                            QueryMetadataException

Get the short (unique only to group) name of an element, given a fully qualified element name.

Parameters:

fullElementName - Fully qualified element name

Returns:

Short (unique only to group) name of element

Throws:

QueryMetadataException - Metadata implementation detected a problem during the request

MetaMatrixComponentException - Unexpected internal system problem during request

getGroupName

java.lang.String getGroupName(java.lang.String fullElementName)
                              throws MetaMatrixComponentException,
                                     QueryMetadataException

Get the group name from a fully qualified element name.

Parameters:

fullElementName - Fully qualified element name

Returns:

Group name

Throws:

QueryMetadataException - Metadata implementation detected a problem during the request

MetaMatrixComponentException - Unexpected internal system problem during request

getElementIDsInGroupID

java.util.List getElementIDsInGroupID(java.lang.Object groupID)
                                      throws MetaMatrixComponentException,
                                             QueryMetadataException

Get list of metadata element IDs for a group ID

Parameters:

groupID - Group ID

Returns:

List of Object, where each object is a metadata elementID for element within group

Throws:

QueryMetadataException - Metadata implementation detected a problem during the request

MetaMatrixComponentException - Unexpected internal system problem during request

getGroupIDForElementID

java.lang.Object getGroupIDForElementID(java.lang.Object elementID)
                                        throws MetaMatrixComponentException,
                                               QueryMetadataException

Get containg group ID given element ID

Parameters:

elementID - Element ID

Returns:

Group ID containing elementID

Throws:

QueryMetadataException - Metadata implementation detected a problem during the request

MetaMatrixComponentException - Unexpected internal system problem during request

getStoredProcedureInfoForProcedure

StoredProcedureInfo getStoredProcedureInfoForProcedure(java.lang.String fullyQualifiedProcedureName)
                                                       throws MetaMatrixComponentException,
                                                              QueryMetadataException

Get the the StoredProcedureInfo based on the fully qualified procedure name

Parameters:

fullyQualifiedProcedureName - the fully qualified stored procedure name

Returns:

StoredProcedureInfo containing the runtime model id

Throws:

QueryMetadataException - Metadata implementation detected a problem during the request

MetaMatrixComponentException - Unexpected internal system problem during request

getElementType

java.lang.String getElementType(java.lang.Object elementID)
                                throws MetaMatrixComponentException,
                                       QueryMetadataException

Get the element type name for an element symbol. These types are defined in DataTypeManager.DefaultDataTypes.

Parameters:

symbol - The element symbol

Returns:

The element data type

Throws:

QueryMetadataException - Metadata implementation detected a problem during the request

MetaMatrixComponentException - Unexpected internal system problem during request

getDefaultValue

java.lang.Object getDefaultValue(java.lang.Object elementID)
                                 throws MetaMatrixComponentException,
                                        QueryMetadataException

Get the element's default value for an element symbol

Parameters:

elementID - The element ID

Returns:

The default value of the element

Throws:

QueryMetadataException - Metadata implementation detected a problem during the request

MetaMatrixComponentException - Unexpected internal system problem during request

getMinimumValue

java.lang.Object getMinimumValue(java.lang.Object elementID)
                                 throws MetaMatrixComponentException,
                                        QueryMetadataException

Get the element's minimum value for an element symbol

Parameters:

elementID - The element ID

Returns:

The minimum value of the element

Throws:

QueryMetadataException - Metadata implementation detected a problem during the request

MetaMatrixComponentException - Unexpected internal system problem during request

getMaximumValue

java.lang.Object getMaximumValue(java.lang.Object elementID)
                                 throws MetaMatrixComponentException,
                                        QueryMetadataException

Get the element's default value for an element symbol

Parameters:

elementID - The element ID

Returns:

The maximum value of the element

Throws:

QueryMetadataException - Metadata implementation detected a problem during the request

MetaMatrixComponentException - Unexpected internal system problem during request

getPosition

int getPosition(java.lang.Object elementID)
                throws MetaMatrixComponentException,
                       QueryMetadataException

Get the element's position in the group

Parameters:

elementID - The element ID

Returns:

The position of the element

Throws:

QueryMetadataException - Metadata implementation detected a problem during the request

MetaMatrixComponentException - Unexpected internal system problem during request

getPrecision

int getPrecision(java.lang.Object elementID)
                 throws MetaMatrixComponentException,
                        QueryMetadataException

Get the element's precision

Parameters:

elementID - The element ID

Returns:

The precision of the element

Throws:

QueryMetadataException - Metadata implementation detected a problem during the request

MetaMatrixComponentException - Unexpected internal system problem during request

getScale

int getScale(java.lang.Object elementID)
             throws MetaMatrixComponentException,
                    QueryMetadataException

Get the element's scale

Parameters:

elementID - The element ID

Returns:

The scale of the element

Throws:

QueryMetadataException - Metadata implementation detected a problem during the request

MetaMatrixComponentException - Unexpected internal system problem during request

getRadix

int getRadix(java.lang.Object elementID)
             throws MetaMatrixComponentException,
                    QueryMetadataException

Get the element's radix

Parameters:

elementID - The element ID

Returns:

The radix of the element

Throws:

QueryMetadataException - Metadata implementation detected a problem during the request

MetaMatrixComponentException - Unexpected internal system problem during request

getFormat

java.lang.String getFormat(java.lang.Object elementID)
                           throws MetaMatrixComponentException,
                                  QueryMetadataException

Get the element's format

Parameters:

elementID - The element ID

Returns:

The format of the element

Throws:

QueryMetadataException - Metadata implementation detected a problem during the request

MetaMatrixComponentException - Unexpected internal system problem during request

getDistinctValues

int getDistinctValues(java.lang.Object elementID)
                      throws MetaMatrixComponentException,
                             QueryMetadataException

Get the number of distinct values for this column. Negative values (typically -1) indicate that the NDV is unknown. Only applicable for physical columns.

Parameters:

elementID - The element ID

Returns:

The number of distinct values of this element in the data source

Throws:

QueryMetadataException - Metadata implementation detected a problem during the request

MetaMatrixComponentException - Unexpected internal system problem during request

getNullValues

int getNullValues(java.lang.Object elementID)
                  throws MetaMatrixComponentException,
                         QueryMetadataException

Get the number of distinct values for this column. Negative values (typically -1) indicate that the NDV is unknown. Only applicable for physical columns.

Parameters:

elementID - The element ID

Returns:

The number of distinct values of this element in the data source

Throws:

QueryMetadataException - Metadata implementation detected a problem during the request

MetaMatrixComponentException - Unexpected internal system problem during request

isVirtualGroup

boolean isVirtualGroup(java.lang.Object groupID)
                       throws MetaMatrixComponentException,
                              QueryMetadataException

Determine whether a group is virtual or not.

Parameters:

symbol - Group symbol

Returns:

True if virtual

Throws:

QueryMetadataException - Metadata implementation detected a problem during the request

MetaMatrixComponentException - Unexpected internal system problem during request

isVirtualModel

boolean isVirtualModel(java.lang.Object modelID)
                       throws MetaMatrixComponentException,
                              QueryMetadataException

Determine whether a model is virtual or not.

Parameters:

symbol - model symbol

Returns:

True if virtual

Throws:

QueryMetadataException - Metadata implementation detected a problem during the request

MetaMatrixComponentException - Unexpected internal system problem during request

getVirtualPlan

QueryNode getVirtualPlan(java.lang.Object groupID)
                         throws MetaMatrixComponentException,
                                QueryMetadataException

Get virtual plan for a group symbol.

Parameters:

symbol - Group

Returns:

Root of tree of QueryNode objects

Throws:

MetaMatrixComponentException

QueryMetadataException

getInsertPlan

java.lang.String getInsertPlan(java.lang.Object groupID)
                               throws MetaMatrixComponentException,
                                      QueryMetadataException

Get procedure defining the insert plan for this group.

Parameters:

symbol - Group

Returns:

A string giving the procedure for inserts.

Throws:

MetaMatrixComponentException

QueryMetadataException

getUpdatePlan

java.lang.String getUpdatePlan(java.lang.Object groupID)
                               throws MetaMatrixComponentException,
                                      QueryMetadataException

Get procedure defining the update plan for this group.

Parameters:

symbol - Group

Returns:

A string giving the procedure for inserts.

Throws:

MetaMatrixComponentException

QueryMetadataException

getDeletePlan

java.lang.String getDeletePlan(java.lang.Object groupID)
                               throws MetaMatrixComponentException,
                                      QueryMetadataException

Get procedure defining the delete plan for this group.

Parameters:

symbol - Group

Returns:

A string giving the procedure for inserts.

Throws:

MetaMatrixComponentException

QueryMetadataException

modelSupports

boolean modelSupports(java.lang.Object modelID,
                      int modelConstant)
                      throws MetaMatrixComponentException,
                             QueryMetadataException

Determine whether the specified model supports some feature.

Parameters:

modelID - Metadata identifier specifying the model

modelConstant - Constant from SupportConstants.Model

Returns:

True if model supports feature

Throws:

QueryMetadataException - Metadata implementation detected a problem during the request

MetaMatrixComponentException - Unexpected internal system problem during request

groupSupports

boolean groupSupports(java.lang.Object groupID,
                      int groupConstant)
                      throws MetaMatrixComponentException,
                             QueryMetadataException

Determine whether the specified group supports some feature.

Parameters:

groupID - Group metadata ID

groupConstant - Constant from SupportConstants.Group

Returns:

True if group supports feature

Throws:

QueryMetadataException - Metadata implementation detected a problem during the request

MetaMatrixComponentException - Unexpected internal system problem during request

elementSupports

boolean elementSupports(java.lang.Object elementID,
                        int elementConstant)
                        throws MetaMatrixComponentException,
                               QueryMetadataException

Determine whether the specified element supports some feature.

Parameters:

elementID - Element metadata ID

elementConstant - Constant from SupportConstants.Element

Returns:

True if element supports feature

Throws:

QueryMetadataException - Metadata implementation detected a problem during the request

MetaMatrixComponentException - Unexpected internal system problem during request

getExtensionProperties

java.util.Properties getExtensionProperties(java.lang.Object metadataID)
                                            throws MetaMatrixComponentException,
                                                   QueryMetadataException

Get all extension properties defined on this metadata object

Parameters:

metadataID - Typically element, group, model, or procedure

Returns:

All extension properties for this object or null for none

Throws:

QueryMetadataException - Metadata implementation detected a problem during the request

MetaMatrixComponentException - Unexpected internal system problem during request

getMaxSetSize

int getMaxSetSize(java.lang.Object modelID)
                  throws MetaMatrixComponentException,
                         QueryMetadataException

Get the max set size for the specified model.

Parameters:

modelID - Metadata identifier specifying model

Returns:

Maximum set size

Throws:

QueryMetadataException - Metadata implementation detected a problem during the request

MetaMatrixComponentException - Unexpected internal system problem during request

getIndexesInGroup

java.util.Collection getIndexesInGroup(java.lang.Object groupID)
                                       throws MetaMatrixComponentException,
                                              QueryMetadataException

Get the indexes for the specified group

Parameters:

groupID - Metadata identifier specifying group

Returns:

Collection of Object (never null), each object representing an index

Throws:

QueryMetadataException - Metadata implementation detected a problem during the request

MetaMatrixComponentException - Unexpected internal system problem during request

getUniqueKeysInGroup

java.util.Collection getUniqueKeysInGroup(java.lang.Object groupID)
                                          throws MetaMatrixComponentException,
                                                 QueryMetadataException

Get the unique keys for the specified group (primary and unique keys)

Parameters:

groupID - Metadata identifier specifying group

Returns:

Collection of Object (never null), each object representing a unique key

Throws:

QueryMetadataException - Metadata implementation detected a problem during the request

MetaMatrixComponentException - Unexpected internal system problem during request

getForeignKeysInGroup

java.util.Collection getForeignKeysInGroup(java.lang.Object groupID)
                                           throws MetaMatrixComponentException,
                                                  QueryMetadataException

Get the foreign keys for the specified group

Parameters:

groupID - Metadata identifier specifying group

Returns:

Collection of Object (never null), each object representing a key

Throws:

QueryMetadataException - Metadata implementation detected a problem during the request

MetaMatrixComponentException - Unexpected internal system problem during request

getPrimaryKeyIDForForeignKeyID

java.lang.Object getPrimaryKeyIDForForeignKeyID(java.lang.Object foreignKeyID)
                                                throws MetaMatrixComponentException,
                                                       QueryMetadataException

Get the corresponding primary key ID for the specified foreign key ID

Parameters:

foreignKeyID - Metadata identifier of a foreign key

Returns:

Metadata ID of the corresponding primary key

Throws:

QueryMetadataException - Metadata implementation detected a problem during the request

MetaMatrixComponentException - Unexpected internal system problem during request

getAccessPatternsInGroup

java.util.Collection getAccessPatternsInGroup(java.lang.Object groupID)
                                              throws MetaMatrixComponentException,
                                                     QueryMetadataException

Get the access patterns for the specified group

Parameters:

groupID - Metadata identifier specifying group

Returns:

Collection of Object (never null), each object representing an access pattern

Throws:

QueryMetadataException - Metadata implementation detected a problem during the request

MetaMatrixComponentException - Unexpected internal system problem during request

getElementIDsInIndex

java.util.List getElementIDsInIndex(java.lang.Object index)
                                    throws MetaMatrixComponentException,
                                           QueryMetadataException

Get the elements in the index

Parameters:

index - Index identifier, as returned by getIndexesInGroup(java.lang.Object)

Returns:

List of Object, where each object is a metadata element identifier

Throws:

QueryMetadataException - Metadata implementation detected a problem during the request

MetaMatrixComponentException - Unexpected internal system problem during request

getElementIDsInKey

java.util.List getElementIDsInKey(java.lang.Object key)
                                  throws MetaMatrixComponentException,
                                         QueryMetadataException

Get the elements in the key

Parameters:

key - Key identifier, as returned by getUniqueKeysInGroup(java.lang.Object)

Returns:

List of Object, where each object is a metadata element identifier

Throws:

QueryMetadataException - Metadata implementation detected a problem during the request

MetaMatrixComponentException - Unexpected internal system problem during request

getElementIDsInAccessPattern

java.util.List getElementIDsInAccessPattern(java.lang.Object accessPattern)
                                            throws MetaMatrixComponentException,
                                                   QueryMetadataException

Get the elements in the access pattern

Parameters:

accessPattern - access pattern identifier, as returned by getAccessPatternsInGroup(java.lang.Object)

Returns:

List of Object, where each object is a metadata element identifier

Throws:

QueryMetadataException - Metadata implementation detected a problem during the request

MetaMatrixComponentException - Unexpected internal system problem during request

isXMLGroup

boolean isXMLGroup(java.lang.Object groupID)
                   throws MetaMatrixComponentException,
                          QueryMetadataException

Determine whether a group is an XML virtual document.

Parameters:

groupID - Group to check

Returns:

True if group is an XML virtual document

Throws:

MetaMatrixComponentException

QueryMetadataException

getMappingNode

MappingNode getMappingNode(java.lang.Object groupID)
                           throws MetaMatrixComponentException,
                                  QueryMetadataException

Get the mapping node for the given groupID

Parameters:

groupID - Metadata group ID

Returns:

A MappingNode defining the group

Throws:

QueryMetadataException - Metadata implementation detected a problem during the request

MetaMatrixComponentException - Unexpected internal system problem during request

getVirtualDatabaseName

java.lang.String getVirtualDatabaseName()
                                        throws MetaMatrixComponentException,
                                               QueryMetadataException

Get the currently connected virtual database name. If the current metadata is not virtual-database specific, then null should be returned.

Returns:

Name of current virtual database

Throws:

QueryMetadataException - Metadata implementation detected a problem during the request

MetaMatrixComponentException - Unexpected internal system problem during request

getXMLTempGroups

java.util.Collection getXMLTempGroups(java.lang.Object groupID)
                                      throws MetaMatrixComponentException,
                                             QueryMetadataException

Return a list of all the temp groups used in this document.

Parameters:

groupID - XML virtual document groupID

Returns:

List of all the temp groups used in this document.

Throws:

MetaMatrixComponentException

QueryMetadataException

getCardinality

int getCardinality(java.lang.Object groupID)
                   throws MetaMatrixComponentException,
                          QueryMetadataException

Return the cardinality for this group

Parameters:

groupID - Metadata identifier specifying group

Returns:

cardinality for the given group. If unknown, return UNKNOWN_CARDINALITY.

Throws:

MetaMatrixComponentException

QueryMetadataException

getXMLSchemas

java.util.List getXMLSchemas(java.lang.Object groupID)
                             throws MetaMatrixComponentException,
                                    QueryMetadataException

Get XML schemas for a document group.

Parameters:

groupID - Document group ID

Returns:

List of String where each string is an XML schema for the document

Throws:

MetaMatrixComponentException

QueryMetadataException

getNameInSource

java.lang.String getNameInSource(java.lang.Object metadataID)
                                 throws MetaMatrixComponentException,
                                        QueryMetadataException

Get the name in source of the metadata identifier specified. This metadata identifier was previously returned by some other method.

Parameters:

metadataID - Metadata identifier

Returns:

Name in source as a string.

Throws:

QueryMetadataException - Metadata implementation detected a problem during the request

MetaMatrixComponentException - Unexpected internal system problem during request

getElementLength

int getElementLength(java.lang.Object elementID)
                     throws MetaMatrixComponentException,
                            QueryMetadataException

Get the element length for a given element ID. These types are defined in DataTypeManager.DefaultDataTypes.

Parameters:

elementID - The element ID

Returns:

The element length

Throws:

QueryMetadataException - Metadata implementation detected a problem during the request

MetaMatrixComponentException - Unexpected internal system problem during request

hasMaterialization

boolean hasMaterialization(java.lang.Object groupID)
                           throws MetaMatrixComponentException,
                                  QueryMetadataException

Determine whether given virtual group has an associated Materialization. A Materialization is a cached version of the representation of a virtual group.

Parameters:

groupID - the groupID of the virtual group in question.

Returns:

True if given virtual group has been marked as having a Materialization.

Throws:

QueryMetadataException - Metadata implementation detected a problem during the request

MetaMatrixComponentException - Unexpected internal system problem during request

Since:

4.2

getMaterialization

java.lang.Object getMaterialization(java.lang.Object groupID)
                                    throws MetaMatrixComponentException,
                                           QueryMetadataException

Accquire the physical group ID (the Materialization) for the given virtual group ID, or null if the given virtual group has no Materialization.

Parameters:

groupID - the groupID of a virtual group that has a Materialization.

Returns:

The groupID of the physical group that is a Materialization of the given virtual group.

Throws:

MetaMatrixComponentException - Unexpected internal system problem during request

QueryMetadataException - Metadata implementation detected a problem during the request

Since:

4.2

getMaterializationStage

java.lang.Object getMaterializationStage(java.lang.Object groupID)
                                         throws MetaMatrixComponentException,
                                                QueryMetadataException

Accquire the physical group ID that is used for the staging area for loading (the Materialization) for the given virtual group ID, or null if the given virtual group has no Materialization.

Parameters:

groupID - the groupID of a virtual group that has a Materialization.

Returns:

The groupID of the physical group that is the staging table for loading the Materialization of the given virtual group.

Throws:

MetaMatrixComponentException - Unexpected internal system problem during request

QueryMetadataException - Metadata implementation detected a problem during the request

Since:

4.2

getNativeType

java.lang.String getNativeType(java.lang.Object elementID)
                               throws MetaMatrixComponentException,
                                      QueryMetadataException

Get the native type of the element specified. This element identifier was previously returned by some other method.

Parameters:

elementID - Element identifier

Returns:

Native type name

Throws:

QueryMetadataException - Metadata implementation detected a problem during the request

MetaMatrixComponentException - Unexpected internal system problem during request

Since:

4.2

getModeledType

java.lang.String getModeledType(java.lang.Object elementID)
                                throws MetaMatrixComponentException,
                                       QueryMetadataException

Get the design-time model type of the element specified. This element identifier was previously returned by some other method.

Parameters:

elementID - Element identifier

Returns:

Modeled type name

Throws:

QueryMetadataException - Metadata implementation detected a problem during the request

MetaMatrixComponentException - Unexpected internal system problem during request

Since:

5.0

getModeledBaseType

java.lang.String getModeledBaseType(java.lang.Object elementID)
                                    throws MetaMatrixComponentException,
                                           QueryMetadataException

Get the design-time model base type of the element specified. This element identifier was previously returned by some other method.

Parameters:

elementID - Element identifier

Returns:

Modeled base type name

Throws:

QueryMetadataException - Metadata implementation detected a problem during the request

MetaMatrixComponentException - Unexpected internal system problem during request

Since:

5.0

getModeledPrimitiveType

java.lang.String getModeledPrimitiveType(java.lang.Object elementID)
                                         throws MetaMatrixComponentException,
                                                QueryMetadataException

Get the design-time model primitive type of the element specified. This element identifier was previously returned by some other method.

Parameters:

elementID - Element identifier

Returns:

Modeled primitive type name

Throws:

QueryMetadataException - Metadata implementation detected a problem during the request

MetaMatrixComponentException - Unexpected internal system problem during request

Since:

5.0

isProcedure

boolean isProcedure(java.lang.Object groupID)
                    throws MetaMatrixComponentException,
                           QueryMetadataException

Determine whether this is a procedure

Parameters:

groupID - Group identifier

Returns:

True if it is an procedure; false otherwise

Throws:

QueryMetadataException - Metadata implementation detected a problem during the request

MetaMatrixComponentException - Unexpected internal system problem during request

getVDBResourcePaths

java.lang.String[] getVDBResourcePaths()
                                       throws MetaMatrixComponentException,
                                              QueryMetadataException

Gets the resource paths of all the resources in the VDB.

Returns:

an array of resource paths of the resources in the VDB

Throws:

MetaMatrixComponentException - Unexpected internal system problem during request

QueryMetadataException - Metadata implementation detected a problem during the request

Since:

4.3

getCharacterVDBResource

java.lang.String getCharacterVDBResource(java.lang.String resourcePath)
                                         throws MetaMatrixComponentException,
                                                QueryMetadataException

Gets the contents of a VDB resource as a String.

Parameters:

resourcePath - a path returned by getVDBResourcePaths()

Returns:

the contents of the resource as a String.

Throws:

MetaMatrixComponentException - Unexpected internal system problem during request

QueryMetadataException - Metadata implementation detected a problem during the request

Since:

4.3

getBinaryVDBResource

byte[] getBinaryVDBResource(java.lang.String resourcePath)
                            throws MetaMatrixComponentException,
                                   QueryMetadataException

Gets the contents of a VDB resource in binary form.

Parameters:

resourcePath - a path returned by getVDBResourcePaths()

Returns:

the binary contents of the resource in a byte[]

Throws:

MetaMatrixComponentException - Unexpected internal system problem during request

QueryMetadataException - Metadata implementation detected a problem during the request

Since:

4.3

isTemporaryTable

boolean isTemporaryTable(java.lang.Object groupID)
                         throws MetaMatrixComponentException,
                                QueryMetadataException

Determine whether a group is a temporary table.

Parameters:

groupID - Group to check

Returns:

True if group is a temporary group

Throws:

MetaMatrixComponentException

QueryMetadataException

addToMetadataCache

java.lang.Object addToMetadataCache(java.lang.Object metadataID,
                                    java.lang.String key,
                                    java.lang.Object value)
                                    throws MetaMatrixComponentException,
                                           QueryMetadataException

Throws:

MetaMatrixComponentException

QueryMetadataException

getFromMetadataCache

java.lang.Object getFromMetadataCache(java.lang.Object metadataID,
                                      java.lang.String key)
                                      throws MetaMatrixComponentException,
                                             QueryMetadataException

Throws:

MetaMatrixComponentException

QueryMetadataException

isScalarGroup

boolean isScalarGroup(java.lang.Object groupID)
                      throws MetaMatrixComponentException,
                             QueryMetadataException

Throws:

MetaMatrixComponentException

QueryMetadataException