org.teiid.adminapi

Interface Model

All Superinterfaces:

AdminObject, Serializable

All Known Implementing Classes:

ModelMetaData

public interface Model
extends AdminObject

Represents a metadata model in the Teiid system.

Since:

4.3

Nested Class Summary

Nested Classes

Modifier and Type	Interface and Description
static class	Model.MetadataStatus
static class	Model.Type

Field Summary

Fields inherited from interface org.teiid.adminapi.AdminObject

DELIMITER, DELIMITER_CHAR, ESCAPED_DELIMITER, ESCAPED_WILDCARD, WILDCARD

Method Summary

Modifier and Type	Method and Description
String	getDescription() Description about the model
Model.MetadataStatus	getMetadataStatus() Metadata Load status of the model.
Model.Type	getModelType() Retrieve the model type.
String	getSourceConnectionJndiName(String sourceName) Get the configured JNDI name for the given source name.
List<String>	getSourceNames() Associated Source Names for the Models
String	getSourceTranslatorName(String sourceName) Get the configured translator name for the given source
List<String>	getValidityErrors() Shows any validity errors present in the model
boolean	isSource() Determine if this model is a Source model.
boolean	isSupportsMultiSourceBindings() Determine whether this model can support more than one source.
boolean	isVisible() Determine whether this model is exposed for querying.

Methods inherited from interface org.teiid.adminapi.AdminObject

getName, getProperties, getPropertyValue

Method Detail

getDescription

String getDescription()

Description about the model

Returns:

isSource

boolean isSource()

Determine if this model is a Source model.

Returns:

true if it contains physical group(s).

isVisible

boolean isVisible()

Determine whether this model is exposed for querying.
Note: for imported models, this may be overriden. See VDB.isVisible(String)

Returns:

true if the model is visible for querying.

getModelType

Model.Type getModelType()

Retrieve the model type.

Returns:

model type

isSupportsMultiSourceBindings

boolean isSupportsMultiSourceBindings()

Determine whether this model can support more than one source.

Returns:

true if this model supports multiple sources

getSourceNames

List<String> getSourceNames()

Associated Source Names for the Models

Returns:

String

getSourceConnectionJndiName

String getSourceConnectionJndiName(String sourceName)

Get the configured JNDI name for the given source name.

Parameters:

sourceName - - name of the source

Returns:

null if none configured.

getSourceTranslatorName

String getSourceTranslatorName(String sourceName)

Get the configured translator name for the given source

Parameters:

sourceName -

Returns:

getValidityErrors

List<String> getValidityErrors()

Shows any validity errors present in the model

Returns:

getMetadataStatus

Model.MetadataStatus getMetadataStatus()

Metadata Load status of the model.

Returns: