org.jini.rio.watch

Interface WatchDataSource

All Superinterfaces:

Remote

public interface WatchDataSource
extends Remote

The WatchDataSource interface defines the semantics for a Watch to store Calculable records

Method Summary

Modifier and Type	Method and Description
void	addCalculable(Calculable calculable) Add a Calculable record to the Calculable history
void	clear() Clears the history
void	close() Closes the watch data source and unexports it from the runtime
Calculable[]	getCalculable() Get all Calculable records from the Calculable history
Calculable[]	getCalculable(int offset, int length) Get Calculable records from the Calculable history for the specified range
Calculable[]	getCalculable(String id) Get Calculable records from the Calculable history
Calculable[]	getCalculable(String id, int offset, int length) Get Calculable records from the Calculable history
int	getCurrentSize() Get the current size for the Caclulable history
String	getID() Get the ID for the WatchDataSource
Calculable	getLastCalculable() Gets the last Calculable from the history
Calculable	getLastCalculable(String id) Gets the last Calculable from the history
int	getOffset() Get the offset
int	getSize() Get the maximum size for the Calculable history
ThresholdValues	getThresholdValues() Getter for property thresholdValues.
String	getView() Getter for property view.
void	setSize(int size) Set the maximum size for the Calculable history
void	setThresholdValues(ThresholdValues tValues) Set the ThresholdValues
void	setView(String view) Setter for property view.

Method Detail

getID

String getID()
      throws RemoteException

Get the ID for the WatchDataSource

Throws:

RemoteException

getOffset

int getOffset()
       throws RemoteException

Get the offset

Throws:

RemoteException

setSize

void setSize(int size)
      throws RemoteException

Set the maximum size for the Calculable history

Parameters:

size - The maximum size for the Calculable history

Throws:

RemoteException

getSize

int getSize()
     throws RemoteException

Get the maximum size for the Calculable history

Returns:

The maximum size for the Calculable history

Throws:

RemoteException

clear

void clear()
    throws RemoteException

Clears the history

Throws:

RemoteException

getCurrentSize

int getCurrentSize()
            throws RemoteException

Get the current size for the Caclulable history

Returns:

The current size for the Caclulable history

Throws:

RemoteException

addCalculable

void addCalculable(Calculable calculable)
            throws RemoteException

Add a Calculable record to the Calculable history

Parameters:

calculable - The Calculable record

Throws:

RemoteException

getCalculable

Calculable[] getCalculable()
                    throws RemoteException

Get all Calculable records from the Calculable history

Returns:

An array of Calculable records from the Calculable history. If there are no Calculable records in the history, a zero-length array will be returned

Throws:

RemoteException

getCalculable

Calculable[] getCalculable(String id)
                    throws RemoteException

Get Calculable records from the Calculable history

Parameters:

id - The Watch identifier to match

Returns:

Calculable[] An array of Calculable records from the Calculable history that match the Watch id. If there are no Calculable records in the history that maych the Watch id, a zero-length array will be returned

Throws:

RemoteException

getCalculable

Calculable[] getCalculable(int offset,
                           int length)
                    throws RemoteException

Get Calculable records from the Calculable history for the specified range

Parameters:

offset - The index of the first record to fetch

length - The number of records to return

Returns:

An array of Calculable records from the Calculable history within the provided range. If there are no Calculable records in the range, a zero-length array will be returned

Throws:

RemoteException

getCalculable

Calculable[] getCalculable(String id,
                           int offset,
                           int length)
                    throws RemoteException

Get Calculable records from the Calculable history

Parameters:

id - The Watch identifier to match

offset - The index of the first record to match

length - The number of records to compare

Returns:

An array of Calculable records from the Calculable history that match the Watch id within the provided range. If there are no Calculable records in the range that match the Watch ID, a zero-length array will be returned

Throws:

RemoteException

getLastCalculable

Calculable getLastCalculable()
                      throws RemoteException

Gets the last Calculable from the history

Returns:

The last Calculable in the history

Throws:

RemoteException

getLastCalculable

Calculable getLastCalculable(String id)
                      throws RemoteException

Gets the last Calculable from the history

Parameters:

id - The Watch identifier to match

Returns:

The last Calculable in the history that matches the Watch ID

Throws:

RemoteException

getThresholdValues

ThresholdValues getThresholdValues()
                            throws RemoteException

Getter for property thresholdValues.

Returns:

Value of property thresholdValues.

Throws:

RemoteException

setThresholdValues

void setThresholdValues(ThresholdValues tValues)
                 throws RemoteException

Set the ThresholdValues

Throws:

RemoteException

close

void close()
    throws RemoteException

Closes the watch data source and unexports it from the runtime

Throws:

RemoteException

setView

void setView(String view)
      throws RemoteException

Setter for property view.

Parameters:

view - The view class name, suitable for Class.forName

Throws:

RemoteException

getView

String getView()
        throws RemoteException

Getter for property view.

Returns:

The Value of the property view

Throws:

RemoteException