saaps.dbt
Interface DatabaseRMI

All Known Implementing Classes:

DatabaseRMIImpl

public interface DatabaseRMI

extends java.rmi.Remote

Remote interface for Database access.

Method Summary

java.util.Vector	getData(java.lang.String theDb, java.util.Date sd, java.util.Date ed) Gets a Vector of Database objects.
java.util.Vector	getDatabaseList() Gets a list of available Databases.
MetaData	getMetaData(java.lang.String theDb) Gets the MetaData for this Database.
NetworkParam	getNetworkParam(java.lang.String netParam) Gets the parameters for the neural network.
NormParam	getNormParam(java.lang.String normParam, int nof) Gets the normalization parameters needed for the preprocessing of a TimeSeries object before it is input to a network.
TimeSeries	getTimeSeries(java.lang.String theDb, java.util.Date sd, java.util.Date ed) Gets a TimeSeries object.
TimeSeries	retrieveElFluence()
TimeSeries	retrieveElFluence(java.util.Date d)
ObjectTimeSeries	retrieveOTS(java.lang.String theDB, java.util.Date sd, java.util.Date ed, boolean before) Gets an ObjectTimeSeries containing data between the dates.
TimeSeries	retrieveSEA(java.lang.String theDB, int fieldIndex, java.util.Date[] events, long start, long end, boolean withAdditionalInfo) Retrieves a TimeSeries object containing the averaged data for the input event list.

Method Detail

getDatabaseList

public java.util.Vector getDatabaseList()
                                 throws java.rmi.RemoteException

Gets a list of available Databases.

Returns:

Vector of Database names

Throws:

java.rmi.RemoteException - network/io problem

getMetaData

public MetaData getMetaData(java.lang.String theDb)
                     throws java.rmi.RemoteException

Gets the MetaData for this Database.

Parameters:

theDb - Database name

Returns:

MetaData for this Database

Throws:

java.rmi.RemoteException - network/io problem

getData

public java.util.Vector getData(java.lang.String theDb,
                                java.util.Date sd,
                                java.util.Date ed)
                         throws java.rmi.RemoteException,
                                java.io.IOException

Gets a Vector of Database objects.

Parameters:

theDb - Database name

sd - start date/time

ed - end date/time

Throws:

java.rmi.RemoteException - network/io problem

java.io.IOException - when io problem or no data for this time

getTimeSeries

public TimeSeries getTimeSeries(java.lang.String theDb,
                                java.util.Date sd,
                                java.util.Date ed)
                         throws java.rmi.RemoteException,
                                java.io.IOException

Gets a TimeSeries object.

Parameters:

theDb - Database name

sd - start date/time

ed - end date/time

Returns:

TimeSeries

Throws:

java.rmi.RemoteException - network/io problem

java.io.IOException - when io problem or no data for this time

retrieveOTS

public ObjectTimeSeries retrieveOTS(java.lang.String theDB,
                                    java.util.Date sd,
                                    java.util.Date ed,
                                    boolean before)
                             throws java.io.IOException,
                                    IllegalTimeSeriesException

Gets an ObjectTimeSeries containing data between the dates.

Parameters:

theDB - SAAPS database name

sd - start date for search

ed - end date for search

before - if true then the first object returned is before the start search date.

Returns:

the ObjectTimeSeries

retrieveSEA

public TimeSeries retrieveSEA(java.lang.String theDB,
                              int fieldIndex,
                              java.util.Date[] events,
                              long start,
                              long end,
                              boolean withAdditionalInfo)
                       throws java.rmi.RemoteException,
                              TimeSeriesIndexException,
                              IllegalTimeSeriesException,
                              java.io.IOException

Retrieves a TimeSeries object containing the averaged data for the input event list. See also Database.retrieveSEA(int, Date[], long, long, boolean ).

Parameters:

theDB - name of the SAAPS Database

fieldIndex - index of the data field

events - array of event times

start - event window starts here (normally negative [milliseconds])

end - event window ends here (normally positiv [milliseconds])

withAdditionalInfo - if true get also the number of data points and the standard deviation from the average.

Returns:

TimeSeries object with fieldName data for start to end time for every event

Throws:

TimeSeriesIndexException - when fieldIndex is out of bounds

java.io.IOException - when data for any of the event times are missing

getNetworkParam

public NetworkParam getNetworkParam(java.lang.String netParam)
                             throws java.rmi.RemoteException

Gets the parameters for the neural network.

Parameters:

netParam - network parameter name

Returns:

NetworkParam

Throws:

java.rmi.RemoteException - network/io problem

getNormParam

public NormParam getNormParam(java.lang.String normParam,
                              int nof)
                       throws java.rmi.RemoteException

Gets the normalization parameters needed for the preprocessing of a TimeSeries object before it is input to a network.

Parameters:

normParam - normalization parameter name

nof - number of fields

Returns:

NormParam

Throws:

java.rmi.RemoteException - network/io problem

retrieveElFluence

public TimeSeries retrieveElFluence()
                             throws java.rmi.RemoteException

retrieveElFluence

public TimeSeries retrieveElFluence(java.util.Date d)
                             throws java.rmi.RemoteException