ptdb.kernel.database

Interface DBConnection

All Known Implementing Classes:

AsynchronousDBConnection, OracleXMLDBConnection, RebuildReferenceFile

public interface DBConnection

Interface for XML Database connections.

Since:

Ptolemy II 10.0

Version:

$Id$

Author:

Ashwini Bijwe, Yousef Alsaeed

Pt.AcceptedRating:

Red (abijwe)

Pt.ProposedRating:

Red (abijwe)

Method Summary

Modifier and Type	Method and Description
void	abortConnection() Abort the connection to the database and roll back the transaction.
void	closeConnection() Close the connection to the database and commit the transaction.
void	commitConnection() Commit the transaction running over the connection.
java.util.ArrayList<XMLDBModel>	executeAttributeSearchTask(AttributeSearchTask task) Search models that contain the given attributes in the database.
XMLDBAttribute	executeCreateAttributeTask(CreateAttributeTask task) Execute the necessary commands to create a new attribute in the database according to the attribute specification given in the task parameter.
java.lang.String	executeCreateModelTask(CreateModelTask task) Execute the necessary commands to create a new model in the database according to the model specification given in the task parameter.
void	executeDeleteAttributeTask(DeleteAttributeTask task) Execute the necessary commands to delete an attribute from the database according to the attribute specification given in the task parameter.
java.util.ArrayList<XMLDBModel>	executeFetchHierarchyTask(FetchHierarchyTask task) Fetch the parent model hierarchies for the given models.
java.util.List<XMLDBAttribute>	executeGetAttributesTask(GetAttributesTask task) Get the attributes defined from the database.
XMLDBModel	executeGetCompleteModelTask(GetModelTask task) Execute the necessary commands to retrieve a model from the database and resolve all the references in it if any.
java.util.List<XMLDBModel>	executeGetFirstLevelParents(GetFirstLevelParentsTask task) Execute the given task to fetch the first level parents for the given model.
java.util.List<XMLDBModel>	executeGetListOfAllModels() Retrieve and return the list of all models in the database.
XMLDBModel	executeGetModelTask(GetModelTask task) Execute the necessary commands to retrieve a model from the database.
java.lang.String	executeGetReferenceStringTask(GetReferenceStringTask task) Get the model reference string for the given model name.
java.util.ArrayList<XMLDBModel>	executeGraphSearchTask(GraphSearchTask task) Search models that contain given graphical pattern in the database.
java.util.ArrayList<XMLDBModel>	executeModelNameSearchTask(ModelNameSearchTask modelNameSearchTask) Execute the model name search task.
void	executeRemoveModelsTask(RemoveModelsTask task) Execute remove models task to delete a list of models from the database.
void	executeRenameModelTask(RenameModelTask task) Execute rename model task which will change the name of the model in the database and reflect the change in the reference file.
java.lang.String	executeSaveModelTask(SaveModelTask task) Execute the necessary commands to save/update a model in the database according to the model specification given in the task parameter.
void	executeUpdateAttributeTask(UpdateAttributeTask task) Execute the necessary commands to update an attribute in the database according to the attribute specification given in the task parameter.
void	executeUpdateModelInCache(XMLDBModel xmlDBModel) Execute the necessary commands to update the cache with the given model.
void	executeUpdateParentsToNewVersion(UpdateParentsToNewVersionTask task) Execute the given task to update the referenced version for the given parents from the old model to the new model.

Method Detail

abortConnection

void abortConnection()
              throws DBConnectionException

Abort the connection to the database and roll back the transaction.

Throws:

DBConnectionException

closeConnection

void closeConnection()
              throws DBConnectionException

Close the connection to the database and commit the transaction.

Throws:

DBConnectionException

commitConnection

void commitConnection()
               throws DBConnectionException

Commit the transaction running over the connection.

Throws:

DBConnectionException - - When there is a problem while committing transaction in the database.

executeCreateAttributeTask

XMLDBAttribute executeCreateAttributeTask(CreateAttributeTask task)
                                   throws DBExecutionException

Execute the necessary commands to create a new attribute in the database according to the attribute specification given in the task parameter.

Parameters:

task - The task to be completed. In this case, CreateAttributeTask. This will tell the DB layer to create a new attribute in the database.

Returns:

The XMLDBAttribute object that was stored in the Database.

Throws:

DBExecutionException - Thrown if the operation fails.

executeCreateModelTask

java.lang.String executeCreateModelTask(CreateModelTask task)
                                 throws DBExecutionException,
                                        ModelAlreadyExistException,
                                        CircularDependencyException

Execute the necessary commands to create a new model in the database according to the model specification given in the task parameter.

Parameters:

task - The task to be completed. In this case, CreateModelTask. This will tell the DB layer to create a new model in the database.

Returns:

The Id of the newly created model.

Throws:

DBExecutionException

ModelAlreadyExistException - Thrown if the model being created already exists.

CircularDependencyException - If thrown while creating reference string.

executeDeleteAttributeTask

void executeDeleteAttributeTask(DeleteAttributeTask task)
                         throws DBExecutionException

Execute the necessary commands to delete an attribute from the database according to the attribute specification given in the task parameter.

Parameters:

task - The task to be completed. In this case, DeleteAttributeTask. This will tell the DB layer to delete an attribute from the database.

Throws:

DBExecutionException - Thrown if the operation fails.

executeFetchHierarchyTask

java.util.ArrayList<XMLDBModel> executeFetchHierarchyTask(FetchHierarchyTask task)
                                                   throws DBExecutionException

Fetch the parent model hierarchies for the given models.

Parameters:

task - - Task that contains the list of models.

Returns:

- List of models that contain the parent hierarchies.

Throws:

DBExecutionException - - When the database encounters error while searching.

executeGetListOfAllModels

java.util.List<XMLDBModel> executeGetListOfAllModels()
                                              throws DBExecutionException

Retrieve and return the list of all models in the database.

Returns:

List of models in the database.

Throws:

DBExecutionException - thrown if there is an error while reading the model list from the database.

executeAttributeSearchTask

java.util.ArrayList<XMLDBModel> executeAttributeSearchTask(AttributeSearchTask task)
                                                    throws DBExecutionException

Search models that contain the given attributes in the database.

Parameters:

task - Task that contains a list of attributes that need to be searched in the database.

Returns:

List of models that contain the attributes.

Throws:

DBExecutionException - - When the database encounters error while searching.

executeGetAttributesTask

java.util.List<XMLDBAttribute> executeGetAttributesTask(GetAttributesTask task)
                                                 throws DBExecutionException

Get the attributes defined from the database.

Parameters:

task - The criteria to get the attribute.

Returns:

List of attributes stored in the database.

Throws:

DBExecutionException - Thrown if the operation fails.

executeGetFirstLevelParents

java.util.List<XMLDBModel> executeGetFirstLevelParents(GetFirstLevelParentsTask task)
                                                throws DBExecutionException

Execute the given task to fetch the first level parents for the given model. First level parents are models that are immediate parents for the given model.

Parameters:

task - Task that contains the model for which the first level parents list needs to be fetched.

Returns:

List of models that are the first-level parents of the given model.

Throws:

DBExecutionException - If thrown while fetching the parents list from the database.

executeGetModelTask

XMLDBModel executeGetModelTask(GetModelTask task)
                        throws DBExecutionException

Execute the necessary commands to retrieve a model from the database.

Parameters:

task - The task to be completed. In this case, GetModelTask. This will tell the DB layer to return the specified model.

Returns:

XMLDBModel This object will be populated with the model's MoML string.

Throws:

DBExecutionException - Thrown if the operations fails.

executeGetReferenceStringTask

java.lang.String executeGetReferenceStringTask(GetReferenceStringTask task)
                                        throws DBExecutionException

Get the model reference string for the given model name.

Parameters:

task - Task that contains the model name.

Returns:

The reference string for the given model name.

Throws:

DBExecutionException - If thrown while fetching the reference string.

executeGetCompleteModelTask

XMLDBModel executeGetCompleteModelTask(GetModelTask task)
                                throws DBExecutionException

Execute the necessary commands to retrieve a model from the database and resolve all the references in it if any.

Parameters:

task - The task to be completed. In this case, GetModelTask. This will tell the DB layer to return the specified model.

Returns:

XMLDBModel This object will be populated with the model's MoML string.

Throws:

DBExecutionException - Thrown if the operations fails.

executeGraphSearchTask

java.util.ArrayList<XMLDBModel> executeGraphSearchTask(GraphSearchTask task)
                                                throws DBExecutionException

Search models that contain given graphical pattern in the database.

Parameters:

task - - Task that contains the graph search criteria.

Returns:

- List of models that match the given search criteria.

Throws:

DBExecutionException - - When the database encounters error while searching.

executeModelNameSearchTask

java.util.ArrayList<XMLDBModel> executeModelNameSearchTask(ModelNameSearchTask modelNameSearchTask)
                                                    throws DBExecutionException

Execute the model name search task.

Parameters:

modelNameSearchTask - Task that contains the model name to be searched for.

Returns:

List of matching models.

Throws:

DBExecutionException - If thrown while searching the database.

executeSaveModelTask

java.lang.String executeSaveModelTask(SaveModelTask task)
                               throws DBExecutionException,
                                      CircularDependencyException

Execute the necessary commands to save/update a model in the database according to the model specification given in the task parameter.

Parameters:

task - The task to be completed. In this case, SaveModelTask. This will tell the DB layer to save/update a model already existing in the database.

Returns:

The Id of the saved model.

Throws:

DBExecutionException - Thrown when there is a problem in executing the task.

CircularDependencyException - If thrown while creating reference string.

executeRemoveModelsTask

void executeRemoveModelsTask(RemoveModelsTask task)
                      throws DBExecutionException

Execute remove models task to delete a list of models from the database.

Parameters:

task - Contains a list of models to be deleted from the database.

Throws:

DBExecutionException - Thrown if the operation fails.

executeRenameModelTask

void executeRenameModelTask(RenameModelTask task)
                     throws DBConnectionException,
                            DBExecutionException,
                            ModelAlreadyExistException,
                            DBModelNotFoundException

Execute rename model task which will change the name of the model in the database and reflect the change in the reference file.

Parameters:

task - RenameModelTask object that contains the XMLDBModel object and the new name.

Throws:

DBConnectionException - Thrown if there was a problem with the connection.

DBExecutionException - Thrown if there is a problem in executing the task.

DBModelNotFoundException - Thrown if the model with the name to be changed does not exist.

ModelAlreadyExistException - Thrown if the new name is a name of a model that is already in the database.

executeUpdateAttributeTask

void executeUpdateAttributeTask(UpdateAttributeTask task)
                         throws DBExecutionException

Execute the necessary commands to update an attribute in the database according to the attribute specification given in the task parameter.

Parameters:

task - The task to be completed. In this case, UpdateAttributeTask. This will tell the DB layer to update an attribute in the database.

Throws:

DBExecutionException - Thrown if the operation fails.

executeUpdateModelInCache

void executeUpdateModelInCache(XMLDBModel xmlDBModel)
                        throws DBExecutionException

Execute the necessary commands to update the cache with the given model.

If the model exists, replace it with the new model.
If the model does not exist, save it in the cache.

Parameters:

xmlDBModel - The model object that needs to be added to the cache.

Throws:

DBExecutionException - Thrown if the operation fails. already exists.

executeUpdateParentsToNewVersion

void executeUpdateParentsToNewVersion(UpdateParentsToNewVersionTask task)
                               throws DBExecutionException

Execute the given task to update the referenced version for the given parents from the old model to the new model.

Parameters:

task - Task that contains the list of parents, the old model and the new model.

Throws:

DBExecutionException - If thrown while updating the parents in the database.