com.metamatrix.metadata.runtime.spi
Interface MetaBaseConnector

All Superinterfaces:

RuntimeBaseConnector, TransactionInterface

All Known Implementing Classes:

JDBCConnector

public interface MetaBaseConnector
extends RuntimeBaseConnector

Method Summary

void	deleteVirtualDatabase(VirtualDatabaseID vdbID) Delete the VirtualDatabase.
VirtualDatabaseID	getActiveVirtualDatabaseID(java.lang.String vdbName, java.lang.String vdbVersion) Used only by the RuntimeMetadataCatalog to find the active id.
java.util.Collection	getDeletedVirtualDatabaseIDs() Returns a Collection of type VirtualDatabase that represents all the virtual databases that marked for deletion in the system.
java.util.Collection	getModels(VirtualDatabaseID vdbID)
VirtualDatabase	getVirtualDatabase(VirtualDatabaseID vdbID) Returns the VirtualDatabase for the specified VirtualdatabaseID.
VirtualDatabaseID	getVirtualDatabaseID(java.lang.String vdbName, java.lang.String vdbVersion) Used only by the RuntimeMetadataCatalog to find the virtual database id.
java.util.Collection	getVirtualDatabases() Returns a Collection of type VirtualDatabase that represents all the virtual databases in the system.
void	insertModels(java.util.Collection metadataObjects, VirtualDatabaseID vdbI) Insert models into the VirtualDatabase.
void	insertVirtualDatabase(VirtualDatabase vdb) Insert the VirtualDatabase.
void	setConnectorBindingNames(VirtualDatabaseID vdbID, java.util.Collection models, java.util.Map modelAndCBNames)
void	setStatus(VirtualDatabaseID virtualDBID, short status, java.lang.String userName) Set the VirtualDatabase status.
void	updateVirtualDatabase(VirtualDatabase vdb, java.lang.String userName) Update VDB attributes.

Methods inherited from interface com.metamatrix.metadata.runtime.spi.RuntimeBaseConnector

commit, rollback

Methods inherited from interface com.metamatrix.common.connection.TransactionInterface

close, isClosed, isReadonly

Method Detail

setStatus

void setStatus(VirtualDatabaseID virtualDBID,
               short status,
               java.lang.String userName)
               throws InvalidStateException,
                      VirtualDatabaseException

Set the VirtualDatabase status.

Parameters:

virtualDBID - represents the VirtualDatabase to be updated

userName - of the person requesting the change

status - is the status the VirtualDatabase should be set to

Throws:

VirtualDatabaseException - if unable to perform update.

InvalidStateException

insertModels

void insertModels(java.util.Collection metadataObjects,
                  VirtualDatabaseID vdbI)
                  throws VirtualDatabaseException

Insert models into the VirtualDatabase.

Parameters:

metadataObjects - is a collection of models to be inserted.

Throws:

VirtualDatabaseException - if unable to perform insertion.

insertVirtualDatabase

void insertVirtualDatabase(VirtualDatabase vdb)
                           throws VirtualDatabaseException

Insert the VirtualDatabase.

Parameters:

vdb - is the virtual database to be inserted.

Throws:

VirtualDatabaseException - if unable to perform insertion.

InvalidStateException - is thrown if the VirtualDatabase is not in the proper state to change to active state.

getActiveVirtualDatabaseID

VirtualDatabaseID getActiveVirtualDatabaseID(java.lang.String vdbName,
                                             java.lang.String vdbVersion)
                                             throws VirtualDatabaseException,
                                                    VirtualDatabaseDoesNotExistException

Used only by the RuntimeMetadataCatalog to find the active id.

Throws:

VirtualDatabaseException

VirtualDatabaseDoesNotExistException

getVirtualDatabase

VirtualDatabase getVirtualDatabase(VirtualDatabaseID vdbID)
                                   throws VirtualDatabaseException

Returns the VirtualDatabase for the specified VirtualdatabaseID.

Returns:

VirtualDatabase

Throws:

VirtualDatabaseException

getVirtualDatabaseID

VirtualDatabaseID getVirtualDatabaseID(java.lang.String vdbName,
                                       java.lang.String vdbVersion)
                                       throws VirtualDatabaseException,
                                              VirtualDatabaseDoesNotExistException

Used only by the RuntimeMetadataCatalog to find the virtual database id.

Throws:

VirtualDatabaseException

VirtualDatabaseDoesNotExistException

getVirtualDatabases

java.util.Collection getVirtualDatabases()
                                         throws VirtualDatabaseException

Returns a Collection of type VirtualDatabase that represents all the virtual databases in the system.

Returns:

Collection of type VirtualDatabase

Throws:

VirtualDatabaseException - an error occurs while trying to read the data.

getDeletedVirtualDatabaseIDs

java.util.Collection getDeletedVirtualDatabaseIDs()
                                                  throws VirtualDatabaseException

Returns a Collection of type VirtualDatabase that represents all the virtual databases that marked for deletion in the system.

Returns:

Collection of type VirtualDatabase

Throws:

VirtualDatabaseException - an error occurs while trying to read the data.

deleteVirtualDatabase

void deleteVirtualDatabase(VirtualDatabaseID vdbID)
                           throws VirtualDatabaseException

Delete the VirtualDatabase.

Parameters:

vdbID - is the ID of the virtual database to be deleted.

Throws:

VirtualDatabaseException - an error occurs while trying to delete the data.

getModels

java.util.Collection getModels(VirtualDatabaseID vdbID)
                               throws VirtualDatabaseException

Throws:

VirtualDatabaseException

setConnectorBindingNames

void setConnectorBindingNames(VirtualDatabaseID vdbID,
                              java.util.Collection models,
                              java.util.Map modelAndCBNames)
                              throws VirtualDatabaseException

Throws:

VirtualDatabaseException

updateVirtualDatabase

void updateVirtualDatabase(VirtualDatabase vdb,
                           java.lang.String userName)
                           throws VirtualDatabaseException

Update VDB attributes. Only the attributes defined in VirtualDatabase.ModifiableAttributes can be modefied. Call VirtualDatabase.update(String attribute, Object value) to update each attribute of the VDB before calling this method.

Parameters:

vdb - VDB to be updated.

userName - of the person updating the virtual database.

Throws:

VirtualDatabaseException