com.metamatrix.common.vdb.api
Interface VDBDefn

All Superinterfaces:

VDBInfo

All Known Implementing Classes:

BasicVDBDefn

public interface VDBDefn
extends VDBInfo

Date Dec 3, 2002 To import a VDB, the following information is required: 1. VDB Jar #setVDBJar(Object). This jar will provide the model and their model info. 2. Add a model to connector binding mapping #addModelToConnectorMapping(String, String) that indicates which binding should be used for that model 3. set VDB name (version will be assign at creation time) Optional information: 1. Add a ConnectorBinding #addConnectorBinding(ConnectorBinding). If this already exist in the configration, it will not be loaded. The model will reference the existing binding. If not added, the connector binding mapping will indicate an assumed already existing binding. 2. Add a ConnectorType {@link #addConnectorType(ComponentType). If already exist in the configration, it will not be loaded. The binding will reference the existing type.

Method Summary

boolean	doesVDBHaveValidityError() Returns true if the VDBDefn was built from a .VDB file that had a validity error;
ConnectorBinding	getConnectorBindingByName(java.lang.String connectorBindingName) Returns the connector binding for the specified connector binding name.
ConnectorBinding	getConnectorBindingByRouting(java.lang.String routingUUID) Returns the connector binding for the specified routing UUID.
java.util.Map<java.lang.String,ConnectorBinding>	getConnectorBindings() Returns the connector bindings that are used in this VDB.
ComponentType	getConnectorType(java.lang.String componentTypeName) Returns the component type for the specified componentTypeName.
java.util.Map<java.lang.String,ComponentType>	getConnectorTypes() Returns the connector types that are used in this VDB.
char[]	getDataRoles() Get the XML contents of data roles defined for the VDB;
java.util.Properties	getHeaderProperties() Header Properties
ModelInfo	getMatertializationModel() Get the Materialization model in this VDB if one exists.
java.util.Collection<java.lang.String>	getModelNames() Returns the collection of all the model names contained in the vdb archive.
java.util.Map	getModelToBindingMappings() Returns the model to connector binding mappings.
short	getStatus() Returns a short indicating if the status of the VirtualDatabase.
VDBStream	getVDBStream() This will let the uses stream the VDB contents the way they would need.
java.lang.String[]	getVDBValidityErrors() During the load of the VDB, if there are any validity errors reported in the VDB manifest file, they will be loaded into Defn file for observation or for the logging.
java.lang.String	getVersion() Returns the vdbVersion.
boolean	isActiveStatus()
boolean	isVisible(java.lang.String resourcePath) Is the given resource file is visible to the user.

Methods inherited from interface com.metamatrix.common.vdb.api.VDBInfo

getCreatedBy, getDateCreated, getDescription, getFileName, getModel, getModels, getName, getUUID, hasWSDLDefined

Method Detail

getVDBStream

VDBStream getVDBStream()

This will let the uses stream the VDB contents the way they would need. hanging on to whole byte[] may be costly in terms of memory.

Returns:

Since:

4.3

getVersion

java.lang.String getVersion()

Returns the vdbVersion.

Returns:

String

getConnectorTypes

java.util.Map<java.lang.String,ComponentType> getConnectorTypes()

Returns the connector types that are used in this VDB. The connector types are optional, if not specified on the import, then the connector type(s) is assumed to already exist in configuration connector type name ComponentType ComponentType

getConnectorType

ComponentType getConnectorType(java.lang.String componentTypeName)

Returns the component type for the specified componentTypeName. This is a helper method for mapping the connector binding type to its respective connector component type

Parameters:

componentTypeName -

Returns:

ComponentType

getConnectorBindings

java.util.Map<java.lang.String,ConnectorBinding> getConnectorBindings()

Returns the connector bindings that are used in this VDB. The connector bindings are optional, if not specified on the import, then the connector binding(s) is assumed to already exist in configuration connector binding name ConnectorBinding ConnectorBinding

Returns:

Map of connector types

getConnectorBindingByName

ConnectorBinding getConnectorBindingByName(java.lang.String connectorBindingName)

Returns the connector binding for the specified connector binding name.

Parameters:

routingUUID -

Returns:

ConnectorBinding

getConnectorBindingByRouting

ConnectorBinding getConnectorBindingByRouting(java.lang.String routingUUID)

Returns the connector binding for the specified routing UUID. This is a helper method for mapping the modelBindingMappings between the model and the connector binding.

Parameters:

routingUUID -

Returns:

ConnectorBinding

getModelToBindingMappings

java.util.Map getModelToBindingMappings()

Returns the model to connector binding mappings. Model Name List of ConnectorBinding routing UUIDs.

Returns:

Map

getModelNames

java.util.Collection<java.lang.String> getModelNames()

Returns the collection of all the model names contained in the vdb archive.

Returns:

Collection

getMatertializationModel

ModelInfo getMatertializationModel()

Get the Materialization model in this VDB if one exists.

Returns:

the Materialization model or null if none exists.

Since:

4.2

getStatus

short getStatus()

Returns a short indicating if the status of the VirtualDatabase. There are four status of the VirtualDatabase: "Incomplete", "Inactive", "Active", and "Deleted".

Returns:

boolean true indicates marked for deletion

See Also:

MetadataConstants.VDB_STATUS VDB_STATUS}

isActiveStatus

boolean isActiveStatus()

doesVDBHaveValidityError

boolean doesVDBHaveValidityError()

Returns true if the VDBDefn was built from a .VDB file that had a validity error;

Returns:

Since:

4.2

getVDBValidityErrors

java.lang.String[] getVDBValidityErrors()

During the load of the VDB, if there are any validity errors reported in the VDB manifest file, they will be loaded into Defn file for observation or for the logging.

Returns:

list of errors, empty list if none logged.

isVisible

boolean isVisible(java.lang.String resourcePath)

Is the given resource file is visible to the user.

Parameters:

resourcePath - - path in the VDB file

Returns:

true if visible; false otherwise

getDataRoles

char[] getDataRoles()

Get the XML contents of data roles defined for the VDB;

Returns:

xml contents; null if data roles not defined.

getHeaderProperties

java.util.Properties getHeaderProperties()

Header Properties

Returns: