ptdb.kernel.bl.load

Class DBModelFetcher

java.lang.Object

ptdb.kernel.bl.load.DBModelFetcher

public class DBModelFetcher
extends java.lang.Object

This is the business layer that interfaces with the database for retrieving models.

Since:

Ptolemy II 10.0

Version:

$Id$

Author:

Lyle Holsinger

Pt.AcceptedRating:

red (lholsing)

Pt.ProposedRating:

red (lholsing)

Constructor Summary

Constructors

Constructor and Description
DBModelFetcher()

Method Summary

Modifier and Type	Method and Description
static java.util.ArrayList<XMLDBModel>	load(java.util.ArrayList<XMLDBModel> modelList) Given an ArrayList of XMLDBModel objects that are not populated with MoML strings, query the database to obtain the MoML and then return the revised ArrayList.
static XMLDBModel	load(java.lang.String name) Given a model name representing the model to load, return an XMLDBModel object that contains the MoML.
static XMLDBModel	loadUsingId(java.lang.String id) Given a model id representing the model to load, return an XMLDBModel object that contains the MoML.

Methods inherited from class java.lang.Object

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

Constructor Detail

DBModelFetcher

public DBModelFetcher()

Method Detail

loadUsingId

public static XMLDBModel loadUsingId(java.lang.String id)
                              throws DBConnectionException,
                                     DBExecutionException

Given a model id representing the model to load, return an XMLDBModel object that contains the MoML.

Parameters:

id - The id of the model to be loaded.

Returns:

An XMLDBModel object from the Database, containing its MoML string.

Throws:

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

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

load

public static XMLDBModel load(java.lang.String name)
                       throws DBConnectionException,
                              DBExecutionException

Given a model name representing the model to load, return an XMLDBModel object that contains the MoML.

Parameters:

name - The name of the model to be loaded.

Returns:

An XMLDBModel object from the Database, containing its MoML string.

Throws:

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

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

load

public static java.util.ArrayList<XMLDBModel> load(java.util.ArrayList<XMLDBModel> modelList)
                                            throws DBConnectionException,
                                                   DBExecutionException

Given an ArrayList of XMLDBModel objects that are not populated with MoML strings, query the database to obtain the MoML and then return the revised ArrayList.

Parameters:

modelList - An ArrayList of XMLDBModel objects without associated MoML strings.

Returns:

An ArrayList of XMLDBModel objects populated with their respective MoML strings. An empty list is returned if no objects could be added.

Throws:

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

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