at.srfg.miner.clientlib

Class Result

Object

at.srfg.miner.clientlib.Result

All Implemented Interfaces:

Comparable<Result>

public class Result
extends Object
implements Comparable<Result>

Result instances are produced by MINER Tools. A Result consists of a timestamp, a value, and a reference to the proxy where the result was produced.

There is a generic getter getValue() that returns the value as a String. Additionally, there are getters that (try to) convert the String value to an int / long / double.

The class provides a toString() implementation that converts to

 {timestamp}{separator}{value}[{separator}{proxy}]
 

The default separator is "\t". It can be modified via
Result.SEPARATOR = "someString". The proxy name is only printed if it is not null.

For far more flexible ways of converting Results to Strings, please see the ResultFormatter interface. A user can provide his/her own implementation for this interface or make use of implementations that are shipped with the clientlib, e.g. ResultFormatterSimple, ResultFormatterDate, and ResultFormatterDeltaTime.

Utility methods for printing and saving Results are provided in the Results class which makes use of ResultFormatter implementations.

Field Summary

Fields

Modifier and Type	Field and Description
static String	SEPARATOR

Constructor Summary

Constructors

Constructor and Description
Result(long timestamp, String value) Constructs a new Result from a timestamp and a value.
Result(long timestamp, String value, Proxy proxy) Constructs a new Result from a timestamp, a value and a proxy.

Method Summary

Methods

Modifier and Type	Method and Description
int	compareTo(Result o)
double	getDouble() Gets the result value converted to a double.
int	getInt() Gets the result value converted to an int.
long	getLong() Gets the result value converted to a long.
Proxy	getProxy() Gets the proxy where the result was generated.
long	getTimestamp() Gets the timestamp of the result as set by the tool that produced it.
String	getValue() Gets the String representation of the result value.
void	setProxy(Proxy proxy) Sets the proxy where the result was generated.
String	toString()

Methods inherited from class Object

equals, getClass, hashCode, notify, notifyAll, wait, wait, wait

Field Detail

SEPARATOR

public static String SEPARATOR

Constructor Detail

Result

public Result(long timestamp,
      String value)

Constructs a new Result from a timestamp and a value.

Parameters:

timestamp - The timestamp

value - The value in String representation

Result

public Result(long timestamp,
      String value,
      Proxy proxy)

Constructs a new Result from a timestamp, a value and a proxy.

Parameters:

timestamp - The timestamp

value - The value in String representation

proxy - the proxy where the result was generated

Method Detail

getTimestamp

public long getTimestamp()

Gets the timestamp of the result as set by the tool that produced it.

Returns:

the timestamp

getValue

public String getValue()

Gets the String representation of the result value. This method works for any type of result. Depending on the type of result (and the intended processing of the result value) it might be more convenient to invoke getInt(), getLong(), or getDouble(), respectively.

Returns:

the value in String representation

getInt

public int getInt()

Gets the result value converted to an int.

Returns:

the value as an int

getLong

public long getLong()

Gets the result value converted to a long.

Returns:

the value as a long

getDouble

public double getDouble()

Gets the result value converted to a double.

Returns:

the value as a double

toString

public String toString()

Overrides:

toString in class Object

getProxy

public Proxy getProxy()

Gets the proxy where the result was generated.

Returns:

the proxy

setProxy

public void setProxy(Proxy proxy)

Sets the proxy where the result was generated.

Parameters:

proxy - the proxy to set

compareTo

public int compareTo(Result o)

Specified by:

compareTo in interface Comparable<Result>