dms.dss
Class PerfDBSession

java.lang.Object
  |
  +--dms.dss.DataSession
        |
        +--dms.dss.PerfDBSession

public class PerfDBSession
extends DataSession

This is the top level class for the Database implementation of the API.

CVS $Id: PerfDBSession.html,v 1.2 2003/08/01 21:44:26 khuck Exp $


Field Summary
 
Fields inherited from class dms.dss.DataSession
application, contexts, experiment, functionData, functions, nodes, PERFDB_NONE, threads, trials, userEventData, userEvents
 
Constructor Summary
PerfDBSession()
           
 
Method Summary
 java.util.ListIterator getApplicationList()
          Returns a ListIterator of Application objects.
 perfdb.ConnectionManager getConnector()
           
 java.util.ListIterator getExperimentList()
          Returns a ListIterator of Experiment objects
 java.util.Vector getExperimentList(java.lang.String whereClause)
           
 dms.dss.Function getFunction(int id)
          Returns the Function identified by the unique function id.
 java.util.ListIterator getFunctionData()
          Returns the FunctionData for this DataSession
 java.util.ListIterator getFunctions()
          Returns a ListIterator of Function objects.
 java.util.Vector getFunctions(java.lang.String whereClause)
           
 java.util.ListIterator getTrialList()
          Returns a ListIterator of Trial objects
 java.util.Vector getTrialList(java.lang.String whereClause)
           
 dms.dss.UserEvent getUserEvent(int id)
          Returns the UserEvent identified by the unique user event id.
 java.util.ListIterator getUserEventData()
          Returns the UserEventData for this DataSession
 java.util.ListIterator getUserEvents()
          Returns a ListIterator of UserEvent objects.
 java.util.Vector getUserEvents(java.lang.String whereClause)
           
 void initialize(java.lang.Object obj)
          Initialize the DataSession object.
 dms.dss.Application setApplication(int id)
          Set the Application for this DataSession.
 dms.dss.Application setApplication(java.lang.String name, java.lang.String version)
          Set the Application for this DataSession.
 dms.dss.Experiment setExperiment(int id)
          Set the Experiment for this DataSession.
 dms.dss.Function setFunction(int id)
          Set the Function for this DataSession.
 dms.dss.Trial setTrial(int id)
          Set the Trial for this DataSession.
 dms.dss.UserEvent setUserEvent(int id)
          Set the UserEvent for this DataSession.
 void terminate()
          Terminate the DataSession object.
 
Methods inherited from class dms.dss.DataSession
setApplication, setContext, setContext, setExperiment, setFunction, setFunction, setNode, setNode, setThread, setThread, setTrial, setTrial, setUserEvent, setUserEvent
 
Methods inherited from class java.lang.Object
clone, equals, finalize, getClass, hashCode, notify, notifyAll, toString, wait, wait, wait
 

Constructor Detail

PerfDBSession

public PerfDBSession()
Method Detail

initialize

public void initialize(java.lang.Object obj)
Description copied from class: DataSession
Initialize the DataSession object.

Specified by:
initialize in class DataSession
Parameters:
obj - an implementation-specific object required to initialize the DataSession

terminate

public void terminate()
Description copied from class: DataSession
Terminate the DataSession object.

Specified by:
terminate in class DataSession

getConnector

public perfdb.ConnectionManager getConnector()

getApplicationList

public java.util.ListIterator getApplicationList()
Description copied from class: DataSession
Returns a ListIterator of Application objects.

Specified by:
getApplicationList in class DataSession
Returns:
DataSessionIterator object of all Applications.
See Also:
DataSessionIterator, Application

getExperimentList

public java.util.ListIterator getExperimentList()
Description copied from class: DataSession
Returns a ListIterator of Experiment objects

Specified by:
getExperimentList in class DataSession
Returns:
DataSessionIterator object of all Experiments. If there is an Application saved in the DataSession, then only the Experiments for that Application are returned.
See Also:
DataSessionIterator, Experiment, DataSession.setApplication(dms.dss.Application)

getExperimentList

public java.util.Vector getExperimentList(java.lang.String whereClause)

getTrialList

public java.util.ListIterator getTrialList()
Description copied from class: DataSession
Returns a ListIterator of Trial objects

Specified by:
getTrialList in class DataSession
Returns:
DataSessionIterator object of all Trials. If there is an Application and/or Experiment saved in the DataSession, then only the Trials for that Application and/or Experiment are returned.
See Also:
DataSessionIterator, Trial, DataSession.setApplication(dms.dss.Application), DataSession.setExperiment(dms.dss.Experiment)

getTrialList

public java.util.Vector getTrialList(java.lang.String whereClause)

setApplication

public dms.dss.Application setApplication(int id)
Description copied from class: DataSession
Set the Application for this DataSession. The DataSession object will maintain a reference to the Application referenced by the id. To clear this reference, call setApplication(Application) with a null reference.

Specified by:
setApplication in class DataSession
Parameters:
id - unique id of the Application object to be saved.
See Also:
Application, DataSession.setApplication(Application)

setApplication

public dms.dss.Application setApplication(java.lang.String name,
                                          java.lang.String version)
Description copied from class: DataSession
Set the Application for this DataSession. The DataSession object will maintain a reference to the Application referenced by the name and/or version. To clear this reference, call setApplication(Application) with a null reference.

Specified by:
setApplication in class DataSession
Parameters:
version - version of the Application object to be saved.
See Also:
Application, DataSession.setApplication(Application)

setExperiment

public dms.dss.Experiment setExperiment(int id)
Description copied from class: DataSession
Set the Experiment for this DataSession. The DataSession object will maintain a reference to the Experiment referenced by the id. To clear this reference, call setExperiment(Experiment) with a null reference.

Specified by:
setExperiment in class DataSession
Parameters:
id - unique id of the Experiment object to be saved.
See Also:
Experiment, DataSession.setExperiment(Experiment)

setTrial

public dms.dss.Trial setTrial(int id)
Description copied from class: DataSession
Set the Trial for this DataSession. The DataSession object will maintain a reference to the Trial referenced by the id. To clear this reference, call setTrial(Trial) with a null reference.

Specified by:
setTrial in class DataSession
Parameters:
id - unique id of the Trial object to be saved.
See Also:
Trial, DataSession.setTrial(Trial)

getFunctions

public java.util.ListIterator getFunctions()
Description copied from class: DataSession
Returns a ListIterator of Function objects.

Specified by:
getFunctions in class DataSession
Returns:
DataSessionIterator object of all Functions. If there is an Application, Experiment, Trial(s), node(s), context(s) and/or thread(s) saved in the DataSession, then only the Functions for that Application, Experiment, Trial(s), node(s), context(s) and/or thread(s) are returned.
See Also:
DataSessionIterator, Function, DataSession.setApplication(dms.dss.Application), DataSession.setExperiment(dms.dss.Experiment), DataSession.setTrial(dms.dss.Trial), DataSession.setNode(int), DataSession.setContext(int), DataSession.setThread(int)

getFunctions

public java.util.Vector getFunctions(java.lang.String whereClause)

getUserEvents

public java.util.ListIterator getUserEvents()
Description copied from class: DataSession
Returns a ListIterator of UserEvent objects.

Specified by:
getUserEvents in class DataSession
Returns:
DataSessionIterator object of all UserEvents. If there is an Application, Experiment, Trial(s), node(s), context(s) and/or thread(s) saved in the DataSession, then only the UserEvents for that Application, Experiment, Trial(s), node(s), context(s) and/or thread(s) are returned.
See Also:
DataSessionIterator, UserEvent, DataSession.setApplication(dms.dss.Application), DataSession.setExperiment(dms.dss.Experiment), DataSession.setTrial(dms.dss.Trial), DataSession.setNode(int), DataSession.setContext(int), DataSession.setThread(int)

getUserEvents

public java.util.Vector getUserEvents(java.lang.String whereClause)

setFunction

public dms.dss.Function setFunction(int id)
Description copied from class: DataSession
Set the Function for this DataSession. The DataSession object will maintain a reference to the Function referenced by the id. To clear this reference, call setFunction(Function) with a null reference.

Specified by:
setFunction in class DataSession
Parameters:
id - unique id of the Function object to be saved.
See Also:
Function, DataSession.setFunction(Function)

setUserEvent

public dms.dss.UserEvent setUserEvent(int id)
Description copied from class: DataSession
Set the UserEvent for this DataSession. The DataSession object will maintain a reference to the UserEvent referenced by the id. To clear this reference, call setUserEvent(UserEvent) with a null reference.

Specified by:
setUserEvent in class DataSession
Parameters:
id - unique id of the UserEvent object to be saved.
See Also:
UserEvent, DataSession.setUserEvent(UserEvent)

getFunctionData

public java.util.ListIterator getFunctionData()
Description copied from class: DataSession
Returns the FunctionData for this DataSession

Specified by:
getFunctionData in class DataSession
Returns:
DataSessionIterator of FunctionData objects. If there is an Application, Experiment, Trial(s), node(s), context(s), thread(s) and/or Function(s) saved in the DataSession, then only the Functions for that Application, Experiment, Trial(s), node(s), context(s), thread(s) and/or Function(s) are returned.
See Also:
DataSessionIterator, FunctionDataObject, DataSession.setApplication(dms.dss.Application), DataSession.setExperiment(dms.dss.Experiment), DataSession.setTrial(dms.dss.Trial), DataSession.setNode(int), DataSession.setContext(int), DataSession.setThread(int), DataSession.setFunction(dms.dss.Function)

getUserEventData

public java.util.ListIterator getUserEventData()
Description copied from class: DataSession
Returns the UserEventData for this DataSession

Specified by:
getUserEventData in class DataSession
Returns:
DataSessionIterator of UserEventData objects. If there is an Application, Experiment, Trial(s), node(s), context(s), thread(s) and/or Function(s) saved in the DataSession, then only the UserEvents for that Application, Experiment, Trial(s), node(s), context(s), thread(s) and/or Function(s) are returned.
See Also:
DataSessionIterator, UserEventDataObject, DataSession.setApplication(dms.dss.Application), DataSession.setExperiment(dms.dss.Experiment), DataSession.setTrial(dms.dss.Trial), DataSession.setNode(int), DataSession.setContext(int), DataSession.setThread(int), DataSession.setUserEvent(dms.dss.UserEvent)

getFunction

public dms.dss.Function getFunction(int id)
Description copied from class: DataSession
Returns the Function identified by the unique function id.

Specified by:
getFunction in class DataSession
Returns:
Function object identified by the unique function id.
See Also:
Function

getUserEvent

public dms.dss.UserEvent getUserEvent(int id)
Description copied from class: DataSession
Returns the UserEvent identified by the unique user event id.

Specified by:
getUserEvent in class DataSession
Returns:
UserEvent object identified by the unique user event id.
See Also:
UserEvent