Package org.teiid.adminapi.impl

Class ModelMetaData

java.lang.Object

org.teiid.adminapi.impl.AdminObjectImpl

org.teiid.adminapi.impl.ModelMetaData

All Implemented Interfaces:

Serializable, AdminObject, Model

public class ModelMetaData
extends AdminObjectImpl
implements Model

See Also:

Serialized Form

Nested Class Summary

Nested Classes

Modifier and Type	Class	Description
static class	ModelMetaData.Message

Nested classes/interfaces inherited from interface org.teiid.adminapi.Model

Model.MetadataStatus, Model.Type

Field Summary

Fields

Modifier and Type	Field	Description
protected String	description
protected List<ModelMetaData.Message>	messages
protected Model.MetadataStatus	metadataStatus
protected String	modelType
protected String	path
protected List<ModelMetaData.Message>	runtimeMessages
protected List<String>	sourceMetadataText
protected List<String>	sourceMetadataType
protected Map<String,SourceMappingMetadata>	sources
protected boolean	visible

Fields inherited from class org.teiid.adminapi.impl.AdminObjectImpl

attachments

Fields inherited from interface org.teiid.adminapi.AdminObject

DELIMITER, DELIMITER_CHAR, ESCAPED_DELIMITER, ESCAPED_WILDCARD, WILDCARD

Constructor Summary

Constructors

Constructor	Description
ModelMetaData()

Method Summary

Modifier and Type	Method	Description
ModelMetaData.Message	addMessage(String severity, String message)
ModelMetaData.Message	addMessage(ModelMetaData.Message ve)
ModelMetaData.Message	addRuntimeError(String message)
ModelMetaData.Message	addRuntimeMessage(ModelMetaData.Message.Severity severity, String message)
SourceMappingMetadata	addSourceMapping(String name, String translatorName, String connJndiName)
void	addSourceMapping(SourceMappingMetadata source)
void	addSourceMetadata(String type, String text)
void	clearMessages()
void	clearRuntimeMessages()
String	getDescription()	Description about the model
List<ModelMetaData.Message>	getMessages()
List<ModelMetaData.Message>	getMessages(boolean includeRuntime)
Model.MetadataStatus	getMetadataStatus()	Metadata Load status of the model.
Model.Type	getModelType()	Retrieve the model type.
String	getPath()
static Collection<String>	getReservedNames()
String	getSchemaSourceType()	Deprecated.
String	getSchemaText()	Deprecated.
String	getSourceConnectionJndiName(String sourceName)	Get the configured JNDI name for the given source name.
SourceMappingMetadata	getSourceMapping(String sourceName)
Collection<SourceMappingMetadata>	getSourceMappings()
List<String>	getSourceMetadataText()
List<String>	getSourceMetadataType()
List<String>	getSourceNames()	Associated Source Names for the Models
Map<String,SourceMappingMetadata>	getSources()
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	hasErrors()
boolean	hasRuntimeMessages()
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.
void	setDescription(String description)
void	setMetadataStatus(String status)
void	setMetadataStatus(Model.MetadataStatus status)
void	setModelType(String modelType)
void	setModelType(Model.Type modelType)
void	setPath(String path)
void	setSchemaSourceType(String schemaSourceType)	Deprecated.
void	setSchemaText(String schemaText)	Deprecated.
void	setSourceMappings(List<SourceMappingMetadata> sources)
void	setSupportsMultiSourceBindings(boolean supports)
void	setVisible(boolean value)
String	toString()

Methods inherited from class org.teiid.adminapi.impl.AdminObjectImpl

addAttachment, addAttchment, addProperty, getAttachment, getHostName, getName, getProperties, getPropertiesMap, getPropertyValue, getServerGroup, getServerName, removeAttachment, removeProperty, setHostName, setName, setProperties, setServerGroup, setServerName

Methods inherited from class java.lang.Object

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

Methods inherited from interface org.teiid.adminapi.AdminObject

getName, getProperties, getPropertyValue

Field Detail

sources

protected Map<String,SourceMappingMetadata> sources

modelType

protected String modelType

description

protected String description

path

protected String path

visible

protected boolean visible

messages

protected List<ModelMetaData.Message> messages

runtimeMessages

protected transient List<ModelMetaData.Message> runtimeMessages

sourceMetadataType

protected List<String> sourceMetadataType

sourceMetadataText

protected List<String> sourceMetadataText

metadataStatus

protected Model.MetadataStatus metadataStatus

Constructor Detail

ModelMetaData

public ModelMetaData()

Method Detail

getDescription

public String getDescription()

Description copied from interface: Model

Description about the model

Specified by:

getDescription in interface Model

Returns:

setDescription

public void setDescription(String description)

isSource

public boolean isSource()

Description copied from interface: Model

Determine if this model is a Source model.

Specified by:

isSource in interface Model

Returns:

true if it contains physical group(s).

isVisible

public boolean isVisible()

Description copied from interface: Model

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

Specified by:

isVisible in interface Model

Returns:

true if the model is visible for querying.

getModelType

public Model.Type getModelType()

Description copied from interface: Model

Retrieve the model type.

Specified by:

getModelType in interface Model

Returns:

model type

getPath

public String getPath()

setPath

public void setPath(String path)

isSupportsMultiSourceBindings

public boolean isSupportsMultiSourceBindings()

Description copied from interface: Model

Determine whether this model can support more than one source.

Specified by:

isSupportsMultiSourceBindings in interface Model

Returns:

true if this model supports multiple sources

setSupportsMultiSourceBindings

public void setSupportsMultiSourceBindings(boolean supports)

setModelType

public void setModelType(Model.Type modelType)

setModelType

public void setModelType(String modelType)

getMetadataStatus

public Model.MetadataStatus getMetadataStatus()

Description copied from interface: Model

Metadata Load status of the model.

Specified by:

getMetadataStatus in interface Model

Returns:

setMetadataStatus

public void setMetadataStatus(Model.MetadataStatus status)

setMetadataStatus

public void setMetadataStatus(String status)

toString

public String toString()

Overrides:

toString in class Object

setVisible

public void setVisible(boolean value)

getSourceMappings

public Collection<SourceMappingMetadata> getSourceMappings()

getSources

public Map<String,SourceMappingMetadata> getSources()

getSourceMapping

public SourceMappingMetadata getSourceMapping(String sourceName)

setSourceMappings

public void setSourceMappings(List<SourceMappingMetadata> sources)

getSourceNames

public List<String> getSourceNames()

Description copied from interface: Model

Associated Source Names for the Models

Specified by:

getSourceNames in interface Model

Returns:

String

getSourceConnectionJndiName

public String getSourceConnectionJndiName(String sourceName)

Description copied from interface: Model

Get the configured JNDI name for the given source name.

Specified by:

getSourceConnectionJndiName in interface Model

Parameters:

sourceName - - name of the source

Returns:

null if none configured.

getSourceTranslatorName

public String getSourceTranslatorName(String sourceName)

Description copied from interface: Model

Get the configured translator name for the given source

Specified by:

getSourceTranslatorName in interface Model

Returns:

addSourceMapping

public SourceMappingMetadata addSourceMapping(String name,
                                              String translatorName,
                                              String connJndiName)

addSourceMapping

public void addSourceMapping(SourceMappingMetadata source)

hasErrors

public boolean hasErrors()

getMessages

public List<ModelMetaData.Message> getMessages()

getMessages

public List<ModelMetaData.Message> getMessages(boolean includeRuntime)

addMessage

public ModelMetaData.Message addMessage(String severity,
                                        String message)

hasRuntimeMessages

public boolean hasRuntimeMessages()

addRuntimeError

public ModelMetaData.Message addRuntimeError(String message)

addRuntimeMessage

public ModelMetaData.Message addRuntimeMessage(ModelMetaData.Message.Severity severity,
                                               String message)

addMessage

public ModelMetaData.Message addMessage(ModelMetaData.Message ve)

clearRuntimeMessages

public void clearRuntimeMessages()

clearMessages

public void clearMessages()

addSourceMetadata

public void addSourceMetadata(String type,
                              String text)

getSchemaSourceType

@Deprecated
public String getSchemaSourceType()

Deprecated.

See Also:

getSourceMetadataType()

setSchemaSourceType

@Deprecated
public void setSchemaSourceType(String schemaSourceType)

Deprecated.

See Also:

addSourceMetadata(String, String)

getSchemaText

@Deprecated
public String getSchemaText()

Deprecated.

See Also:

getSourceMetadataText()

setSchemaText

@Deprecated
public void setSchemaText(String schemaText)

Deprecated.

See Also:

addSourceMetadata(String, String)

getSourceMetadataType

public List<String> getSourceMetadataType()

getSourceMetadataText

public List<String> getSourceMetadataText()

getValidityErrors

public List<String> getValidityErrors()

Description copied from interface: Model

Shows any validity errors present in the model

Specified by:

getValidityErrors in interface Model

Returns:

getReservedNames

public static Collection<String> getReservedNames()