ptdb.kernel.bl.load

Class LoadManager

java.lang.Object

ptdb.kernel.bl.load.LoadManager

public class LoadManager
extends java.lang.Object

The business layer is used by the GUI to pass models to load. It uses the LoadManager to interface with the database to get MoML strings.

Since:

Ptolemy II 10.0

Version:

$Id$

Author:

Lyle Holsinger

Pt.AcceptedRating:

red (lholsing)

Pt.ProposedRating:

red (lholsing)

Field Summary

Fields

Modifier and Type	Field and Description
static int	NO_OF_ITEMS_PER_PAGE Number of results displayed per page on the models list page.

Constructor Summary

Constructors

Constructor and Description
LoadManager()

Method Summary

Modifier and Type	Method and Description
void	getAllModelsFromDatabase() Fetch and store locally the list of all models in the database.
java.util.List<XMLDBModel>	getAllModelsFromDatabase(int pageNumber) Get the list of models for the given page number.
int	getNoOfPages() Get the total number of pages required to display the models list.
int	getTotalNumberOfModels() Get the total number of models in the database.
static Entity	importModel(java.lang.String name, boolean byReference, NamedObj container) Given a model name, return an Entity object.
static PtolemyEffigy	loadModel(java.lang.String name, Configuration configuration) Given a model name, return a PtolemyEffigy objects.
static PtolemyEffigy	loadModelUsingId(java.lang.String id, Configuration configuration) Given a model id, return a PtolemyEffigy objects.

Methods inherited from class java.lang.Object

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

Field Detail

NO_OF_ITEMS_PER_PAGE

public static int NO_OF_ITEMS_PER_PAGE

Number of results displayed per page on the models list page.

Constructor Detail

LoadManager

public LoadManager()

Method Detail

importModel

public static Entity importModel(java.lang.String name,
                                 boolean byReference,
                                 NamedObj container)
                          throws DBConnectionException,
                                 DBExecutionException,
                                 java.lang.Exception,
                                 CircularDependencyException

Given a model name, return an Entity object.

Parameters:

name - The model name. An alphanumeric string without special characters. If no model with the given name is found, return null.

byReference - Indication that the model should be included by reference.

container - The NamedObj that will contain this imported model. It is used here to obtain a unique name.

Returns:

An Entity object that the GUI can display.

Throws:

DBConnectionException - Thrown by DBModelFetcher if a problem occurs with the database connection.

DBExecutionException - Thrown by DBModelFetcher if a problem while executing a command.

java.lang.Exception - Thrown if a problem occurs creating an effigy from the MoML.

CircularDependencyException - Thrown if an import would result in a circular dependency.

loadModel

public static PtolemyEffigy loadModel(java.lang.String name,
                                      Configuration configuration)
                               throws DBConnectionException,
                                      DBExecutionException,
                                      java.lang.Exception

Given a model name, return a PtolemyEffigy objects.

Parameters:

name - The model name. An alphanumeric string without special characters. If no model with the given name is found, return null.

configuration - The configuration used to create the effigy.

Returns:

A PtolemyEffigy object that the GUI can display.

Throws:

DBConnectionException - Thrown by DBModelFetcher if a problem occurs with the database connection.

DBExecutionException - Thrown by DBModelFetcher if a problem while executing a command.

java.lang.Exception - Thrown if a problem occurs creating an effigy from the MoML.

loadModelUsingId

public static PtolemyEffigy loadModelUsingId(java.lang.String id,
                                             Configuration configuration)
                                      throws DBConnectionException,
                                             DBExecutionException,
                                             java.lang.Exception

Given a model id, return a PtolemyEffigy objects.

Parameters:

id - The model id. An alphanumeric string without special characters. If no model with the given name is found, return null.

configuration - The configuration used to create the effigy.

Returns:

A PtolemyEffigy object that the GUI can display.

Throws:

DBConnectionException - Thrown by DBModelFetcher if a problem occurs with the database connection.

DBExecutionException - Thrown by DBModelFetcher if a problem while executing a command.

java.lang.Exception - Thrown if a problem occurs creating an effigy from the MoML.

getAllModelsFromDatabase

public java.util.List<XMLDBModel> getAllModelsFromDatabase(int pageNumber)
                                                    throws DBConnectionException,
                                                           DBExecutionException

Get the list of models for the given page number.

Parameters:

pageNumber - Page number of the page whose models need to be fetched.

Returns:

List of models from the given page.

Throws:

DBConnectionException - If thrown while connecting to the database.

DBExecutionException - If thrown while executing query in the database.

getAllModelsFromDatabase

public void getAllModelsFromDatabase()
                              throws DBConnectionException,
                                     DBExecutionException

Fetch and store locally the list of all models in the database.

Throws:

DBConnectionException - If thrown while connecting to the database.

DBExecutionException - If thrown while executing the query in the database.

getTotalNumberOfModels

public int getTotalNumberOfModels()
                           throws DBConnectionException,
                                  DBExecutionException

Get the total number of models in the database.

Returns:

Total number of models in the database.

Throws:

DBConnectionException - If thrown while connecting to the database.

DBExecutionException - If thrown while executing the query in the database.

getNoOfPages

public int getNoOfPages()
                 throws DBConnectionException,
                        DBExecutionException

Get the total number of pages required to display the models list.

Returns:

Total number of pages in the models list.

Throws:

DBConnectionException - If thrown while connecting to the database.

DBExecutionException - If thrown while executing the query in the database.