org.wattdepot.client.http.api.performance

Class PerformanceTimedTask

java.lang.Object

java.util.TimerTask

org.wattdepot.client.http.api.performance.PerformanceTimedTask

All Implemented Interfaces:

Runnable

Direct Known Subclasses:

GetDateValueTask, GetEarliestValueTask, GetIntervalValueTask, GetLatestValueTask, PutTask

public abstract class PerformanceTimedTask
extends TimerTask

PerformanceTimedTask times a query from the WattDepot Server.

Author:

Cam Moore

Field Summary

Fields

Modifier and Type	Field and Description
protected WattDepotClient	client The client used to communicate with the WattDepot server.
protected boolean	debug Flag for debugging messages.
protected CollectorProcessDefinition	definition The definition about the collector.
protected Depository	depository The Depository for storing measurements.
protected Sensor	sensor The sensor to get the latest value for.

Constructor Summary

Constructors

Constructor and Description
PerformanceTimedTask(String serverUri, String username, String orgId, String password, boolean debug) Initializes the GetLatestValueTask.
PerformanceTimedTask(String serverUri, String username, String orgId, String password, boolean debug, String collectorId) Initializes the GetLatestValueTask.

Method Summary

Methods

Modifier and Type	Method and Description
abstract void	clientTask() The client task to time.
Double	getAverageTime()
Long	getMaxTime()
Long	getMinTime()
Long	getNumberOfRuns()
Long	getTotalTime()
void	run()

Methods inherited from class java.util.TimerTask

cancel, scheduledExecutionTime

Methods inherited from class java.lang.Object

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

Field Detail

debug

protected boolean debug

Flag for debugging messages.

definition

protected CollectorProcessDefinition definition

The definition about the collector.

client

protected WattDepotClient client

The client used to communicate with the WattDepot server.

depository

protected Depository depository

The Depository for storing measurements.

sensor

protected Sensor sensor

The sensor to get the latest value for.

Constructor Detail

PerformanceTimedTask

public PerformanceTimedTask(String serverUri,
                    String username,
                    String orgId,
                    String password,
                    boolean debug)
                     throws BadCredentialException,
                            IdNotFoundException,
                            BadSensorUriException

Initializes the GetLatestValueTask.

Parameters:

serverUri - The URI for the WattDepot server.

username - The name of a user defined in the WattDepot server.

orgId - the id of the organization the user is in.

password - The password for the user.

debug - flag for debugging messages.

Throws:

BadCredentialException - if the user or password don't match the credentials in WattDepot.

IdNotFoundException - if the processId is not defined.

BadSensorUriException - if the Sensor's URI isn't valid.

PerformanceTimedTask

public PerformanceTimedTask(String serverUri,
                    String username,
                    String orgId,
                    String password,
                    boolean debug,
                    String collectorId)
                     throws BadCredentialException,
                            IdNotFoundException,
                            BadSensorUriException

Initializes the GetLatestValueTask.

Parameters:

serverUri - The URI for the WattDepot server.

username - The name of a user defined in the WattDepot server.

orgId - the id of the organization the user is in.

password - The password for the user.

debug - flag for debugging messages.

collectorId - the CollectorProcessDefinition id.

Throws:

BadCredentialException - if the user or password don't match the credentials in WattDepot.

IdNotFoundException - if the processId is not defined.

BadSensorUriException - if the Sensor's URI isn't valid.

Method Detail

getAverageTime

public Double getAverageTime()

Returns:

average put time.

getMaxTime

public Long getMaxTime()

Returns:

the maxGetTime

getMinTime

public Long getMinTime()

Returns:

the minGetTime

getNumberOfRuns

public Long getNumberOfRuns()

Returns:

the numberOfRuns

getTotalTime

public Long getTotalTime()

Returns:

the totalTime

clientTask

public abstract void clientTask()

The client task to time.

run

public void run()

Specified by:

run in interface Runnable

Specified by:

run in class TimerTask