ptdb.kernel.database

Class AsynchronousDBConnection

java.lang.Object

ptdb.kernel.database.AsynchronousDBConnection

All Implemented Interfaces:

DBConnection

public class AsynchronousDBConnection
extends java.lang.Object
implements DBConnection

Provide an asynchronous mechanism of executing tasks over the database.

All the tasks are queued and executed parallel to the processing tasks. We plan to use this kind of connection for operations like saving a model that require a lot of processing.

Since:

Ptolemy II 10.0

Version:

$Id$

Author:

Ashwini Bijwe, Yousef Alsaeed

Pt.AcceptedRating:

Red (abijwe)

Pt.ProposedRating:

Red (abijwe)

Constructor Summary

Constructors

Constructor and Description
AsynchronousDBConnection() Construct an instance that creates the taskQueue to enqueue tasks and the executor thread that enables task execution in parallel.

Method Summary

Modifier and Type	Method and Description
void	abortConnection() Abort the execution by setting the execution flag as false.
void	closeConnection() Close the connection if all tasks in the queue are executed successfully.
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) Execute Fetch Hierarchy task.
java.util.List<XMLDBAttribute>	executeGetAttributesTask(GetAttributesTask task) Get Attributes Task is not supported by the asynchronous connection.
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) Fetch the first level parents for the given model is not supported by this connection.
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 is not supported by the asynchronous connection.
java.util.ArrayList<XMLDBModel>	executeGraphSearchTask(GraphSearchTask task) Search for graph is not supported by the asynchronous connection.
java.util.ArrayList<XMLDBModel>	executeModelNameSearchTask(ModelNameSearchTask modelNameSearchTask) Execute the model name search task is not supported by the asynchronous connection.
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.
java.lang.String	toString() Return a string representation for the internal parameters of the class.

Methods inherited from class java.lang.Object

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

Constructor Detail

AsynchronousDBConnection

public AsynchronousDBConnection()
                         throws DBConnectionException

Construct an instance that creates the taskQueue to enqueue tasks and the executor thread that enables task execution in parallel.

Throws:

DBConnectionException - If thrown while creating a connection.

Method Detail

abortConnection

public void abortConnection()

Abort the execution by setting the execution flag as false. Abort connection signifies that the execution needs to be terminated as there was some error in execution.

Specified by:

abortConnection in interface DBConnection

closeConnection

public void closeConnection()
                     throws DBConnectionException

Close the connection if all tasks in the queue are executed successfully. Close connection signifies that the processing is completed.

Specified by:

closeConnection in interface DBConnection

Throws:

DBConnectionException - If thrown while closing a connection.

commitConnection

public void commitConnection()
                      throws DBConnectionException

Commit the transaction running over the connection.

Specified by:

commitConnection in interface DBConnection

Throws:

DBConnectionException - If thrown while committing a transaction in the database.

executeAttributeSearchTask

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

Search models that contain the given attributes in the database. Not supported by this type of connection.

Specified by:

executeAttributeSearchTask in interface DBConnection

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 - If thrown while searching.

executeCreateAttributeTask

public 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.

Specified by:

executeCreateAttributeTask in interface DBConnection

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

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

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

Specified by:

executeCreateModelTask in interface DBConnection

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 - If thrown while creating a model.

ModelAlreadyExistException - Thrown if the model being created already exists.

executeDeleteAttributeTask

public 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.

Specified by:

executeDeleteAttributeTask in interface DBConnection

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

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

Execute Fetch Hierarchy task.

Fetch the parent model hierarchies is not supported by the asynchronous connection. Use a synchronous connection for that.

Specified by:

executeFetchHierarchyTask in interface DBConnection

Parameters:

task - Task that contains the list of models.

Returns:

List of models that contain the parent hierarchies.

Throws:

DBExecutionException - If thrown while searching.

executeGetAttributesTask

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

Get Attributes Task is not supported by the asynchronous connection. Use a synchronous connection for that.

Specified by:

executeGetAttributesTask in interface DBConnection

Parameters:

task - The task to be completed.

Returns:

List The list of attributes in database.

Throws:

DBExecutionException - If thrown while getting attributes from the database.

executeGetFirstLevelParents

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

Fetch the first level parents for the given model is not supported by this connection. Use a synchronous connection for that.

Specified by:

executeGetFirstLevelParents in interface DBConnection

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.

executeGetReferenceStringTask

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

Get the model reference string is not supported by the asynchronous connection. Use a synchronous connection for that.

Specified by:

executeGetReferenceStringTask in interface DBConnection

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.

executeGetModelTask

public XMLDBModel executeGetModelTask(GetModelTask task)
                               throws DBExecutionException

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

Specified by:

executeGetModelTask in interface DBConnection

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.

executeGetCompleteModelTask

public 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.

Specified by:

executeGetCompleteModelTask in interface DBConnection

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.

executeGetListOfAllModels

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

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

Specified by:

executeGetListOfAllModels in interface DBConnection

Returns:

List of models in the database.

Throws:

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

executeGraphSearchTask

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

Search for graph is not supported by the asynchronous connection. Use a synchronous connection for that.

Specified by:

executeGraphSearchTask in interface DBConnection

Parameters:

task - - Task that contains the graph search criteria.

Returns:

- List of models that match the given search criteria.

Throws:

DBExecutionException - If thrown while searching in the database.

executeModelNameSearchTask

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

Execute the model name search task is not supported by the asynchronous connection. Use a synchronous connection for that.

Specified by:

executeModelNameSearchTask in interface DBConnection

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

public java.lang.String executeSaveModelTask(SaveModelTask task)
                                      throws DBExecutionException

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

Specified by:

executeSaveModelTask in interface DBConnection

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 model being saved.

Throws:

DBExecutionException - If thrown while saving model in the database.

executeRemoveModelsTask

public void executeRemoveModelsTask(RemoveModelsTask task)
                             throws DBExecutionException

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

Specified by:

executeRemoveModelsTask in interface DBConnection

Parameters:

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

Throws:

DBExecutionException - Thrown if the operation fails.

executeRenameModelTask

public 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.

Specified by:

executeRenameModelTask in interface DBConnection

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

public 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.

Specified by:

executeUpdateAttributeTask in interface DBConnection

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

public 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.

Specified by:

executeUpdateModelInCache in interface DBConnection

Parameters:

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

Throws:

DBExecutionException - Thrown if the operation fails. already exists.

executeUpdateParentsToNewVersion

public 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.

Specified by:

executeUpdateParentsToNewVersion in interface DBConnection

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.

toString

public java.lang.String toString()

Return a string representation for the internal parameters of the class. Used for verifying during unit testing.

Overrides:

toString in class java.lang.Object

Returns:

String representation of the internal parameters of the class.