org.teiid.query.metadata

Class TransformationMetadata

java.lang.Object

org.teiid.query.metadata.BasicQueryMetadata

org.teiid.query.metadata.TransformationMetadata

All Implemented Interfaces:

Serializable, QueryMetadataInterface

public class TransformationMetadata
extends BasicQueryMetadata
implements Serializable

Teiid's implementation of the QueryMetadataInterface that reads columns, groups, models etc. from the metadata object model.

See Also:

Serialized Form

Field Summary

Fields

Modifier and Type	Field and Description
static String	ALLOWED_LANGUAGES
static char	DELIMITER_CHAR Delimiter character used when specifying fully qualified entity names
static String	DELIMITER_STRING
static Properties	EMPTY_PROPS
static String	NOT_EXISTS_MESSAGE

Fields inherited from interface org.teiid.query.metadata.QueryMetadataInterface

UNKNOWN_CARDINALITY

Constructor Summary

Constructors

Constructor and Description
TransformationMetadata(VDBMetaData vdbMetadata, CompositeMetadataStore store, Map<String,VDBResources.Resource> vdbEntries, FunctionTree systemFunctions, Collection<FunctionTree> functionTrees) TransformationMetadata constructor

Method Summary

Modifier and Type	Method and Description
Object	addToMetadataCache(Object metadataID, String key, Object value)
boolean	elementSupports(Object elementID, int elementConstant) Determine whether the specified element supports some feature.
Collection<KeyRecord>	getAccessPatternsInGroup(Object groupID) Get the access patterns for the specified group
byte[]	getBinaryVDBResource(String resourcePath) Gets the contents of a VDB resource in binary form.
float	getCardinality(Object groupID) Return the cardinality for this group
String	getCharacterVDBResource(String resourcePath) Gets the contents of a VDB resource as a String.
static Column	getColumn(String elementName, Table table, String shortElementName)
Class<?>	getDataTypeClass(String typeOrDomainName) Get the runtime type class for the given type name, which may include domains
String	getDefaultValue(Object elementID) Get the element's default value for an element symbol
String	getDeletePlan(Object groupID) Get procedure defining the delete plan for this group.
TransformationMetadata	getDesignTimeMetadata() Get the metadata without visibility and session tables
float	getDistinctValues(Object elementID) Get the number of distinct values for this column.
Column	getElementID(String elementName) Get the metadata-implementation identifier object for the given element name.
List<Column>	getElementIDsInAccessPattern(Object accessPattern) Get the elements in the access pattern
List<Column>	getElementIDsInGroupID(Object groupID) Get list of metadata element IDs for a group ID
List<Column>	getElementIDsInIndex(Object index) Get the elements in the index
List<Column>	getElementIDsInKey(Object key) Get the elements in the key
int	getElementLength(Object elementID) Get the element length for a given element ID.
String	getElementRuntimeTypeName(Object elementID) Get the element type name for an element symbol.
Properties	getExtensionProperties(Object metadataID) Get all extension properties defined on this metadata object
String	getExtensionProperty(Object metadataID, String key, boolean checkUnqualified)
Collection<ForeignKey>	getForeignKeysInGroup(Object groupID) Get the foreign keys for the specified group
String	getFormat(Object elementID) Get the element's format
Object	getFromMetadataCache(Object metadataID, String key)
String	getFullName(Object metadataID) Get the fully qualified (unique) name of the metadata identifier specified.
FunctionLibrary	getFunctionLibrary()
Table	getGroupID(String groupName) Get the metadata-implementation identifier object for the given group name.
Object	getGroupIDForElementID(Object elementID) Get containg group ID given element ID
Collection<String>	getGroupsForPartialName(String partialGroupName) Get a collection of group names that match the partially qualified group name.
Set<String>	getImportedModels()
Collection<KeyRecord>	getIndexesInGroup(Object groupID) Get the indexes for the specified group
String	getInsertPlan(Object groupID) Get procedure defining the insert plan for this group.
Object	getMaterialization(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.
Object	getMaterializationStage(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.
Object	getMaximumValue(Object elementID) Get the element's default value for an element symbol
int	getMaxSetSize(Object modelID) Get the max set size for the specified model.
CompositeMetadataStore	getMetadataStore()
Object	getMinimumValue(Object elementID) Get the element's minimum value for an element symbol
Object	getModelID(Object groupOrElementID) Get the metadata-implementation identifier object for the model containing the specified group or element ID.
Schema	getModelID(String modelName)
List<Schema>	getModelIDs()
String	getName(Object metadataID) Get the name of the metadata identifier specified.
String	getNameInSource(Object metadataID) Get the name in source of the metadata identifier specified.
String	getNativeType(Object elementID) Get the native type of the element specified.
float	getNullValues(Object elementID) Get the number of distinct values for this column.
Map<String,DataPolicyMetadata>	getPolicies()
int	getPosition(Object elementID) Get the element's position in the group
int	getPrecision(Object elementID) Get the element's precision
Object	getPrimaryKey(Object metadataID)
Object	getPrimaryKeyIDForForeignKeyID(Object foreignKeyID) Get the corresponding primary key ID for the specified foreign key ID
int	getRadix(Object elementID) Get the element's radix
int	getScale(Object elementID) Get the element's scale
ScriptEngine	getScriptEngineDirect(String language)
StoredProcedureInfo	getStoredProcedureInfoForProcedure(String name) Get the the StoredProcedureInfo based on the fully qualified procedure name
Collection<KeyRecord>	getUniqueKeysInGroup(Object groupID) Get the unique keys for the specified group (primary and unique keys) The primary key if present will be first in the collection
String	getUpdatePlan(Object groupID) Get procedure defining the update plan for this group.
VDBMetaData	getVdbMetaData()
BlobImpl	getVDBResourceAsBlob(String resourcePath)
ClobImpl	getVDBResourceAsClob(String resourcePath)
SQLXMLImpl	getVDBResourceAsSQLXML(String resourcePath)
String[]	getVDBResourcePaths() Gets the resource paths of all the resources in the VDB.
String	getVirtualDatabaseName() Get the currently connected virtual database name.
QueryNode	getVirtualPlan(Object groupID) Get virtual plan for a group symbol.
boolean	groupSupports(Object groupID, int groupConstant) Determine whether the specified group supports some feature.
boolean	hasMaterialization(Object groupID) Determine whether given virtual group has an associated Materialization.
boolean	hasProcedure(String name) Return true if a procedure exists with the given name (partial or fqn)
boolean	isEnvAllowed()
boolean	isHiddenResolvable()
boolean	isLongRanks()
boolean	isProcedure(Object groupID) Determine whether this is a procedure
boolean	isVariadic(Object metadataID)
boolean	isVirtualGroup(Object groupID) Determine whether a group is virtual or not.
boolean	isVirtualModel(Object modelID) Determine whether a model is virtual or not.
boolean	modelSupports(Object modelID, int modelConstant) Determine whether the specified model supports some feature.
void	setAllowENV(boolean b)
void	setHiddenResolvable(boolean hiddenResolvable)
void	setLongRanks(boolean longRanks)
void	setUseOutputNames(boolean useOutputNames)
void	setWidenComparisonToString(boolean widenComparisonToString)
boolean	useOutputName()
boolean	widenComparisonToString()

Methods inherited from class org.teiid.query.metadata.BasicQueryMetadata

findShortName, getFunctionBasedExpressions, getModeledBaseType, getModeledPrimitiveType, getModeledType, getScriptEngine, getSessionMetadata, getXMLSchemas, isMultiSource, isMultiSourceElement, isPseudo, isScalarGroup, isTemporaryTable

Methods inherited from class java.lang.Object

clone, equals, finalize, getClass, hashCode, notify, notifyAll, toString, wait, wait, wait

Field Detail

ALLOWED_LANGUAGES

public static final String ALLOWED_LANGUAGES

See Also:

Constant Field Values

DELIMITER_CHAR

public static final char DELIMITER_CHAR

Delimiter character used when specifying fully qualified entity names

See Also:

Constant Field Values

DELIMITER_STRING

public static final String DELIMITER_STRING

NOT_EXISTS_MESSAGE

public static String NOT_EXISTS_MESSAGE

EMPTY_PROPS

public static Properties EMPTY_PROPS

Constructor Detail

TransformationMetadata

public TransformationMetadata(VDBMetaData vdbMetadata,
                              CompositeMetadataStore store,
                              Map<String,VDBResources.Resource> vdbEntries,
                              FunctionTree systemFunctions,
                              Collection<FunctionTree> functionTrees)

TransformationMetadata constructor

Method Detail

getElementID

public Column getElementID(String elementName)
                    throws TeiidComponentException,
                           QueryMetadataException

Description copied from interface: QueryMetadataInterface

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

Specified by:

getElementID in interface QueryMetadataInterface

Overrides:

getElementID in class BasicQueryMetadata

Parameters:

elementName - Fully qualified element name

Returns:

Metadata identifier for this element

Throws:

QueryMetadataException - Metadata implementation detected a problem during the request

TeiidComponentException - Unexpected internal system problem during request

See Also:

QueryMetadataInterface.getElementID(String)

getColumn

public static Column getColumn(String elementName,
                               Table table,
                               String shortElementName)
                        throws QueryMetadataException

Throws:

QueryMetadataException

getGroupID

public Table getGroupID(String groupName)
                 throws TeiidComponentException,
                        QueryMetadataException

Description copied from interface: QueryMetadataInterface

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

Specified by:

getGroupID in interface QueryMetadataInterface

Overrides:

getGroupID in class BasicQueryMetadata

Parameters:

groupName - Fully qualified group name

Returns:

Metadata identifier for this group

Throws:

QueryMetadataException - Metadata implementation detected a problem during the request

TeiidComponentException - Unexpected internal system problem during request

See Also:

QueryMetadataInterface.getGroupID(String)

getGroupsForPartialName

public Collection<String> getGroupsForPartialName(String partialGroupName)
                                           throws TeiidComponentException,
                                                  QueryMetadataException

Description copied from interface: QueryMetadataInterface

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

Specified by:

getGroupsForPartialName in interface QueryMetadataInterface

Overrides:

getGroupsForPartialName in class BasicQueryMetadata

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

TeiidComponentException - Unexpected internal system problem during request

See Also:

QueryMetadataInterface.getGroupID(String)

getModelID

public Object getModelID(Object groupOrElementID)
                  throws TeiidComponentException,
                         QueryMetadataException

Description copied from interface: QueryMetadataInterface

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

Specified by:

getModelID in interface QueryMetadataInterface

Overrides:

getModelID in class BasicQueryMetadata

Parameters:

groupOrElementID - Metadata group or element ID

Returns:

Metadata identifier for the model

Throws:

QueryMetadataException - Metadata implementation detected a problem during the request

TeiidComponentException - Unexpected internal system problem during request

See Also:

QueryMetadataInterface.getModelID(Object)

getFullName

public String getFullName(Object metadataID)
                   throws TeiidComponentException,
                          QueryMetadataException

Description copied from interface: QueryMetadataInterface

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

Specified by:

getFullName in interface QueryMetadataInterface

Overrides:

getFullName in class BasicQueryMetadata

Parameters:

metadataID - Metadata identifier

Returns:

Metadata identifier for this model

Throws:

QueryMetadataException - Metadata implementation detected a problem during the request

TeiidComponentException - Unexpected internal system problem during request

See Also:

QueryMetadataInterface.getFullName(Object)

getName

public String getName(Object metadataID)
               throws TeiidComponentException,
                      QueryMetadataException

Description copied from interface: QueryMetadataInterface

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

Specified by:

getName in interface QueryMetadataInterface

Overrides:

getName in class BasicQueryMetadata

Parameters:

metadataID - Metadata identifier

Returns:

Metadata identifier for this model

Throws:

QueryMetadataException - Metadata implementation detected a problem during the request

TeiidComponentException - Unexpected internal system problem during request

getElementIDsInGroupID

public List<Column> getElementIDsInGroupID(Object groupID)
                                    throws TeiidComponentException,
                                           QueryMetadataException

Description copied from interface: QueryMetadataInterface

Get list of metadata element IDs for a group ID

Specified by:

getElementIDsInGroupID in interface QueryMetadataInterface

Overrides:

getElementIDsInGroupID in class BasicQueryMetadata

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

TeiidComponentException - Unexpected internal system problem during request

See Also:

QueryMetadataInterface.getElementIDsInGroupID(Object)

getGroupIDForElementID

public Object getGroupIDForElementID(Object elementID)
                              throws TeiidComponentException,
                                     QueryMetadataException

Description copied from interface: QueryMetadataInterface

Get containg group ID given element ID

Specified by:

getGroupIDForElementID in interface QueryMetadataInterface

Overrides:

getGroupIDForElementID in class BasicQueryMetadata

Parameters:

elementID - Element ID

Returns:

Group ID containing elementID

Throws:

QueryMetadataException - Metadata implementation detected a problem during the request

TeiidComponentException - Unexpected internal system problem during request

See Also:

QueryMetadataInterface.getGroupIDForElementID(Object)

hasProcedure

public boolean hasProcedure(String name)
                     throws TeiidComponentException

Description copied from interface: QueryMetadataInterface

Return true if a procedure exists with the given name (partial or fqn)

Specified by:

hasProcedure in interface QueryMetadataInterface

Overrides:

hasProcedure in class BasicQueryMetadata

Returns:

Throws:

TeiidComponentException

getStoredProcedureInfoForProcedure

public StoredProcedureInfo getStoredProcedureInfoForProcedure(String name)
                                                       throws TeiidComponentException,
                                                              QueryMetadataException

Description copied from interface: QueryMetadataInterface

Get the the StoredProcedureInfo based on the fully qualified procedure name

Specified by:

getStoredProcedureInfoForProcedure in interface QueryMetadataInterface

Overrides:

getStoredProcedureInfoForProcedure in class BasicQueryMetadata

Parameters:

name - the fully qualified stored procedure name

Returns:

StoredProcedureInfo containing the runtime model id

Throws:

QueryMetadataException - Metadata implementation detected a problem during the request

TeiidComponentException - Unexpected internal system problem during request

See Also:

QueryMetadataInterface.getStoredProcedureInfoForProcedure(String)

getElementRuntimeTypeName

public String getElementRuntimeTypeName(Object elementID)
                                 throws TeiidComponentException,
                                        QueryMetadataException

Description copied from interface: QueryMetadataInterface

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

Specified by:

getElementRuntimeTypeName in interface QueryMetadataInterface

Overrides:

getElementRuntimeTypeName in class BasicQueryMetadata

Returns:

The element data type

Throws:

QueryMetadataException - Metadata implementation detected a problem during the request

TeiidComponentException - Unexpected internal system problem during request

See Also:

QueryMetadataInterface#getElementRuntimeTypeName(ElementSymbol)

getDefaultValue

public String getDefaultValue(Object elementID)
                       throws TeiidComponentException,
                              QueryMetadataException

Description copied from interface: QueryMetadataInterface

Get the element's default value for an element symbol

Specified by:

getDefaultValue in interface QueryMetadataInterface

Overrides:

getDefaultValue in class BasicQueryMetadata

Parameters:

elementID - The element ID

Returns:

The default value of the element

Throws:

QueryMetadataException - Metadata implementation detected a problem during the request

TeiidComponentException - Unexpected internal system problem during request

getMinimumValue

public Object getMinimumValue(Object elementID)
                       throws TeiidComponentException,
                              QueryMetadataException

Description copied from interface: QueryMetadataInterface

Get the element's minimum value for an element symbol

Specified by:

getMinimumValue in interface QueryMetadataInterface

Overrides:

getMinimumValue in class BasicQueryMetadata

Parameters:

elementID - The element ID

Returns:

The minimum value of the element

Throws:

QueryMetadataException - Metadata implementation detected a problem during the request

TeiidComponentException - Unexpected internal system problem during request

getMaximumValue

public Object getMaximumValue(Object elementID)
                       throws TeiidComponentException,
                              QueryMetadataException

Description copied from interface: QueryMetadataInterface

Get the element's default value for an element symbol

Specified by:

getMaximumValue in interface QueryMetadataInterface

Overrides:

getMaximumValue in class BasicQueryMetadata

Parameters:

elementID - The element ID

Returns:

The maximum value of the element

Throws:

QueryMetadataException - Metadata implementation detected a problem during the request

TeiidComponentException - Unexpected internal system problem during request

isVirtualGroup

public boolean isVirtualGroup(Object groupID)
                       throws TeiidComponentException,
                              QueryMetadataException

Description copied from interface: QueryMetadataInterface

Determine whether a group is virtual or not.

Specified by:

isVirtualGroup in interface QueryMetadataInterface

Overrides:

isVirtualGroup in class BasicQueryMetadata

Returns:

True if virtual

Throws:

QueryMetadataException - Metadata implementation detected a problem during the request

TeiidComponentException - Unexpected internal system problem during request

See Also:

QueryMetadataInterface.isVirtualGroup(Object)

isProcedure

public boolean isProcedure(Object groupID)
                    throws TeiidComponentException,
                           QueryMetadataException

Description copied from interface: QueryMetadataInterface

Determine whether this is a procedure

Specified by:

isProcedure in interface QueryMetadataInterface

Overrides:

isProcedure in class BasicQueryMetadata

Parameters:

groupID - Group identifier

Returns:

True if it is an procedure; false otherwise

Throws:

QueryMetadataException - Metadata implementation detected a problem during the request

TeiidComponentException - Unexpected internal system problem during request

isVirtualModel

public boolean isVirtualModel(Object modelID)
                       throws TeiidComponentException,
                              QueryMetadataException

Description copied from interface: QueryMetadataInterface

Determine whether a model is virtual or not.

Specified by:

isVirtualModel in interface QueryMetadataInterface

Overrides:

isVirtualModel in class BasicQueryMetadata

Returns:

True if virtual

Throws:

QueryMetadataException - Metadata implementation detected a problem during the request

TeiidComponentException - Unexpected internal system problem during request

See Also:

QueryMetadataInterface.isVirtualModel(Object)

getVirtualPlan

public QueryNode getVirtualPlan(Object groupID)
                         throws TeiidComponentException,
                                QueryMetadataException

Description copied from interface: QueryMetadataInterface

Get virtual plan for a group symbol.

Specified by:

getVirtualPlan in interface QueryMetadataInterface

Overrides:

getVirtualPlan in class BasicQueryMetadata

Returns:

Root of tree of QueryNode objects

Throws:

TeiidComponentException

QueryMetadataException

See Also:

QueryMetadataInterface#getVirtualPlan(GroupSymbol)

getInsertPlan

public String getInsertPlan(Object groupID)
                     throws TeiidComponentException,
                            QueryMetadataException

Description copied from class: BasicQueryMetadata

Get procedure defining the insert plan for this group.

Specified by:

getInsertPlan in interface QueryMetadataInterface

Overrides:

getInsertPlan in class BasicQueryMetadata

Returns:

A string giving the procedure for inserts.

Throws:

TeiidComponentException

QueryMetadataException

getUpdatePlan

public String getUpdatePlan(Object groupID)
                     throws TeiidComponentException,
                            QueryMetadataException

Description copied from class: BasicQueryMetadata

Get procedure defining the update plan for this group.

Specified by:

getUpdatePlan in interface QueryMetadataInterface

Overrides:

getUpdatePlan in class BasicQueryMetadata

Returns:

A string giving the procedure for inserts.

Throws:

TeiidComponentException

QueryMetadataException

getDeletePlan

public String getDeletePlan(Object groupID)
                     throws TeiidComponentException,
                            QueryMetadataException

Description copied from class: BasicQueryMetadata

Get procedure defining the delete plan for this group.

Specified by:

getDeletePlan in interface QueryMetadataInterface

Overrides:

getDeletePlan in class BasicQueryMetadata

Returns:

A string giving the procedure for inserts.

Throws:

TeiidComponentException

QueryMetadataException

modelSupports

public boolean modelSupports(Object modelID,
                             int modelConstant)
                      throws TeiidComponentException,
                             QueryMetadataException

Description copied from interface: QueryMetadataInterface

Determine whether the specified model supports some feature.

Specified by:

modelSupports in interface QueryMetadataInterface

Overrides:

modelSupports in class BasicQueryMetadata

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

TeiidComponentException - Unexpected internal system problem during request

See Also:

QueryMetadataInterface.modelSupports(Object, int)

groupSupports

public boolean groupSupports(Object groupID,
                             int groupConstant)
                      throws TeiidComponentException,
                             QueryMetadataException

Description copied from interface: QueryMetadataInterface

Determine whether the specified group supports some feature.

Specified by:

groupSupports in interface QueryMetadataInterface

Overrides:

groupSupports in class BasicQueryMetadata

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

TeiidComponentException - Unexpected internal system problem during request

See Also:

QueryMetadataInterface.groupSupports(Object, int)

elementSupports

public boolean elementSupports(Object elementID,
                               int elementConstant)
                        throws TeiidComponentException,
                               QueryMetadataException

Description copied from interface: QueryMetadataInterface

Determine whether the specified element supports some feature.

Specified by:

elementSupports in interface QueryMetadataInterface

Overrides:

elementSupports in class BasicQueryMetadata

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

TeiidComponentException - Unexpected internal system problem during request

See Also:

QueryMetadataInterface.elementSupports(Object, int)

getMaxSetSize

public int getMaxSetSize(Object modelID)
                  throws TeiidComponentException,
                         QueryMetadataException

Description copied from interface: QueryMetadataInterface

Get the max set size for the specified model.

Specified by:

getMaxSetSize in interface QueryMetadataInterface

Overrides:

getMaxSetSize in class BasicQueryMetadata

Parameters:

modelID - Metadata identifier specifying model

Returns:

Maximum set size

Throws:

QueryMetadataException - Metadata implementation detected a problem during the request

TeiidComponentException - Unexpected internal system problem during request

See Also:

QueryMetadataInterface.getMaxSetSize(Object)

getIndexesInGroup

public Collection<KeyRecord> getIndexesInGroup(Object groupID)
                                        throws TeiidComponentException,
                                               QueryMetadataException

Description copied from interface: QueryMetadataInterface

Get the indexes for the specified group

Specified by:

getIndexesInGroup in interface QueryMetadataInterface

Overrides:

getIndexesInGroup in class BasicQueryMetadata

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

TeiidComponentException - Unexpected internal system problem during request

See Also:

QueryMetadataInterface.getIndexesInGroup(java.lang.Object)

getUniqueKeysInGroup

public Collection<KeyRecord> getUniqueKeysInGroup(Object groupID)
                                           throws TeiidComponentException,
                                                  QueryMetadataException

Description copied from interface: QueryMetadataInterface

Get the unique keys for the specified group (primary and unique keys) The primary key if present will be first in the collection

Specified by:

getUniqueKeysInGroup in interface QueryMetadataInterface

Overrides:

getUniqueKeysInGroup in class BasicQueryMetadata

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

TeiidComponentException - Unexpected internal system problem during request

See Also:

QueryMetadataInterface.getUniqueKeysInGroup(Object)

getForeignKeysInGroup

public Collection<ForeignKey> getForeignKeysInGroup(Object groupID)
                                             throws TeiidComponentException,
                                                    QueryMetadataException

Description copied from interface: QueryMetadataInterface

Get the foreign keys for the specified group

Specified by:

getForeignKeysInGroup in interface QueryMetadataInterface

Overrides:

getForeignKeysInGroup in class BasicQueryMetadata

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

TeiidComponentException - Unexpected internal system problem during request

See Also:

QueryMetadataInterface.getForeignKeysInGroup(Object)

getPrimaryKeyIDForForeignKeyID

public Object getPrimaryKeyIDForForeignKeyID(Object foreignKeyID)
                                      throws TeiidComponentException,
                                             QueryMetadataException

Description copied from interface: QueryMetadataInterface

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

Specified by:

getPrimaryKeyIDForForeignKeyID in interface QueryMetadataInterface

Overrides:

getPrimaryKeyIDForForeignKeyID in class BasicQueryMetadata

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

TeiidComponentException - Unexpected internal system problem during request

See Also:

QueryMetadataInterface.getPrimaryKeyIDForForeignKeyID(Object)

getAccessPatternsInGroup

public Collection<KeyRecord> getAccessPatternsInGroup(Object groupID)
                                               throws TeiidComponentException,
                                                      QueryMetadataException

Description copied from interface: QueryMetadataInterface

Get the access patterns for the specified group

Specified by:

getAccessPatternsInGroup in interface QueryMetadataInterface

Overrides:

getAccessPatternsInGroup in class BasicQueryMetadata

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

TeiidComponentException - Unexpected internal system problem during request

See Also:

QueryMetadataInterface.getAccessPatternsInGroup(Object)

getElementIDsInIndex

public List<Column> getElementIDsInIndex(Object index)
                                  throws TeiidComponentException,
                                         QueryMetadataException

Description copied from interface: QueryMetadataInterface

Get the elements in the index

Specified by:

getElementIDsInIndex in interface QueryMetadataInterface

Overrides:

getElementIDsInIndex in class BasicQueryMetadata

Parameters:

index - Index identifier, as returned by QueryMetadataInterface.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

TeiidComponentException - Unexpected internal system problem during request

See Also:

QueryMetadataInterface.getElementIDsInIndex(java.lang.Object)

getElementIDsInKey

public List<Column> getElementIDsInKey(Object key)
                                throws TeiidComponentException,
                                       QueryMetadataException

Description copied from interface: QueryMetadataInterface

Get the elements in the key

Specified by:

getElementIDsInKey in interface QueryMetadataInterface

Overrides:

getElementIDsInKey in class BasicQueryMetadata

Parameters:

key - Key identifier, as returned by QueryMetadataInterface.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

TeiidComponentException - Unexpected internal system problem during request

See Also:

QueryMetadataInterface.getElementIDsInKey(Object)

getElementIDsInAccessPattern

public List<Column> getElementIDsInAccessPattern(Object accessPattern)
                                          throws TeiidComponentException,
                                                 QueryMetadataException

Description copied from interface: QueryMetadataInterface

Get the elements in the access pattern

Specified by:

getElementIDsInAccessPattern in interface QueryMetadataInterface

Overrides:

getElementIDsInAccessPattern in class BasicQueryMetadata

Parameters:

accessPattern - access pattern identifier, as returned by QueryMetadataInterface.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

TeiidComponentException - Unexpected internal system problem during request

See Also:

QueryMetadataInterface.getElementIDsInAccessPattern(Object)

hasMaterialization

public boolean hasMaterialization(Object groupID)
                           throws TeiidComponentException,
                                  QueryMetadataException

Description copied from interface: QueryMetadataInterface

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

Specified by:

hasMaterialization in interface QueryMetadataInterface

Overrides:

hasMaterialization in class BasicQueryMetadata

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

TeiidComponentException - Unexpected internal system problem during request

Since:

4.2

See Also:

QueryMetadataInterface.hasMaterialization(java.lang.Object)

getMaterialization

public Object getMaterialization(Object groupID)
                          throws TeiidComponentException,
                                 QueryMetadataException

Description copied from interface: QueryMetadataInterface

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

Specified by:

getMaterialization in interface QueryMetadataInterface

Overrides:

getMaterialization in class BasicQueryMetadata

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:

TeiidComponentException - Unexpected internal system problem during request

QueryMetadataException - Metadata implementation detected a problem during the request

Since:

4.2

See Also:

QueryMetadataInterface.getMaterialization(java.lang.Object)

getMaterializationStage

public Object getMaterializationStage(Object groupID)
                               throws TeiidComponentException,
                                      QueryMetadataException

Description copied from interface: QueryMetadataInterface

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.

Specified by:

getMaterializationStage in interface QueryMetadataInterface

Overrides:

getMaterializationStage in class BasicQueryMetadata

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:

TeiidComponentException - Unexpected internal system problem during request

QueryMetadataException - Metadata implementation detected a problem during the request

Since:

4.2

See Also:

QueryMetadataInterface.getMaterializationStage(java.lang.Object)

getVirtualDatabaseName

public String getVirtualDatabaseName()
                              throws TeiidComponentException,
                                     QueryMetadataException

Description copied from interface: QueryMetadataInterface

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

Specified by:

getVirtualDatabaseName in interface QueryMetadataInterface

Overrides:

getVirtualDatabaseName in class BasicQueryMetadata

Returns:

Name of current virtual database

Throws:

QueryMetadataException - Metadata implementation detected a problem during the request

TeiidComponentException - Unexpected internal system problem during request

See Also:

QueryMetadataInterface.getVirtualDatabaseName()

getVdbMetaData

public VDBMetaData getVdbMetaData()

getCardinality

public float getCardinality(Object groupID)
                     throws TeiidComponentException,
                            QueryMetadataException

Description copied from interface: QueryMetadataInterface

Return the cardinality for this group

Specified by:

getCardinality in interface QueryMetadataInterface

Overrides:

getCardinality in class BasicQueryMetadata

Parameters:

groupID - Metadata identifier specifying group

Returns:

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

Throws:

TeiidComponentException

QueryMetadataException

getNameInSource

public String getNameInSource(Object metadataID)
                       throws TeiidComponentException,
                              QueryMetadataException

Description copied from interface: QueryMetadataInterface

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

Specified by:

getNameInSource in interface QueryMetadataInterface

Overrides:

getNameInSource in class BasicQueryMetadata

Parameters:

metadataID - Metadata identifier

Returns:

Name in source as a string.

Throws:

QueryMetadataException - Metadata implementation detected a problem during the request

TeiidComponentException - Unexpected internal system problem during request

getElementLength

public int getElementLength(Object elementID)
                     throws TeiidComponentException,
                            QueryMetadataException

Description copied from interface: QueryMetadataInterface

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

Specified by:

getElementLength in interface QueryMetadataInterface

Overrides:

getElementLength in class BasicQueryMetadata

Parameters:

elementID - The element ID

Returns:

The element length

Throws:

QueryMetadataException - Metadata implementation detected a problem during the request

TeiidComponentException - Unexpected internal system problem during request

getPosition

public int getPosition(Object elementID)
                throws TeiidComponentException,
                       QueryMetadataException

Description copied from interface: QueryMetadataInterface

Get the element's position in the group

Specified by:

getPosition in interface QueryMetadataInterface

Overrides:

getPosition in class BasicQueryMetadata

Parameters:

elementID - The element ID

Returns:

The position of the element

Throws:

QueryMetadataException - Metadata implementation detected a problem during the request

TeiidComponentException - Unexpected internal system problem during request

getPrecision

public int getPrecision(Object elementID)
                 throws TeiidComponentException,
                        QueryMetadataException

Description copied from interface: QueryMetadataInterface

Get the element's precision

Specified by:

getPrecision in interface QueryMetadataInterface

Overrides:

getPrecision in class BasicQueryMetadata

Parameters:

elementID - The element ID

Returns:

The precision of the element

Throws:

QueryMetadataException - Metadata implementation detected a problem during the request

TeiidComponentException - Unexpected internal system problem during request

getRadix

public int getRadix(Object elementID)
             throws TeiidComponentException,
                    QueryMetadataException

Description copied from interface: QueryMetadataInterface

Get the element's radix

Specified by:

getRadix in interface QueryMetadataInterface

Overrides:

getRadix in class BasicQueryMetadata

Parameters:

elementID - The element ID

Returns:

The radix of the element

Throws:

QueryMetadataException - Metadata implementation detected a problem during the request

TeiidComponentException - Unexpected internal system problem during request

getFormat

public String getFormat(Object elementID)
                 throws TeiidComponentException,
                        QueryMetadataException

Description copied from interface: QueryMetadataInterface

Get the element's format

Specified by:

getFormat in interface QueryMetadataInterface

Overrides:

getFormat in class BasicQueryMetadata

Parameters:

elementID - The element ID

Returns:

The format of the element

Throws:

QueryMetadataException - Metadata implementation detected a problem during the request

TeiidComponentException - Unexpected internal system problem during request

getScale

public int getScale(Object elementID)
             throws TeiidComponentException,
                    QueryMetadataException

Description copied from interface: QueryMetadataInterface

Get the element's scale

Specified by:

getScale in interface QueryMetadataInterface

Overrides:

getScale in class BasicQueryMetadata

Parameters:

elementID - The element ID

Returns:

The scale of the element

Throws:

QueryMetadataException - Metadata implementation detected a problem during the request

TeiidComponentException - Unexpected internal system problem during request

getDistinctValues

public float getDistinctValues(Object elementID)
                        throws TeiidComponentException,
                               QueryMetadataException

Description copied from interface: QueryMetadataInterface

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

Specified by:

getDistinctValues in interface QueryMetadataInterface

Overrides:

getDistinctValues in class BasicQueryMetadata

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

TeiidComponentException - Unexpected internal system problem during request

See Also:

QueryMetadataInterface.getDistinctValues(java.lang.Object)

getNullValues

public float getNullValues(Object elementID)
                    throws TeiidComponentException,
                           QueryMetadataException

Description copied from interface: QueryMetadataInterface

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

Specified by:

getNullValues in interface QueryMetadataInterface

Overrides:

getNullValues in class BasicQueryMetadata

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

TeiidComponentException - Unexpected internal system problem during request

See Also:

QueryMetadataInterface.getNullValues(java.lang.Object)

getNativeType

public String getNativeType(Object elementID)
                     throws TeiidComponentException,
                            QueryMetadataException

Description copied from interface: QueryMetadataInterface

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

Specified by:

getNativeType in interface QueryMetadataInterface

Overrides:

getNativeType in class BasicQueryMetadata

Parameters:

elementID - Element identifier

Returns:

Native type name

Throws:

QueryMetadataException - Metadata implementation detected a problem during the request

TeiidComponentException - Unexpected internal system problem during request

getExtensionProperties

public Properties getExtensionProperties(Object metadataID)
                                  throws TeiidComponentException,
                                         QueryMetadataException

Description copied from interface: QueryMetadataInterface

Get all extension properties defined on this metadata object

Specified by:

getExtensionProperties in interface QueryMetadataInterface

Overrides:

getExtensionProperties in class BasicQueryMetadata

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

TeiidComponentException - Unexpected internal system problem during request

getExtensionProperty

public String getExtensionProperty(Object metadataID,
                                   String key,
                                   boolean checkUnqualified)

Specified by:

getExtensionProperty in interface QueryMetadataInterface

Overrides:

getExtensionProperty in class BasicQueryMetadata

getBinaryVDBResource

public byte[] getBinaryVDBResource(String resourcePath)
                            throws TeiidComponentException,
                                   QueryMetadataException

Description copied from interface: QueryMetadataInterface

Gets the contents of a VDB resource in binary form.

Specified by:

getBinaryVDBResource in interface QueryMetadataInterface

Overrides:

getBinaryVDBResource in class BasicQueryMetadata

Parameters:

resourcePath - a path returned by getVDBResourcePaths()

Returns:

the binary contents of the resource in a byte[]

Throws:

TeiidComponentException - Unexpected internal system problem during request

QueryMetadataException - Metadata implementation detected a problem during the request

Since:

4.3

See Also:

BasicQueryMetadata.getBinaryVDBResource(java.lang.String)

getVDBResourceAsClob

public ClobImpl getVDBResourceAsClob(String resourcePath)

getVDBResourceAsSQLXML

public SQLXMLImpl getVDBResourceAsSQLXML(String resourcePath)

getVDBResourceAsBlob

public BlobImpl getVDBResourceAsBlob(String resourcePath)

getCharacterVDBResource

public String getCharacterVDBResource(String resourcePath)
                               throws TeiidComponentException,
                                      QueryMetadataException

Description copied from interface: QueryMetadataInterface

Gets the contents of a VDB resource as a String.

Specified by:

getCharacterVDBResource in interface QueryMetadataInterface

Overrides:

getCharacterVDBResource in class BasicQueryMetadata

Parameters:

resourcePath - a path returned by getVDBResourcePaths()

Returns:

the contents of the resource as a String.

Throws:

TeiidComponentException - Unexpected internal system problem during request

QueryMetadataException - Metadata implementation detected a problem during the request

Since:

4.3

See Also:

BasicQueryMetadata.getCharacterVDBResource(java.lang.String)

getMetadataStore

public CompositeMetadataStore getMetadataStore()

getVDBResourcePaths

public String[] getVDBResourcePaths()
                             throws TeiidComponentException,
                                    QueryMetadataException

Description copied from interface: QueryMetadataInterface

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

Specified by:

getVDBResourcePaths in interface QueryMetadataInterface

Overrides:

getVDBResourcePaths in class BasicQueryMetadata

Returns:

an array of resource paths of the resources in the VDB

Throws:

TeiidComponentException - Unexpected internal system problem during request

QueryMetadataException - Metadata implementation detected a problem during the request

Since:

4.3

See Also:

BasicQueryMetadata.getVDBResourcePaths()

addToMetadataCache

public Object addToMetadataCache(Object metadataID,
                                 String key,
                                 Object value)

Specified by:

addToMetadataCache in interface QueryMetadataInterface

Overrides:

addToMetadataCache in class BasicQueryMetadata

getFromMetadataCache

public Object getFromMetadataCache(Object metadataID,
                                   String key)
                            throws TeiidComponentException,
                                   QueryMetadataException

Specified by:

getFromMetadataCache in interface QueryMetadataInterface

Overrides:

getFromMetadataCache in class BasicQueryMetadata

Throws:

TeiidComponentException

QueryMetadataException

getFunctionLibrary

public FunctionLibrary getFunctionLibrary()

Specified by:

getFunctionLibrary in interface QueryMetadataInterface

Overrides:

getFunctionLibrary in class BasicQueryMetadata

getPrimaryKey

public Object getPrimaryKey(Object metadataID)

Specified by:

getPrimaryKey in interface QueryMetadataInterface

Overrides:

getPrimaryKey in class BasicQueryMetadata

getDesignTimeMetadata

public TransformationMetadata getDesignTimeMetadata()

Description copied from interface: QueryMetadataInterface

Get the metadata without visibility and session tables

Specified by:

getDesignTimeMetadata in interface QueryMetadataInterface

Overrides:

getDesignTimeMetadata in class BasicQueryMetadata

Returns:

getImportedModels

public Set<String> getImportedModels()

Specified by:

getImportedModels in interface QueryMetadataInterface

Overrides:

getImportedModels in class BasicQueryMetadata

getScriptEngineDirect

public ScriptEngine getScriptEngineDirect(String language)
                                   throws TeiidProcessingException

Overrides:

getScriptEngineDirect in class BasicQueryMetadata

Returns:

Throws:

TeiidProcessingException

isVariadic

public boolean isVariadic(Object metadataID)

Specified by:

isVariadic in interface QueryMetadataInterface

Overrides:

isVariadic in class BasicQueryMetadata

getModelID

public Schema getModelID(String modelName)
                  throws TeiidComponentException,
                         QueryMetadataException

Specified by:

getModelID in interface QueryMetadataInterface

Overrides:

getModelID in class BasicQueryMetadata

Throws:

TeiidComponentException

QueryMetadataException

getModelIDs

public List<Schema> getModelIDs()

Specified by:

getModelIDs in interface QueryMetadataInterface

Overrides:

getModelIDs in class BasicQueryMetadata

getPolicies

public Map<String,DataPolicyMetadata> getPolicies()

useOutputName

public boolean useOutputName()

Specified by:

useOutputName in interface QueryMetadataInterface

Overrides:

useOutputName in class BasicQueryMetadata

setUseOutputNames

public void setUseOutputNames(boolean useOutputNames)

widenComparisonToString

public boolean widenComparisonToString()

Specified by:

widenComparisonToString in interface QueryMetadataInterface

Overrides:

widenComparisonToString in class BasicQueryMetadata

setWidenComparisonToString

public void setWidenComparisonToString(boolean widenComparisonToString)

isHiddenResolvable

public boolean isHiddenResolvable()

setHiddenResolvable

public void setHiddenResolvable(boolean hiddenResolvable)

getDataTypeClass

public Class<?> getDataTypeClass(String typeOrDomainName)
                          throws QueryMetadataException

Description copied from interface: QueryMetadataInterface

Get the runtime type class for the given type name, which may include domains

Specified by:

getDataTypeClass in interface QueryMetadataInterface

Overrides:

getDataTypeClass in class BasicQueryMetadata

Returns:

Throws:

QueryMetadataException

isEnvAllowed

public boolean isEnvAllowed()

Specified by:

isEnvAllowed in interface QueryMetadataInterface

Overrides:

isEnvAllowed in class BasicQueryMetadata

setAllowENV

public void setAllowENV(boolean b)

isLongRanks

public boolean isLongRanks()

Specified by:

isLongRanks in interface QueryMetadataInterface

Overrides:

isLongRanks in class BasicQueryMetadata

setLongRanks

public void setLongRanks(boolean longRanks)