Package org.teiid.metadata

Interface RuntimeMetadata

public interface RuntimeMetadata

Helper methods that can be used to access runtime metadata.

Method Summary

Modifier and Type	Method	Description
byte[]	getBinaryVDBResource(String resourcePath)	Gets the contents of a VDB resource in binary form.
String	getCharacterVDBResource(String resourcePath)	Gets the contents of a VDB resource as a String.
Column	getColumn(String fullName)	Look up an object by identifier
Column	getColumn(String schema, String table, String name)	Look up an object by identifier
Procedure	getProcedure(String fullName)	Look up an object by identifier
Procedure	getProcedure(String schema, String name)	Look up an object by identifier
Table	getTable(String fullName)	Look up an object by identifier
Table	getTable(String schema, String name)	Look up an object by identifier
String[]	getVDBResourcePaths()	Gets the resource paths of all the resources in the VDB.

Method Detail

getTable

Table getTable(String fullName)
        throws TranslatorException

Look up an object by identifier

Parameters:

fullName -

Returns:

The object or throws a TranslatorException if the object cannot be found

Throws:

TranslatorException

getTable

Table getTable(String schema,
               String name)
        throws TranslatorException

Look up an object by identifier

Returns:

The object or throws a TranslatorException if the object cannot be found

Throws:

TranslatorException

getColumn

Column getColumn(String fullName)
          throws TranslatorException

Look up an object by identifier

Parameters:

fullName -

Returns:

The object or throws a TranslatorException if the object cannot be found

Throws:

TranslatorException

getColumn

Column getColumn(String schema,
                 String table,
                 String name)
          throws TranslatorException

Look up an object by identifier

Returns:

The object or throws a TranslatorException if the object cannot be found

Throws:

TranslatorException

getProcedure

Procedure getProcedure(String fullName)
                throws TranslatorException

Look up an object by identifier

Parameters:

fullName -

Returns:

The object or throws a TranslatorException if the object cannot be found

Throws:

TranslatorException

getProcedure

Procedure getProcedure(String schema,
                       String name)
                throws TranslatorException

Look up an object by identifier

Returns:

The object or throws a TranslatorException if the object cannot be found

Throws:

TranslatorException

getBinaryVDBResource

byte[] getBinaryVDBResource(String resourcePath)
                     throws TranslatorException

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:

TranslatorException - if the operation fails

Since:

4.3

getCharacterVDBResource

String getCharacterVDBResource(String resourcePath)
                        throws TranslatorException

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 of characters

Throws:

TranslatorException - if the operation fails

Since:

4.3

getVDBResourcePaths

String[] getVDBResourcePaths()
                      throws TranslatorException

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

Returns:

an array of resource paths of the resources in the VDB

Throws:

TranslatorException - if the operation fails

Since:

4.3