org.teiid.adminapi

Interface VDB

All Superinterfaces:

AdminObject, DomainAware, Serializable

All Known Implementing Classes:

VDBMetaData

public interface VDB
extends AdminObject, DomainAware

Represents a Virtual Database in the Teiid System.
A VDB has a name and a version.

The identifier pattern for a VDB is "name<AdminObject.DELIMITER_CHAR>version", where the name of the VDB and its version represent its unique identifier in the Teiid system. There are no spaces allowed in a given VDB name, and VDB name must start with a letter. A version number is automatically assigned to a VDB when it is deployed into a system. A VDB is uniquely identified by "name<AdminObject.DELIMITER_CHAR>version". For example: "Accounts<AdminObject.DELIMITER_CHAR>1", "UnifiedSales<AdminObject.DELIMITER_CHAR>4" etc.

Since:

4.3

Nested Class Summary

Nested Classes

Modifier and Type	Interface and Description
static class	VDB.ConnectionType
static class	VDB.Status

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
VDB.ConnectionType	getConnectionType()
List<DataPolicy>	getDataPolicies() Get the data roles defined on this VDB
String	getDescription() Get the description of the VDB
List<? extends Entry>	getEntries() Get the list of other resources included in the VDB
List<Model>	getModels()
String	getName() Get the name for this AdminObject, usually the last component of the identifier.
List<Translator>	getOverrideTranslators() Get the list of translators defined in the VDB
VDB.Status	getStatus()
List<String>	getValidityErrors() Shows any validity errors present in the VDB
List<? extends VDBImport>	getVDBImports() Get the list of vdb imports
String	getVersion()
boolean	isValid() Shows if VDB is a valid entity
boolean	isVisible(String modelName) Whether the model is visible

Methods inherited from interface org.teiid.adminapi.AdminObject

getProperties, getPropertyValue

Methods inherited from interface org.teiid.adminapi.DomainAware

getHostName, getServerGroup, getServerName

Method Detail

getModels

List<Model> getModels()

Returns:

Collection of Teiid Models

getStatus

VDB.Status getStatus()

Returns:

the status

getConnectionType

VDB.ConnectionType getConnectionType()

Returns:

the connection status

getVersion

String getVersion()

Returns:

the VDB version.

getDescription

String getDescription()

Get the description of the VDB

Returns:

getValidityErrors

List<String> getValidityErrors()

Shows any validity errors present in the VDB

Returns:

isValid

boolean isValid()

Shows if VDB is a valid entity

Returns:

getDataPolicies

List<DataPolicy> getDataPolicies()

Get the data roles defined on this VDB

Returns:

getOverrideTranslators

List<Translator> getOverrideTranslators()

Get the list of translators defined in the VDB

Returns:

getVDBImports

List<? extends VDBImport> getVDBImports()

Get the list of vdb imports

Returns:

getEntries

List<? extends Entry> getEntries()

Get the list of other resources included in the VDB

Returns:

isVisible

boolean isVisible(String modelName)

Whether the model is visible

Parameters:

modelName -

Returns:

getName

String getName()

Description copied from interface: AdminObject

Get the name for this AdminObject, usually the last component of the identifier.

Specified by:

getName in interface AdminObject

Returns:

the name of the vdb. If this vdb is using semantic versioning, that version will be included in the name.