org.teiid.metadata

Class MetadataFactory

java.lang.Object

org.teiid.metadata.AbstractMetadataRecord

org.teiid.metadata.Schema

org.teiid.metadata.MetadataFactory

All Implemented Interfaces:

Serializable

public class MetadataFactory
extends Schema

Allows connectors to build metadata for use by the engine. TODO: add support for datatype import TODO: add support for unique constraints

See Also:

Serialized Form

Nested Class Summary

Nested classes/interfaces inherited from class org.teiid.metadata.AbstractMetadataRecord

AbstractMetadataRecord.DataModifiable, AbstractMetadataRecord.Modifiable

Field Summary

Fields inherited from class org.teiid.metadata.AbstractMetadataRecord

NAME_DELIM_CHAR, RELATIONAL_URI

Constructor Summary

Constructors

Constructor and Description
MetadataFactory(String vdbName, int vdbVersion, String schemaName, Map<String,Datatype> dataTypes, Properties importProperties, String rawMetadata)

Method Summary

Methods

Modifier and Type	Method and Description
KeyRecord	addAccessPattern(String name, List<String> columnNames, Table table) Adds an access pattern to the given table.
Column	addColumn(String name, String type, ColumnSet<?> table) Adds a column to the table with the given name and type.
void	addDatatype(Datatype datatype)
ForeignKey	addForiegnKey(String name, List<String> columnNames, List<String> referencedColumnNames, String referenceTable, Table table) Adds a foreign key to the given table.
ForeignKey	addForiegnKey(String name, List<String> columnNames, String referenceTable, Table table) Adds a foreign key to the given table.
FunctionMethod	addFunction(String name) Add a function with the given name to the model.
KeyRecord	addIndex(String name, boolean nonUnique, List<String> columnNames, Table table) Adds an index to the given table.
void	addNamespace(String prefix, String uri)
KeyRecord	addPrimaryKey(String name, List<String> columnNames, Table table) Adds a primary key to the given table.
Procedure	addProcedure(String name) Add a procedure with the given name to the model.
ProcedureParameter	addProcedureParameter(String name, String type, ProcedureParameter.Type parameterType, Procedure procedure) Add a procedure parameter.
Column	addProcedureResultSetColumn(String name, String type, Procedure procedure) Add a procedure resultset column to the given procedure.
Table	addTable(String name) Add a table with the given name to the model.
MetadataStore	asMetadataStore()
Map<String,Datatype>	getDataTypes()
Properties	getImportProperties()
Map<String,String>	getNamespaces()
String	getRawMetadata()
String	getVdbName()
int	getVdbVersion()
void	mergeFrom(Schema schema)
void	mergeInto(MetadataStore store)
void	setAutoCorrectColumnNames(boolean autoCorrectColumnNames) Set to false to disable correcting column and other names to be valid Teiid names.
protected void	setUUID(AbstractMetadataRecord record)

Methods inherited from class org.teiid.metadata.Schema

addFunction, addProcedure, addTable, getFunction, getFunctions, getPrimaryMetamodelUri, getProcedure, getProcedures, getTable, getTables, isPhysical, isVisible, setPhysical, setPrimaryMetamodelUri, setVisible

Methods inherited from class org.teiid.metadata.AbstractMetadataRecord

equals, getAnnotation, getCanonicalName, getFullName, getName, getNameInSource, getParent, getProperties, getProperty, getUUID, hashCode, setAnnotation, setName, setNameInSource, setProperties, setProperty, setUUID, toString

Methods inherited from class java.lang.Object

clone, finalize, getClass, notify, notifyAll, wait, wait, wait

Constructor Detail

MetadataFactory

public MetadataFactory(String vdbName,
               int vdbVersion,
               String schemaName,
               Map<String,Datatype> dataTypes,
               Properties importProperties,
               String rawMetadata)

Method Detail

getImportProperties

public Properties getImportProperties()

getRawMetadata

public String getRawMetadata()

setUUID

protected void setUUID(AbstractMetadataRecord record)

addTable

public Table addTable(String name)
               throws TranslatorException

Add a table with the given name to the model.

Parameters:

name -

Returns:

Throws:

TranslatorException

addColumn

public Column addColumn(String name,
               String type,
               ColumnSet<?> table)
                 throws TranslatorException

Adds a column to the table with the given name and type.

Parameters:

name -

type - should be one of TypeFacility.RUNTIME_NAMES

table -

Returns:

Throws:

TranslatorException

addPrimaryKey

public KeyRecord addPrimaryKey(String name,
                      List<String> columnNames,
                      Table table)
                        throws TranslatorException

Adds a primary key to the given table. The column names should be in key order.

Parameters:

name -

columnNames -

table -

Returns:

Throws:

TranslatorException

addAccessPattern

public KeyRecord addAccessPattern(String name,
                         List<String> columnNames,
                         Table table)
                           throws TranslatorException

Adds an access pattern to the given table.

Parameters:

name -

columnNames -

table -

Returns:

Throws:

TranslatorException

addIndex

public KeyRecord addIndex(String name,
                 boolean nonUnique,
                 List<String> columnNames,
                 Table table)
                   throws TranslatorException

Adds an index to the given table.

Parameters:

name -

nonUnique - true indicates that an index is being added.

columnNames -

table -

Returns:

Throws:

TranslatorException

addForiegnKey

public ForeignKey addForiegnKey(String name,
                       List<String> columnNames,
                       String referenceTable,
                       Table table)
                         throws TranslatorException

Adds a foreign key to the given table. The referenced primary key must already exist. The column names should be in key order.

Parameters:

name -

columnNames -

referenceTable - - schema qualified reference table name

table -

Returns:

Throws:

TranslatorException

addForiegnKey

public ForeignKey addForiegnKey(String name,
                       List<String> columnNames,
                       List<String> referencedColumnNames,
                       String referenceTable,
                       Table table)
                         throws TranslatorException

Adds a foreign key to the given table. The referenced key may be automatically created if addUniqueConstraint is true. The column names should be in key order. if reference table is is another schema, they will be resolved during validation.

Parameters:

name -

columnNames -

referencedColumnNames, - may be null to indicate that the primary key should be used.

referenceTable - - schema qualified reference table name, can be from another schema

table -

addUniqueConstraint - - if true, if the referenced table columns do not match with either PK, or FK then a UNIQUE index on reference table is created.

Returns:

Throws:

TranslatorException

addProcedure

public Procedure addProcedure(String name)
                       throws TranslatorException

Add a procedure with the given name to the model.

Parameters:

name -

Returns:

Throws:

TranslatorException

addProcedureParameter

public ProcedureParameter addProcedureParameter(String name,
                                       String type,
                                       ProcedureParameter.Type parameterType,
                                       Procedure procedure)
                                         throws TranslatorException

Add a procedure parameter.

Parameters:

name -

type - should be one of TypeFacility.RUNTIME_NAMES

parameterType - should be one of ProcedureParameter.Type

procedure -

Returns:

Throws:

TranslatorException

addProcedureResultSetColumn

public Column addProcedureResultSetColumn(String name,
                                 String type,
                                 Procedure procedure)
                                   throws TranslatorException

Add a procedure resultset column to the given procedure.

Parameters:

name -

type - should be one of TypeFacility.RUNTIME_NAMES

procedure -

Returns:

Throws:

TranslatorException

addFunction

public FunctionMethod addFunction(String name)
                           throws TranslatorException

Add a function with the given name to the model.

Parameters:

name -

Returns:

Throws:

TranslatorException

setAutoCorrectColumnNames

public void setAutoCorrectColumnNames(boolean autoCorrectColumnNames)

Set to false to disable correcting column and other names to be valid Teiid names.

Parameters:

autoCorrectColumnNames -

addNamespace

public void addNamespace(String prefix,
                String uri)

mergeInto

public void mergeInto(MetadataStore store)

asMetadataStore

public MetadataStore asMetadataStore()

mergeFrom

public void mergeFrom(Schema schema)

getDataTypes

public Map<String,Datatype> getDataTypes()

addDatatype

public void addDatatype(Datatype datatype)

getVdbName

public String getVdbName()

getVdbVersion

public int getVdbVersion()

getNamespaces

public Map<String,String> getNamespaces()