dms.dss
Class DataSession

java.lang.Object
  |
  +--dms.dss.DataSession
Direct Known Subclasses:
PerfDBSession

public abstract class DataSession
extends java.lang.Object

This is the top level class for the API.

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


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

Field Detail

application

protected dms.dss.Application application

experiment

protected dms.dss.Experiment experiment

trials

protected java.util.Vector trials

nodes

protected java.util.Vector nodes

contexts

protected java.util.Vector contexts

threads

protected java.util.Vector threads

functions

protected java.util.Vector functions

functionData

protected java.util.Vector functionData

userEvents

protected java.util.Vector userEvents

userEventData

protected java.util.Vector userEventData

PERFDB_NONE

public static int PERFDB_NONE
Constructor Detail

DataSession

public DataSession()
Method Detail

initialize

public abstract void initialize(java.lang.Object obj)
Initialize the DataSession object.

Parameters:
obj - an implementation-specific object required to initialize the DataSession

terminate

public abstract void terminate()
Terminate the DataSession object.


getApplicationList

public abstract java.util.ListIterator getApplicationList()
Returns a ListIterator of Application objects.

Returns:
DataSessionIterator object of all Applications.
See Also:
DataSessionIterator, Application

getExperimentList

public abstract java.util.ListIterator getExperimentList()
Returns a ListIterator of Experiment objects

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, setApplication(dms.dss.Application)

getTrialList

public abstract java.util.ListIterator getTrialList()
Returns a ListIterator of Trial objects

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, setApplication(dms.dss.Application), setExperiment(dms.dss.Experiment)

setApplication

public void setApplication(dms.dss.Application application)
Set the Application for this DataSession. The DataSession object will maintain a reference to the Application object. To clear this reference, call setApplication(Application) with a null reference.

Parameters:
application - Application object to be saved.
See Also:
Application

setApplication

public abstract dms.dss.Application setApplication(int id)
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.

Parameters:
id - unique id of the Application object to be saved.
See Also:
Application, setApplication(Application)

setApplication

public abstract dms.dss.Application setApplication(java.lang.String name,
                                                   java.lang.String version)
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.

Parameters:
version - version of the Application object to be saved.
See Also:
Application, setApplication(Application)

setExperiment

public void setExperiment(dms.dss.Experiment experiment)
Set the Experiment for this DataSession. The DataSession object will maintain a reference to the Experiment object. To clear this reference, call setExperiment(Experiment) with a null reference.

Parameters:
experiment - Experiment object to be saved.
See Also:
Experiment

setExperiment

public abstract dms.dss.Experiment setExperiment(int id)
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.

Parameters:
id - unique id of the Experiment object to be saved.
See Also:
Experiment, setExperiment(Experiment)

setTrial

public void setTrial(dms.dss.Trial trial)
Set the Trial for this DataSession. The DataSession object will maintain a reference to the Trial object. To clear this reference, call setTrial(Trial) with a null reference.

Parameters:
trial - Trial object to be saved.
See Also:
Trial

setTrial

public void setTrial(java.util.Vector trials)
Set a Vector of Trial objects for this DataSession. The DataSession object will maintain a reference to a Vector of Trial objects. To clear this reference, call setTrial(Trial) with a null reference.

Parameters:
trials - Vector of Trial objects to be saved.
See Also:
Trial

setTrial

public abstract dms.dss.Trial setTrial(int id)
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.

Parameters:
id - unique id of the Trial object to be saved.
See Also:
Trial, setTrial(Trial)

setNode

public void setNode(int node)
Set the node for this DataSession. The DataSession object will maintain the value of the node identified by the id. To clear this value, call setNode(int) with DataSession.PERFDB_NONE.

Parameters:
node - value of the node to be saved.
See Also:
PERFDB_NONE

setNode

public void setNode(java.util.Vector nodes)
Set a Vector of node values for this DataSession. The DataSession object will maintain a reference to the Vector of node values. To clear this reference, call setNode(int) with DataSession.PERFDB_NONE.

Parameters:
nodes - Vector of node values to be saved.
See Also:
PERFDB_NONE

setContext

public void setContext(int context)
Set the context for this DataSession. The DataSession object will maintain the value of the context identified by the id. To clear this value, call setContext(int) with DataSession.PERFDB_NONE.

Parameters:
context - value of the context to be saved.
See Also:
PERFDB_NONE

setContext

public void setContext(java.util.Vector contexts)
Set a Vector of context values for this DataSession. The DataSession object will maintain a reference to the Vector of context values. To clear this reference, call setContext(int) with DataSession.PERFDB_NONE.

See Also:
PERFDB_NONE

setThread

public void setThread(int thread)
Set the thread for this DataSession. The DataSession object will maintain the value of the thread identified by the id. To clear this value, call setThread(int) with DataSession.PERFDB_NONE.

Parameters:
thread - value of the thread to be saved.
See Also:
PERFDB_NONE

setThread

public void setThread(java.util.Vector threads)
Set a Vector of thread values for this DataSession. The DataSession object will maintain a reference to the Vector of thread values. To clear this reference, call setThread(int) with DataSession.PERFDB_NONE.

Parameters:
threads - Vector of thread values to be saved.
See Also:
PERFDB_NONE

getFunctions

public abstract java.util.ListIterator getFunctions()
Returns a ListIterator of Function objects.

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, setApplication(dms.dss.Application), setExperiment(dms.dss.Experiment), setTrial(dms.dss.Trial), setNode(int), setContext(int), setThread(int)

setFunction

public void setFunction(dms.dss.Function function)
Set the Function for this DataSession. The DataSession object will maintain a reference to the Function object. To clear this reference, call setFunction(Function) with a null reference.

Parameters:
function - Function object to be saved.
See Also:
Function, setFunction(Function)

setFunction

public abstract dms.dss.Function setFunction(int id)
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.

Parameters:
id - unique id of the Function object to be saved.
See Also:
Function, setFunction(Function)

setFunction

public void setFunction(java.util.Vector functions)
Set a Vector of Function objects for this DataSession. The DataSession object will maintain a reference to a Vector of Function objects. To clear this reference, call setFunction(Function) with a null reference.

Parameters:
functions - Vector of Function objects to be saved.
See Also:
Function, setFunction(Function)

getFunction

public abstract dms.dss.Function getFunction(int functionID)
Returns the Function identified by the unique function id.

Returns:
Function object identified by the unique function id.
See Also:
Function

getUserEvents

public abstract java.util.ListIterator getUserEvents()
Returns a ListIterator of UserEvent objects.

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, setApplication(dms.dss.Application), setExperiment(dms.dss.Experiment), setTrial(dms.dss.Trial), setNode(int), setContext(int), setThread(int)

setUserEvent

public void setUserEvent(dms.dss.UserEvent userEvent)
Set the UserEvent for this DataSession. The DataSession object will maintain a reference to the UserEvent object. To clear this reference, call setUserEvent(UserEvent) with a null reference.

Parameters:
userEvent - UserEvent object to be saved.
See Also:
UserEvent, setUserEvent(UserEvent)

setUserEvent

public abstract dms.dss.UserEvent setUserEvent(int id)
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.

Parameters:
id - unique id of the UserEvent object to be saved.
See Also:
UserEvent, setUserEvent(UserEvent)

setUserEvent

public void setUserEvent(java.util.Vector userEvents)
Set a Vector of UserEvent objects for this DataSession. The DataSession object will maintain a reference to a Vector of UserEvent objects. To clear this reference, call setUserEvent(UserEvent) with a null reference.

Parameters:
userEvents - Vector of UserEvent objects to be saved.
See Also:
UserEvent, setUserEvent(UserEvent)

getUserEvent

public abstract dms.dss.UserEvent getUserEvent(int userEventID)
Returns the UserEvent identified by the unique user event id.

Returns:
UserEvent object identified by the unique user event id.
See Also:
UserEvent

getFunctionData

public abstract java.util.ListIterator getFunctionData()
Returns the FunctionData for this 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, setApplication(dms.dss.Application), setExperiment(dms.dss.Experiment), setTrial(dms.dss.Trial), setNode(int), setContext(int), setThread(int), setFunction(dms.dss.Function)

getUserEventData

public abstract java.util.ListIterator getUserEventData()
Returns the UserEventData for this 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, setApplication(dms.dss.Application), setExperiment(dms.dss.Experiment), setTrial(dms.dss.Trial), setNode(int), setContext(int), setThread(int), setUserEvent(dms.dss.UserEvent)