Package org.teiid.query.metadata

Interface QueryMetadataInterface

All Known Implementing Classes:

BasicQueryMetadata, BasicQueryMetadataWrapper, MultiSourceMetadataWrapper, TempMetadataAdapter, TransformationMetadata

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

Fields

Modifier and Type	Field	Description
static int	UNKNOWN_CARDINALITY	Unknown cardinality.

Method Summary

Modifier and Type	Method	Description
Object	addToMetadataCache(Object metadataID, String key, Object value)
boolean	elementSupports(Object elementID, int elementConstant)	Determine whether the specified element supports some feature.
boolean	findShortName()
Collection	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.
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.
QueryMetadataInterface	getDesignTimeMetadata()	Get the metadata without visibility and session tables
float	getDistinctValues(Object elementID)	Get the number of distinct values for this column.
Object	getElementID(String elementName)	Get the metadata-implementation identifier object for the given element name.
List	getElementIDsInAccessPattern(Object accessPattern)	Get the elements in the access pattern
List	getElementIDsInGroupID(Object groupID)	Get list of metadata element IDs for a group ID
List	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	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.
Map<Expression,Integer>	getFunctionBasedExpressions(Object metadataID)
FunctionLibrary	getFunctionLibrary()
Object	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	getGroupsForPartialName(String partialGroupName)	Get a collection of group names that match the partially qualified group name.
Set<String>	getImportedModels()
Collection	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.
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.
Object	getModelID(String modelName)
List<? extends Object>	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.
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
FunctionMethod	getPushdownFunction(Object modelID, String fullName)
int	getRadix(Object elementID)	Get the element's radix
int	getScale(Object elementID)	Get the element's scale
ScriptEngine	getScriptEngine(String langauge)
QueryMetadataInterface	getSessionMetadata()
StoredProcedureInfo	getStoredProcedureInfoForProcedure(String fullyQualifiedProcedureName)	Get the the StoredProcedureInfo based on the fully qualified procedure name
Collection	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.
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	isLongRanks()
boolean	isMultiSource(Object modelId)
boolean	isMultiSourceElement(Object elementId)
boolean	isProcedure(Object groupID)	Determine whether this is a procedure
boolean	isPseudo(Object elementId)
boolean	isScalarGroup(Object groupID)
boolean	isTemporaryTable(Object groupID)	Determine whether a group is a temporary table.
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.
boolean	useOutputName()
boolean	widenComparisonToString()

Field Detail

UNKNOWN_CARDINALITY

static final int UNKNOWN_CARDINALITY

Unknown cardinality.

See Also:

Constant Field Values

Method Detail

getElementID

Object getElementID(String elementName)
             throws TeiidComponentException,
                    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

TeiidComponentException - Unexpected internal system problem during request

getGroupID

Object getGroupID(String groupName)
           throws TeiidComponentException,
                  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

TeiidComponentException - Unexpected internal system problem during request

getModelID

Object getModelID(String modelName)
           throws TeiidComponentException,
                  QueryMetadataException

Throws:

TeiidComponentException

QueryMetadataException

getGroupsForPartialName

Collection getGroupsForPartialName(String partialGroupName)
                            throws TeiidComponentException,
                                   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

TeiidComponentException - Unexpected internal system problem during request

getModelID

Object getModelID(Object groupOrElementID)
           throws TeiidComponentException,
                  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

TeiidComponentException - Unexpected internal system problem during request

getFullName

String getFullName(Object metadataID)
            throws TeiidComponentException,
                   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

TeiidComponentException - Unexpected internal system problem during request

getName

String getName(Object metadataID)
        throws TeiidComponentException,
               QueryMetadataException

Get the 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

TeiidComponentException - Unexpected internal system problem during request

getElementIDsInGroupID

List getElementIDsInGroupID(Object groupID)
                     throws TeiidComponentException,
                            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

TeiidComponentException - Unexpected internal system problem during request

getGroupIDForElementID

Object getGroupIDForElementID(Object elementID)
                       throws TeiidComponentException,
                              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

TeiidComponentException - Unexpected internal system problem during request

getStoredProcedureInfoForProcedure

StoredProcedureInfo getStoredProcedureInfoForProcedure(String fullyQualifiedProcedureName)
                                                throws TeiidComponentException,
                                                       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

TeiidComponentException - Unexpected internal system problem during request

getElementRuntimeTypeName

String getElementRuntimeTypeName(Object elementID)
                          throws TeiidComponentException,
                                 QueryMetadataException

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

Parameters:

elementID - The element symbol

Returns:

The element data type

Throws:

QueryMetadataException - Metadata implementation detected a problem during the request

TeiidComponentException - Unexpected internal system problem during request

getDefaultValue

String getDefaultValue(Object elementID)
                throws TeiidComponentException,
                       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

TeiidComponentException - Unexpected internal system problem during request

getMinimumValue

Object getMinimumValue(Object elementID)
                throws TeiidComponentException,
                       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

TeiidComponentException - Unexpected internal system problem during request

getMaximumValue

Object getMaximumValue(Object elementID)
                throws TeiidComponentException,
                       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

TeiidComponentException - Unexpected internal system problem during request

getPosition

int getPosition(Object elementID)
         throws TeiidComponentException,
                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

TeiidComponentException - Unexpected internal system problem during request

getPrecision

int getPrecision(Object elementID)
          throws TeiidComponentException,
                 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

TeiidComponentException - Unexpected internal system problem during request

getScale

int getScale(Object elementID)
      throws TeiidComponentException,
             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

TeiidComponentException - Unexpected internal system problem during request

getRadix

int getRadix(Object elementID)
      throws TeiidComponentException,
             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

TeiidComponentException - Unexpected internal system problem during request

getFormat

String getFormat(Object elementID)
          throws TeiidComponentException,
                 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

TeiidComponentException - Unexpected internal system problem during request

getDistinctValues

float getDistinctValues(Object elementID)
                 throws TeiidComponentException,
                        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

TeiidComponentException - Unexpected internal system problem during request

getNullValues

float getNullValues(Object elementID)
             throws TeiidComponentException,
                    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

TeiidComponentException - Unexpected internal system problem during request

isVirtualGroup

boolean isVirtualGroup(Object groupID)
                throws TeiidComponentException,
                       QueryMetadataException

Determine whether a group is virtual or not.

Parameters:

groupID - Group symbol

Returns:

True if virtual

Throws:

QueryMetadataException - Metadata implementation detected a problem during the request

TeiidComponentException - Unexpected internal system problem during request

isVirtualModel

boolean isVirtualModel(Object modelID)
                throws TeiidComponentException,
                       QueryMetadataException

Determine whether a model is virtual or not.

Parameters:

modelID - model symbol

Returns:

True if virtual

Throws:

QueryMetadataException - Metadata implementation detected a problem during the request

TeiidComponentException - Unexpected internal system problem during request

getVirtualPlan

QueryNode getVirtualPlan(Object groupID)
                  throws TeiidComponentException,
                         QueryMetadataException

Get virtual plan for a group symbol.

Parameters:

groupID - Group

Returns:

Root of tree of QueryNode objects

Throws:

TeiidComponentException

QueryMetadataException

getInsertPlan

String getInsertPlan(Object groupID)
              throws TeiidComponentException,
                     QueryMetadataException

Get procedure defining the insert plan for this group.

Parameters:

groupID - Group

Returns:

A string giving the procedure for inserts.

Throws:

TeiidComponentException

QueryMetadataException

getUpdatePlan

String getUpdatePlan(Object groupID)
              throws TeiidComponentException,
                     QueryMetadataException

Get procedure defining the update plan for this group.

Parameters:

groupID - Group

Returns:

A string giving the procedure for inserts.

Throws:

TeiidComponentException

QueryMetadataException

getDeletePlan

String getDeletePlan(Object groupID)
              throws TeiidComponentException,
                     QueryMetadataException

Get procedure defining the delete plan for this group.

Parameters:

groupID - Group

Returns:

A string giving the procedure for inserts.

Throws:

TeiidComponentException

QueryMetadataException

modelSupports

boolean modelSupports(Object modelID,
                      int modelConstant)
               throws TeiidComponentException,
                      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

TeiidComponentException - Unexpected internal system problem during request

groupSupports

boolean groupSupports(Object groupID,
                      int groupConstant)
               throws TeiidComponentException,
                      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

TeiidComponentException - Unexpected internal system problem during request

elementSupports

boolean elementSupports(Object elementID,
                        int elementConstant)
                 throws TeiidComponentException,
                        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

TeiidComponentException - Unexpected internal system problem during request

getExtensionProperties

Properties getExtensionProperties(Object metadataID)
                           throws TeiidComponentException,
                                  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

TeiidComponentException - Unexpected internal system problem during request

getMaxSetSize

int getMaxSetSize(Object modelID)
           throws TeiidComponentException,
                  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

TeiidComponentException - Unexpected internal system problem during request

getIndexesInGroup

Collection getIndexesInGroup(Object groupID)
                      throws TeiidComponentException,
                             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

TeiidComponentException - Unexpected internal system problem during request

getUniqueKeysInGroup

Collection getUniqueKeysInGroup(Object groupID)
                         throws TeiidComponentException,
                                QueryMetadataException

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

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

getForeignKeysInGroup

Collection getForeignKeysInGroup(Object groupID)
                          throws TeiidComponentException,
                                 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

TeiidComponentException - Unexpected internal system problem during request

getPrimaryKeyIDForForeignKeyID

Object getPrimaryKeyIDForForeignKeyID(Object foreignKeyID)
                               throws TeiidComponentException,
                                      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

TeiidComponentException - Unexpected internal system problem during request

getAccessPatternsInGroup

Collection getAccessPatternsInGroup(Object groupID)
                             throws TeiidComponentException,
                                    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

TeiidComponentException - Unexpected internal system problem during request

getElementIDsInKey

List getElementIDsInKey(Object key)
                 throws TeiidComponentException,
                        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

TeiidComponentException - Unexpected internal system problem during request

getElementIDsInAccessPattern

List getElementIDsInAccessPattern(Object accessPattern)
                           throws TeiidComponentException,
                                  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

TeiidComponentException - Unexpected internal system problem during request

getVirtualDatabaseName

String getVirtualDatabaseName()
                       throws TeiidComponentException,
                              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

TeiidComponentException - Unexpected internal system problem during request

getCardinality

float getCardinality(Object groupID)
              throws TeiidComponentException,
                     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:

TeiidComponentException

QueryMetadataException

getNameInSource

String getNameInSource(Object metadataID)
                throws TeiidComponentException,
                       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

TeiidComponentException - Unexpected internal system problem during request

getElementLength

int getElementLength(Object elementID)
              throws TeiidComponentException,
                     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

TeiidComponentException - Unexpected internal system problem during request

hasMaterialization

boolean hasMaterialization(Object groupID)
                    throws TeiidComponentException,
                           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

TeiidComponentException - Unexpected internal system problem during request

Since:

4.2

getMaterialization

Object getMaterialization(Object groupID)
                   throws TeiidComponentException,
                          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:

TeiidComponentException - Unexpected internal system problem during request

QueryMetadataException - Metadata implementation detected a problem during the request

Since:

4.2

getMaterializationStage

Object getMaterializationStage(Object groupID)
                        throws TeiidComponentException,
                               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:

TeiidComponentException - Unexpected internal system problem during request

QueryMetadataException - Metadata implementation detected a problem during the request

Since:

4.2

getNativeType

String getNativeType(Object elementID)
              throws TeiidComponentException,
                     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

TeiidComponentException - Unexpected internal system problem during request

Since:

4.2

isProcedure

boolean isProcedure(Object groupID)
             throws TeiidComponentException,
                    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

TeiidComponentException - Unexpected internal system problem during request

getVDBResourcePaths

String[] getVDBResourcePaths()
                      throws TeiidComponentException,
                             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:

TeiidComponentException - Unexpected internal system problem during request

QueryMetadataException - Metadata implementation detected a problem during the request

Since:

4.3

getCharacterVDBResource

String getCharacterVDBResource(String resourcePath)
                        throws TeiidComponentException,
                               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:

TeiidComponentException - Unexpected internal system problem during request

QueryMetadataException - Metadata implementation detected a problem during the request

Since:

4.3

getBinaryVDBResource

byte[] getBinaryVDBResource(String resourcePath)
                     throws TeiidComponentException,
                            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:

TeiidComponentException - Unexpected internal system problem during request

QueryMetadataException - Metadata implementation detected a problem during the request

Since:

4.3

isTemporaryTable

boolean isTemporaryTable(Object groupID)
                  throws TeiidComponentException,
                         QueryMetadataException

Determine whether a group is a temporary table.

Parameters:

groupID - Group to check

Returns:

True if group is a temporary group

Throws:

TeiidComponentException

QueryMetadataException

addToMetadataCache

Object addToMetadataCache(Object metadataID,
                          String key,
                          Object value)
                   throws TeiidComponentException,
                          QueryMetadataException

Throws:

TeiidComponentException

QueryMetadataException

getFromMetadataCache

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

Throws:

TeiidComponentException

QueryMetadataException

isScalarGroup

boolean isScalarGroup(Object groupID)
               throws TeiidComponentException,
                      QueryMetadataException

Throws:

TeiidComponentException

QueryMetadataException

getFunctionLibrary

FunctionLibrary getFunctionLibrary()

getScriptEngine

ScriptEngine getScriptEngine(String langauge)
                      throws TeiidProcessingException

Parameters:

langauge - null is treated as the default of 'javascript'

Returns:

the ScriptEngine or null if the ScriptEngine is not available

Throws:

TeiidProcessingException - if the ScriptEngine is required

getPrimaryKey

Object getPrimaryKey(Object metadataID)

isMultiSource

boolean isMultiSource(Object modelId)
               throws QueryMetadataException,
                      TeiidComponentException

Throws:

QueryMetadataException

TeiidComponentException

isMultiSourceElement

boolean isMultiSourceElement(Object elementId)
                      throws QueryMetadataException,
                             TeiidComponentException

Throws:

QueryMetadataException

TeiidComponentException

getDesignTimeMetadata

QueryMetadataInterface getDesignTimeMetadata()

Get the metadata without visibility and session tables

Returns:

hasProcedure

boolean hasProcedure(String name)
              throws TeiidComponentException

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

Parameters:

name -

Returns:

Throws:

TeiidComponentException

getSessionMetadata

QueryMetadataInterface getSessionMetadata()

getImportedModels

Set<String> getImportedModels()

isVariadic

boolean isVariadic(Object metadataID)

getFunctionBasedExpressions

Map<Expression,Integer> getFunctionBasedExpressions(Object metadataID)

isPseudo

boolean isPseudo(Object elementId)

getExtensionProperty

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

useOutputName

boolean useOutputName()

findShortName

boolean findShortName()

widenComparisonToString

boolean widenComparisonToString()

getDataTypeClass

Class<?> getDataTypeClass(String typeOrDomainName)
                   throws QueryMetadataException

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

Parameters:

typeOrDomainName -

Returns:

Throws:

QueryMetadataException

isEnvAllowed

boolean isEnvAllowed()

isLongRanks

boolean isLongRanks()

getModelIDs

List<? extends Object> getModelIDs()

getPushdownFunction

FunctionMethod getPushdownFunction(Object modelID,
                                   String fullName)