org.teiid.metadata

Class MetadataFactory

java.lang.Object

org.teiid.metadata.MetadataFactory

All Implemented Interfaces:

Serializable

public class MetadataFactory
extends Object
implements Serializable

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

Field Summary

Fields

Modifier and Type	Field and Description
static String	ACCUMULO_URI
static Map<String,String>	BUILTIN_NAMESPACES
protected int	count
static String	EXCEL_URI
static String	HBASE_URI
static String	JPA_URI
static String	LDAP_URI
static String	MONGO_URI
static String	ODATA_URI
static String	PI_URI
static String	REST_URI
static String	SF_URI
static String	SPATIAL_URI
static String	WS_URI

Constructor Summary

Constructors

Constructor and Description
MetadataFactory(String vdbName, Object vdbVersion, Map<String,Datatype> runtimeTypes, ModelMetaData model)
MetadataFactory(String vdbName, Object vdbVersion, String schemaName, Map<String,Datatype> runtimeTypes, Properties modelProperties, String rawMetadata)

Method Summary

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	addColumnPermission(String role, Column resource, Boolean allowCreate, Boolean allowRead, Boolean allowUpdate, String condition, String mask, Integer order) Add a permission for a Column
void	addDatatype(Datatype datatype) Deprecated. see addEnterpriseType
void	addEnterpriseDatatype(Datatype datatype) Add an enterprise type (typically a Designer defined type extension)- typically not called
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.
void	addFunction(FunctionMethod functionMethod)
FunctionMethod	addFunction(String name) Add a function with the given name to the model.
FunctionMethod	addFunction(String name, Method method) Adds a non-pushdown function based upon the given Method.
FunctionMethod	addFunction(String name, String returnType, String... paramTypes) Add a function with the given name to the model.
KeyRecord	addFunctionBasedIndex(String name, List<String> expressions, List<Boolean> nonColumnExpressions, Table table) Adds a function based index on the given expressions.
KeyRecord	addIndex(String name, boolean nonUnique, List<String> columnNames, Table table) Adds an index to the given table.
void	addNamespace(String prefix, String uri)
void	addPermission(String role, AbstractMetadataRecord resource, Boolean allowAlter, Boolean allowCreate, Boolean allowRead, Boolean allowUpdate, Boolean allowDelete, Boolean allowExecute, String condition, Boolean constraint) Add a permission for a Table or Procedure
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.
void	addSchemaPermission(String role, Boolean allowAlter, Boolean allowCreate, Boolean allowRead, Boolean allowUpdate, Boolean allowDelete, Boolean allowExecute) Add a permission for the current Schema which will typically act as a default for all child objects.
Table	addTable(String name) Add a table with the given name to the model.
MetadataStore	asMetadataStore()
void	correctDatatypes(Map<String,Datatype> dt, Map<String,Datatype> builtin) To be called if the MetadataFactory is deserialized to set the canonical system type value.
static FunctionMethod	createFunctionFromMethod(String name, Method method)
Map<String,Datatype>	getBuiltinDataTypes() get all built-in types, known to Designer and defined in the system metadata.
Map<String,Datatype>	getDataTypes() get runtime types keyed by runtime name, which is a type name known to the Teiid engine
Datatype	getEnterpriseDatatype(String name) Get an enterprise type (typically a Designer defined type extension) by name.
Properties	getImportProperties() Deprecated.
Model	getModel()
Properties	getModelProperties()
String	getName()
Map<String,String>	getNamespaces() Get the namespace map.
Parser	getParser()
String	getRawMetadata() Deprecated.
Schema	getSchema()
String	getVdbName()
Map<String,? extends VDBResource>	getVDBResources()
String	getVdbVersion()
static String	hex(long val, int hexLength)
void	mergeInto(MetadataStore store)
void	parse(Reader ddl) Parses, but does not close, the given Reader into this MetadataFactory
Column	renameColumn(String oldName, String name, ColumnSet<?> table)
static String	resolvePropertyKey(MetadataFactory factory, String key)
void	setAutoCorrectColumnNames(boolean autoCorrectColumnNames) Set to false to disable correcting column and other names to be valid Teiid names.
void	setBuiltinDataTypes(Map<String,Datatype> builtinDataTypes)
static Datatype	setDataType(String type, BaseColumn column, Map<String,Datatype> dataTypes, boolean allowNull)
void	setModel(ModelMetaData model)
void	setParser(Parser parser)
void	setSchema(Schema schema) Set the Schema to a different instance.
protected void	setUUID(AbstractMetadataRecord record)
void	setVdbResources(Map<String,? extends VDBResource> vdbResources)

Methods inherited from class java.lang.Object

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

Field Detail

count

protected int count

SF_URI

public static final String SF_URI

See Also:

Constant Field Values

WS_URI

public static final String WS_URI

See Also:

Constant Field Values

MONGO_URI

public static final String MONGO_URI

See Also:

Constant Field Values

ODATA_URI

public static final String ODATA_URI

See Also:

Constant Field Values

ACCUMULO_URI

public static final String ACCUMULO_URI

See Also:

Constant Field Values

EXCEL_URI

public static final String EXCEL_URI

See Also:

Constant Field Values

JPA_URI

public static final String JPA_URI

See Also:

Constant Field Values

HBASE_URI

public static final String HBASE_URI

See Also:

Constant Field Values

SPATIAL_URI

public static final String SPATIAL_URI

See Also:

Constant Field Values

LDAP_URI

public static final String LDAP_URI

See Also:

Constant Field Values

REST_URI

public static final String REST_URI

See Also:

Constant Field Values

PI_URI

public static final String PI_URI

See Also:

Constant Field Values

BUILTIN_NAMESPACES

public static final Map<String,String> BUILTIN_NAMESPACES

Constructor Detail

MetadataFactory

public MetadataFactory(String vdbName,
                       Object vdbVersion,
                       Map<String,Datatype> runtimeTypes,
                       ModelMetaData model)

MetadataFactory

public MetadataFactory(String vdbName,
                       Object vdbVersion,
                       String schemaName,
                       Map<String,Datatype> runtimeTypes,
                       Properties modelProperties,
                       String rawMetadata)

Method Detail

hex

public static String hex(long val,
                         int hexLength)

getImportProperties

@Deprecated
public Properties getImportProperties()

Deprecated.

Returns:

See Also:

getModelProperties()

getModelProperties

public Properties getModelProperties()

getRawMetadata

@Deprecated
public String getRawMetadata()

Deprecated.

Get the metadata text for the first metadata element

Returns:

getModel

public Model getModel()

setUUID

protected void setUUID(AbstractMetadataRecord record)

getName

public String getName()

getSchema

public Schema getSchema()

addTable

public Table addTable(String name)

Add a table with the given name to the model.

Parameters:

name -

Returns:

Throws:

MetadataException

addColumn

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

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:

MetadataException

renameColumn

public Column renameColumn(String oldName,
                           String name,
                           ColumnSet<?> table)

setDataType

public static Datatype setDataType(String type,
                                   BaseColumn column,
                                   Map<String,Datatype> dataTypes,
                                   boolean allowNull)

addPrimaryKey

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

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

Parameters:

name -

columnNames -

table -

Returns:

Throws:

MetadataException

addAccessPattern

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

Adds an access pattern to the given table.

Parameters:

name -

columnNames -

table -

Returns:

Throws:

MetadataException

addIndex

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

Adds an index to the given table.

Parameters:

name -

nonUnique - true indicates that an index is being added.

columnNames -

table -

Returns:

Throws:

MetadataException

addFunctionBasedIndex

public KeyRecord addFunctionBasedIndex(String name,
                                       List<String> expressions,
                                       List<Boolean> nonColumnExpressions,
                                       Table table)

Adds a function based index on the given expressions.

Parameters:

name -

expressions -

nonColumnExpressions - a Boolean list indicating when expressions are non-column expressions

table -

Returns:

Throws:

MetadataException

addForiegnKey

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

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:

MetadataException

addForiegnKey

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

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:

MetadataException

addProcedure

public Procedure addProcedure(String name)

Add a procedure with the given name to the model.

Parameters:

name -

Returns:

Throws:

MetadataException

addProcedureParameter

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

Add a procedure parameter.

Parameters:

name -

type - should be one of TypeFacility.RUNTIME_NAMES

parameterType - should be one of ProcedureParameter.Type

procedure -

Returns:

Throws:

MetadataException

addProcedureResultSetColumn

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

Add a procedure resultset column to the given procedure.

Parameters:

name -

type - should be one of TypeFacility.RUNTIME_NAMES

procedure -

Returns:

Throws:

MetadataException

addFunction

public FunctionMethod addFunction(String name)

Add a function with the given name to the model.

Parameters:

name -

Returns:

Throws:

MetadataException

addFunction

public FunctionMethod addFunction(String name,
                                  String returnType,
                                  String... paramTypes)

Add a function with the given name to the model.

Parameters:

name -

Returns:

Throws:

MetadataException

addFunction

public FunctionMethod addFunction(String name,
                                  Method method)

Adds a non-pushdown function based upon the given Method.

Parameters:

name -

method -

Returns:

Throws:

MetadataException

createFunctionFromMethod

public static FunctionMethod createFunctionFromMethod(String name,
                                                      Method method)

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()

setSchema

public void setSchema(Schema schema)

Set the Schema to a different instance. This is typically called in special situations where the MetadataFactory logic is not used to construct the Schema.

Parameters:

schema -

getDataTypes

public Map<String,Datatype> getDataTypes()

get runtime types keyed by runtime name, which is a type name known to the Teiid engine

Returns:

correctDatatypes

public void correctDatatypes(Map<String,Datatype> dt,
                             Map<String,Datatype> builtin)

To be called if the MetadataFactory is deserialized to set the canonical system type value.

Parameters:

dt -

builtin -

addDatatype

@Deprecated
public void addDatatype(Datatype datatype)

Deprecated. see addEnterpriseType

Add an enterprise type (typically a Designer defined type extension) - typically not called

Parameters:

datatype -

addEnterpriseDatatype

public void addEnterpriseDatatype(Datatype datatype)

Add an enterprise type (typically a Designer defined type extension)- typically not called

Parameters:

datatype -

getEnterpriseDatatype

public Datatype getEnterpriseDatatype(String name)

Get an enterprise type (typically a Designer defined type extension) by name.

Parameters:

name -

Returns:

getVdbName

public String getVdbName()

getVdbVersion

public String getVdbVersion()

getNamespaces

public Map<String,String> getNamespaces()

Get the namespace map. Will be an unmodifiable empty map if addNamespace(String, String) has not been called successfully.

Returns:

setBuiltinDataTypes

public void setBuiltinDataTypes(Map<String,Datatype> builtinDataTypes)

getBuiltinDataTypes

public Map<String,Datatype> getBuiltinDataTypes()

get all built-in types, known to Designer and defined in the system metadata. The entries are keyed by type name, which is typically the xsd type name.

Returns:

See Also:

for run-time types

parse

public void parse(Reader ddl)
           throws MetadataException

Parses, but does not close, the given Reader into this MetadataFactory

Parameters:

ddl -

Throws:

MetadataException

setParser

public void setParser(Parser parser)

setModel

public void setModel(ModelMetaData model)

getParser

public Parser getParser()

getVDBResources

public Map<String,? extends VDBResource> getVDBResources()

setVdbResources

public void setVdbResources(Map<String,? extends VDBResource> vdbResources)

addPermission

public void addPermission(String role,
                          AbstractMetadataRecord resource,
                          Boolean allowAlter,
                          Boolean allowCreate,
                          Boolean allowRead,
                          Boolean allowUpdate,
                          Boolean allowDelete,
                          Boolean allowExecute,
                          String condition,
                          Boolean constraint)

Add a permission for a Table or Procedure

Parameters:

role -

resource -

allowAlter -

allowCreate -

allowRead -

allowUpdate -

allowDelete -

allowExecute -

condition -

constraint -

addSchemaPermission

public void addSchemaPermission(String role,
                                Boolean allowAlter,
                                Boolean allowCreate,
                                Boolean allowRead,
                                Boolean allowUpdate,
                                Boolean allowDelete,
                                Boolean allowExecute)

Add a permission for the current Schema which will typically act as a default for all child objects.

Parameters:

role -

allowAlter -

allowCreate -

allowRead -

allowUpdate -

allowDelete -

allowExecute -

addColumnPermission

public void addColumnPermission(String role,
                                Column resource,
                                Boolean allowCreate,
                                Boolean allowRead,
                                Boolean allowUpdate,
                                String condition,
                                String mask,
                                Integer order)

Add a permission for a Column

Parameters:

role -

resource -

allowCreate -

allowRead -

allowUpdate -

condition -

mask -

order -

addFunction

public void addFunction(FunctionMethod functionMethod)

resolvePropertyKey

public static String resolvePropertyKey(MetadataFactory factory,
                                        String key)