com.dracoware.rsplib
Class RspGraphReturnData

java.lang.Object
  extended by com.dracoware.rsplib.RspGraphReturnData

public class RspGraphReturnData
extends java.lang.Object

This class contains the data that details the current graph data of a specific module on an RSPD.


Field Summary
static int GRAPH_BIGSIZE
          Large sized data (gigabytes, terabytes, etc).
static int GRAPH_BOOL
          True or false (0 or 1).
static int GRAPH_MISC
          Of a type other than those listed.
static int GRAPH_NONE
          Graph data has no type.
static int GRAPH_PERCENT
          Percentage (float value between 0 and 1).
static int GRAPH_SMALLSIZE
          Small sized data (bytes, kilobytes, etc).
static int GRAPH_SMALLTIME
          Small amount of time (milliseconds, microseconds, etc).
static int GRAPH_TIME
          Time value.
 
Constructor Summary
RspGraphReturnData(int type, java.lang.String key, java.lang.String data)
          Constructs a RspGraphReturnData object with the given parameters
 
Method Summary
 java.lang.String getData()
          Returns this RspGraphReturnData's data.
 java.lang.String getKey()
          Returns this RspGraphReturnData's key.
 int getType()
          Returns this RspGraphReturnData's type.
 void setData(java.lang.String data)
          Sets this RspGraphReturnData's data.
 void setKey(java.lang.String key)
          Sets this RspGraphReturnData's key.
 void setType(int type)
          Sets this RspGraphReturnData's type.
 
Methods inherited from class java.lang.Object
equals, getClass, hashCode, notify, notifyAll, toString, wait, wait, wait
 

Field Detail

GRAPH_NONE

public static final int GRAPH_NONE
Graph data has no type.

See Also:
Constant Field Values

GRAPH_TIME

public static final int GRAPH_TIME
Time value.

See Also:
Constant Field Values

GRAPH_SMALLTIME

public static final int GRAPH_SMALLTIME
Small amount of time (milliseconds, microseconds, etc).

See Also:
Constant Field Values

GRAPH_BIGSIZE

public static final int GRAPH_BIGSIZE
Large sized data (gigabytes, terabytes, etc).

See Also:
Constant Field Values

GRAPH_SMALLSIZE

public static final int GRAPH_SMALLSIZE
Small sized data (bytes, kilobytes, etc).

See Also:
Constant Field Values

GRAPH_PERCENT

public static final int GRAPH_PERCENT
Percentage (float value between 0 and 1).

See Also:
Constant Field Values

GRAPH_BOOL

public static final int GRAPH_BOOL
True or false (0 or 1).

See Also:
Constant Field Values

GRAPH_MISC

public static final int GRAPH_MISC
Of a type other than those listed.

See Also:
Constant Field Values
Constructor Detail

RspGraphReturnData

public RspGraphReturnData(int type,
                          java.lang.String key,
                          java.lang.String data)
Constructs a RspGraphReturnData object with the given parameters

Parameters:
type - Type of graph data.
key - Name of the key of this data.
data - Data associated with the given key.
Method Detail

getType

public int getType()
Returns this RspGraphReturnData's type.

Returns:
Graph type of this object.

setType

public void setType(int type)
Sets this RspGraphReturnData's type.

Parameters:
type - The type of this object (one of GRAPH_NONE, GRAPH_TIME, GRAPH_SMALLTIME, GRAPH_BIGSIZE, GRAPH_SMALLSIZE, GRAPH_PERCENT, GRAPH_BOOL, GRAPH_MISC)

getKey

public java.lang.String getKey()
Returns this RspGraphReturnData's key.

Returns:
Key for this piece of data.

setKey

public void setKey(java.lang.String key)
Sets this RspGraphReturnData's key.

Parameters:
key - The key to store in this object.

getData

public java.lang.String getData()
Returns this RspGraphReturnData's data.

Returns:
Data for this object.

setData

public void setData(java.lang.String data)
Sets this RspGraphReturnData's data.

Parameters:
data - The data to store in this object.