org.teiid.adminapi.impl

Class VDBMetaData

java.lang.Object

org.teiid.adminapi.impl.AdminObjectImpl

org.teiid.adminapi.impl.VDBMetaData

All Implemented Interfaces:

Serializable, Cloneable, AdminObject, DomainAware, VDB

public class VDBMetaData
extends AdminObjectImpl
implements VDB, Cloneable

See Also:

Serialized Form

Nested Class Summary

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

VDB.ConnectionType, VDB.Status

Field Summary

Fields

Modifier and Type	Field and Description
static String	VERSION_DELIM

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 and Description
VDBMetaData()

Method Summary

Modifier and Type	Method and Description
DataPolicyMetadata	addDataPolicy(DataPolicyMetadata policy)
ModelMetaData	addModel(ModelMetaData m)
void	addOverideTranslator(VDBTranslatorMetaData t)
VDBMetaData	clone()
VDB.ConnectionType	getConnectionType()
List<DataPolicy>	getDataPolicies() Get the data roles defined on this VDB
LinkedHashMap<String,DataPolicyMetadata>	getDataPolicyMap()
String	getDescription() Get the description of the VDB
List<EntryMetaData>	getEntries() Get the list of other resources included in the VDB
String	getFullName()
Set<String>	getImportedModels()
ModelMetaData	getModel(String modelName)
LinkedHashMap<String,ModelMetaData>	getModelMetaDatas()
List<Model>	getModels()
List<Translator>	getOverrideTranslators() Get the list of translators defined in the VDB
LinkedHashMap<String,VDBTranslatorMetaData>	getOverrideTranslatorsMap()
long	getQueryTimeout()
VDB.Status	getStatus()
VDBTranslatorMetaData	getTranslator(String name)
List<String>	getValidityErrors() Shows any validity errors present in the VDB
List<VDBImportMetadata>	getVDBImports() Get the list of vdb imports
String	getVersion()
Map<String,Boolean>	getVisibilityOverrides()
boolean	hasErrors()
boolean	isOverideTranslator(String name)
boolean	isPreview()
boolean	isValid() Shows if VDB is a valid entity
boolean	isVisible(String modelName) Whether the model is visible
boolean	isXmlDeployment() If this is a *-vdb.xml deployment
void	setConnectionType(String allowConnections)
void	setConnectionType(VDB.ConnectionType allowConnections)
void	setDataPolicies(List<DataPolicy> policies) This method is required by the Management framework to write the mappings to the persistent form.
void	setDescription(String desc)
void	setEntries(List<EntryMetaData> entries)
void	setImportedModels(Set<String> importedModels)
void	setModels(Collection<ModelMetaData> models)
void	setOverrideTranslators(List<Translator> translators)
void	setStatus(String s)
void	setStatus(VDB.Status s)
void	setVersion(int version)
void	setVersion(String version)
void	setVisibilityOverride(String name, boolean visible)
void	setXmlDeployment(boolean dynamic)
String	toString()

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

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

Methods inherited from class java.lang.Object

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

Methods inherited from interface org.teiid.adminapi.VDB

getName

Methods inherited from interface org.teiid.adminapi.AdminObject

getProperties, getPropertyValue

Methods inherited from interface org.teiid.adminapi.DomainAware

getHostName, getServerGroup, getServerName

Field Detail

VERSION_DELIM

public static final String VERSION_DELIM

See Also:

Constant Field Values

Constructor Detail

VDBMetaData

public VDBMetaData()

Method Detail

getFullName

public String getFullName()

getConnectionType

public VDB.ConnectionType getConnectionType()

Specified by:

getConnectionType in interface VDB

Returns:

the connection status

setConnectionType

public void setConnectionType(VDB.ConnectionType allowConnections)

setConnectionType

public void setConnectionType(String allowConnections)

getStatus

public VDB.Status getStatus()

Specified by:

getStatus in interface VDB

Returns:

the status

setStatus

public void setStatus(VDB.Status s)

setStatus

public void setStatus(String s)

getVersion

public String getVersion()

Specified by:

getVersion in interface VDB

Returns:

the VDB version.

setVersion

public void setVersion(int version)

setVersion

public void setVersion(String version)

getModels

public List<Model> getModels()

Specified by:

getModels in interface VDB

Returns:

Collection of Teiid Models

getModelMetaDatas

public LinkedHashMap<String,ModelMetaData> getModelMetaDatas()

setModels

public void setModels(Collection<ModelMetaData> models)

Parameters:

models -

addModel

public ModelMetaData addModel(ModelMetaData m)

getOverrideTranslators

public List<Translator> getOverrideTranslators()

Description copied from interface: VDB

Get the list of translators defined in the VDB

Specified by:

getOverrideTranslators in interface VDB

Returns:

getOverrideTranslatorsMap

public LinkedHashMap<String,VDBTranslatorMetaData> getOverrideTranslatorsMap()

setOverrideTranslators

public void setOverrideTranslators(List<Translator> translators)

addOverideTranslator

public void addOverideTranslator(VDBTranslatorMetaData t)

isOverideTranslator

public boolean isOverideTranslator(String name)

getDescription

public String getDescription()

Description copied from interface: VDB

Get the description of the VDB

Specified by:

getDescription in interface VDB

Returns:

setDescription

public void setDescription(String desc)

getValidityErrors

public List<String> getValidityErrors()

Description copied from interface: VDB

Shows any validity errors present in the VDB

Specified by:

getValidityErrors in interface VDB

Returns:

isValid

public boolean isValid()

Description copied from interface: VDB

Shows if VDB is a valid entity

Specified by:

isValid in interface VDB

Returns:

hasErrors

public boolean hasErrors()

toString

public String toString()

Overrides:

toString in class Object

isVisible

public boolean isVisible(String modelName)

Description copied from interface: VDB

Whether the model is visible

Specified by:

isVisible in interface VDB

Returns:

getModel

public ModelMetaData getModel(String modelName)

isXmlDeployment

public boolean isXmlDeployment()

If this is a *-vdb.xml deployment

Returns:

setXmlDeployment

public void setXmlDeployment(boolean dynamic)

getDataPolicies

public List<DataPolicy> getDataPolicies()

Description copied from interface: VDB

Get the data roles defined on this VDB

Specified by:

getDataPolicies in interface VDB

Returns:

setDataPolicies

public void setDataPolicies(List<DataPolicy> policies)

This method is required by the Management framework to write the mappings to the persistent form. The actual assignment is done in the VDBMetaDataClassInstancefactory

Parameters:

policies -

addDataPolicy

public DataPolicyMetadata addDataPolicy(DataPolicyMetadata policy)

getDataPolicyMap

public LinkedHashMap<String,DataPolicyMetadata> getDataPolicyMap()

getTranslator

public VDBTranslatorMetaData getTranslator(String name)

isPreview

public boolean isPreview()

getQueryTimeout

public long getQueryTimeout()

getVDBImports

public List<VDBImportMetadata> getVDBImports()

Description copied from interface: VDB

Get the list of vdb imports

Specified by:

getVDBImports in interface VDB

Returns:

getImportedModels

public Set<String> getImportedModels()

setImportedModels

public void setImportedModels(Set<String> importedModels)

getEntries

public List<EntryMetaData> getEntries()

Description copied from interface: VDB

Get the list of other resources included in the VDB

Specified by:

getEntries in interface VDB

Returns:

setEntries

public void setEntries(List<EntryMetaData> entries)

clone

public VDBMetaData clone()

Overrides:

clone in class Object

setVisibilityOverride

public void setVisibilityOverride(String name,
                                  boolean visible)

getVisibilityOverrides

public Map<String,Boolean> getVisibilityOverrides()