com.etherios.connector.core

Class DataPoint

java.lang.Object

com.etherios.connector.core.DataPoint

public class DataPoint
extends java.lang.Object

This class represents a Device Cloud Data Point used to store data in a specific data stream. This data point class allows several data types, each one with an specific constructor.

These data points includes other features such as timestamp, description, quality and location, that can be optionally configured.

Data points can be sent to Device Cloud using the following methods from Cloud Connector object:

• AbstractCloudConnector.sendDataPoint(DataPoint)
• AbstractCloudConnector.sendDataPoint(java.util.List)

See Also:

DataStream, BinaryDataPoint

Field Summary

Fields

Modifier and Type	Field and Description
static java.lang.String	DESCRIPTION_UNUSED Constant defining the description is not used.
static Location	LOCATION_UNUSED Constant defining the location is not used.
static java.lang.Integer	QUALITY_UNUSED Constant defining the quality is not used.
static int	TYPE_BINARY Constant defining the binary data point type.
static int	TYPE_DOUBLE Constant defining the double data point type.
static int	TYPE_FLOAT Constant defining the float data point type.
static int	TYPE_INTEGER Constant defining the integer data point type.
static int	TYPE_LONG Constant defining the long data point type.
static int	TYPE_STRING Constant defining the string data point type.
static java.lang.String	USE_DEFAULT_TIMEOUT Constant indicating the defined default timeout should be used.

Constructor Summary

Constructors

Constructor and Description
DataPoint(byte[] data, DataStream stream) Class constructor.
DataPoint(byte[] data, DataStream stream, java.lang.String description, java.lang.String timestamp, java.lang.Integer quality, Location location) Class constructor.
DataPoint(double data, DataStream stream) Class constructor.
DataPoint(double data, DataStream stream, java.lang.String description, java.lang.String timestamp, java.lang.Integer quality, Location location) Class constructor.
DataPoint(float data, DataStream stream) Class constructor.
DataPoint(float data, DataStream stream, java.lang.String description, java.lang.String timestamp, java.lang.Integer quality, Location location) Class constructor.
DataPoint(int data, DataStream stream) Class constructor.
DataPoint(int data, DataStream stream, java.lang.String description, java.lang.String timestamp, java.lang.Integer quality, Location location) Class constructor.
DataPoint(long data, DataStream stream) Class constructor.
DataPoint(long data, DataStream stream, java.lang.String description, java.lang.String timestamp, java.lang.Integer quality, Location location) Class constructor.
DataPoint(java.lang.String data, DataStream stream) Class constructor.
DataPoint(java.lang.String data, DataStream stream, java.lang.String description, java.lang.String timestamp, java.lang.Integer quality, Location location) Class constructor.

Method Summary

Modifier and Type	Method and Description
java.lang.String	getData() Retrieves the data point data.
DataStream	getDataStream() Retrieves the data stream destination of the data point.
java.lang.String	getDescription() Retrieves the data point description.
Location	getLocation() Retrieves the data point location.
java.lang.Integer	getQuality() Retrieves the data point quality.
java.lang.String	getTimestamp() Retrieves the data point timestamp.
int	getType() Retrieves the data point type.
java.lang.String	getTypeName() Retrieves the data point type name.
void	setDescription(java.lang.String description) Sets the data point description.
void	setLocation(Location location) Sets the data point location.
void	setQuality(java.lang.Integer quality) Sets the data point quality.
void	setTimestamp(java.lang.String timestamp) Sets the data point timestamp.
java.lang.String	toCSVFormat(boolean complete) Retrieves the data point in CVS format.
static void	useSystemTime(boolean useSystemTime) Sets whether system time should be used or not when creating data points.

Methods inherited from class java.lang.Object

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

Field Detail

DESCRIPTION_UNUSED

public static java.lang.String DESCRIPTION_UNUSED

Constant defining the description is not used.

LOCATION_UNUSED

public static Location LOCATION_UNUSED

Constant defining the location is not used.

QUALITY_UNUSED

public static java.lang.Integer QUALITY_UNUSED

Constant defining the quality is not used.

TYPE_BINARY

public static final int TYPE_BINARY

Constant defining the binary data point type.

See Also:

Constant Field Values

TYPE_DOUBLE

public static final int TYPE_DOUBLE

Constant defining the double data point type.

See Also:

Constant Field Values

TYPE_FLOAT

public static final int TYPE_FLOAT

Constant defining the float data point type.

See Also:

Constant Field Values

TYPE_INTEGER

public static final int TYPE_INTEGER

Constant defining the integer data point type.

See Also:

Constant Field Values

TYPE_LONG

public static final int TYPE_LONG

Constant defining the long data point type.

See Also:

Constant Field Values

TYPE_STRING

public static final int TYPE_STRING

Constant defining the string data point type.

See Also:

Constant Field Values

USE_DEFAULT_TIMEOUT

public static java.lang.String USE_DEFAULT_TIMEOUT

Constant indicating the defined default timeout should be used.

See Also:

useSystemTime(boolean)

Constructor Detail

DataPoint

public DataPoint(byte[] data,
                 DataStream stream)

Class constructor. Instances a new data point of type binary with the given data value.

By default the system time will be used when creating a new data point, use the static useSystemTime(boolean) method to use Device Cloud time.

Parameters:

data - Data point value.

stream - Data stream destination of this data point.

Throws:

java.lang.IllegalArgumentException - if data == null or if stream == null.

DataPoint

public DataPoint(byte[] data,
                 DataStream stream,
                 java.lang.String description,
                 java.lang.String timestamp,
                 java.lang.Integer quality,
                 Location location)

Class constructor. Instances a new data point of type binary with the given parameters.

Parameters:

data - Data point value.

stream - Data stream destination of this data point.

description - Data point description or DESCRIPTION_UNUSED.

timestamp - Data point timestamp or USE_DEFAULT_TIMEOUT to use the system time (default) or Device Cloud time, depending on the static call to useSystemTime(boolean).

quality - User-defined 32-bit integer value representing the quality of the data in the data point or QUALITY_UNUSED.

location - Data point location or LOCATION_UNUSED.

Throws:

java.lang.IllegalArgumentException - if data == null or if stream == null.

See Also:

DESCRIPTION_UNUSED, USE_DEFAULT_TIMEOUT, QUALITY_UNUSED, LOCATION_UNUSED

DataPoint

public DataPoint(double data,
                 DataStream stream)

Class constructor. Instances a new data point of type double with the given data value.

By default the system time will be used when creating a new data point, use the static useSystemTime(boolean) method to use Device Cloud time.

Parameters:

data - Data point value.

stream - Data stream destination of this data point.

Throws:

java.lang.IllegalArgumentException - if stream == null.

DataPoint

public DataPoint(double data,
                 DataStream stream,
                 java.lang.String description,
                 java.lang.String timestamp,
                 java.lang.Integer quality,
                 Location location)

Class constructor. Instances a new data point of type double with the given parameters.

Parameters:

data - Data point value.

stream - Data stream destination of this data point.

description - Data point description or DESCRIPTION_UNUSED.

timestamp - Data point timestamp or USE_DEFAULT_TIMEOUT to use the system time (default) or Device Cloud time, depending on the static call to useSystemTime(boolean).

quality - User-defined 32-bit integer value representing the quality of the data in the data point or QUALITY_UNUSED.

location - Data point location or LOCATION_UNUSED.

Throws:

java.lang.IllegalArgumentException - if stream == null.

See Also:

DESCRIPTION_UNUSED, USE_DEFAULT_TIMEOUT, QUALITY_UNUSED, LOCATION_UNUSED

DataPoint

public DataPoint(float data,
                 DataStream stream)

Class constructor. Instances a new data point of type float with the given data value.

By default the system time will be used when creating a new data point, use the static useSystemTime(boolean) method to use Device Cloud time.

Parameters:

data - Data point value.

stream - Data stream destination of this data point.

Throws:

java.lang.IllegalArgumentException - if stream == null.

DataPoint

public DataPoint(float data,
                 DataStream stream,
                 java.lang.String description,
                 java.lang.String timestamp,
                 java.lang.Integer quality,
                 Location location)

Class constructor. Instances a new data point of type float with the given parameters.

Parameters:

data - Data point value.

stream - Data stream destination of this data point.

description - Data point description or DESCRIPTION_UNUSED.

timestamp - Data point timestamp or USE_DEFAULT_TIMEOUT to use the system time (default) or Device Cloud time, depending on the static call to useSystemTime(boolean).

quality - User-defined 32-bit integer value representing the quality of the data in the data point or QUALITY_UNUSED.

location - Data point location or LOCATION_UNUSED.

Throws:

java.lang.IllegalArgumentException - if stream == null.

See Also:

DESCRIPTION_UNUSED, USE_DEFAULT_TIMEOUT, QUALITY_UNUSED, LOCATION_UNUSED

DataPoint

public DataPoint(int data,
                 DataStream stream)

Class constructor. Instances a new data point of type integer with the given data value.

By default the system time will be used when creating a new data point, use the static useSystemTime(boolean) method to use Device Cloud time.

Parameters:

data - Data point value.

stream - Data stream destination of this data point.

Throws:

java.lang.IllegalArgumentException - if stream == null.

DataPoint

public DataPoint(int data,
                 DataStream stream,
                 java.lang.String description,
                 java.lang.String timestamp,
                 java.lang.Integer quality,
                 Location location)

Class constructor. Instances a new data point of type integer with the given parameters.

Parameters:

data - Data point value.

stream - Data stream destination of this data point.

description - Data point description or DESCRIPTION_UNUSED.

timestamp - Data point timestamp or USE_DEFAULT_TIMEOUT to use the system time (default) or Device Cloud time, depending on the static call to useSystemTime(boolean).

quality - User-defined 32-bit integer value representing the quality of the data in the data point or QUALITY_UNUSED.

location - Data point location or LOCATION_UNUSED.

Throws:

java.lang.IllegalArgumentException - if stream == null.

See Also:

DESCRIPTION_UNUSED, USE_DEFAULT_TIMEOUT, QUALITY_UNUSED, LOCATION_UNUSED

DataPoint

public DataPoint(long data,
                 DataStream stream)

Class constructor. Instances a new data point of type long with the given data value.

By default the system time will be used when creating a new data point, use the static useSystemTime(boolean) method to use Device Cloud time.

Parameters:

data - Data point value.

stream - Data stream destination of this data point.

Throws:

java.lang.IllegalArgumentException - if stream == null.

DataPoint

public DataPoint(long data,
                 DataStream stream,
                 java.lang.String description,
                 java.lang.String timestamp,
                 java.lang.Integer quality,
                 Location location)

Class constructor. Instances a new data point of type long with the given parameters.

Parameters:

data - Data point value.

stream - Data stream destination of this data point.

description - Data point description or DESCRIPTION_UNUSED.

timestamp - Data point timestamp or USE_DEFAULT_TIMEOUT to use the system time (default) or Device Cloud time, depending on the static call to useSystemTime(boolean).

quality - User-defined 32-bit integer value representing the quality of the data in the data point or QUALITY_UNUSED.

location - Data point location or LOCATION_UNUSED.

Throws:

java.lang.IllegalArgumentException - if stream == null.

See Also:

DESCRIPTION_UNUSED, USE_DEFAULT_TIMEOUT, QUALITY_UNUSED, LOCATION_UNUSED

DataPoint

public DataPoint(java.lang.String data,
                 DataStream stream)

Class constructor. Instances a new data point of type string with the given data value.

By default the system time will be used when creating a new data point, use the static useSystemTime(boolean) method to use Device Cloud time.

Parameters:

data - Data point value.

stream - Data stream destination of this data point.

Throws:

java.lang.IllegalArgumentException - if data == null or if stream == null.

DataPoint

public DataPoint(java.lang.String data,
                 DataStream stream,
                 java.lang.String description,
                 java.lang.String timestamp,
                 java.lang.Integer quality,
                 Location location)

Class constructor. Instances a new data point of type string with the given parameters.

Parameters:

data - Data point value.

stream - Data stream destination of this data point.

description - Data point description or DESCRIPTION_UNUSED.

timestamp - Data point timestamp or USE_DEFAULT_TIMEOUT to use the system time (default) or Device Cloud time, depending on the static call to useSystemTime(boolean).

quality - User-defined 32-bit integer value representing the quality of the data in the data point or QUALITY_UNUSED.

location - Data point location or LOCATION_UNUSED.

Throws:

java.lang.IllegalArgumentException - if data == null or if stream == null.

See Also:

DESCRIPTION_UNUSED, USE_DEFAULT_TIMEOUT, QUALITY_UNUSED, LOCATION_UNUSED

Method Detail

getData

public java.lang.String getData()

Retrieves the data point data.

Returns:

The data point data.

getDataStream

public DataStream getDataStream()

Retrieves the data stream destination of the data point.

Returns:

the data stream destination of the data point.

getDescription

public java.lang.String getDescription()

Retrieves the data point description.

Returns:

The data point description or DESCRIPTION_UNUSED if the description was not provided.

See Also:

DESCRIPTION_UNUSED, setDescription(String)

getLocation

public Location getLocation()

Retrieves the data point location.

Returns:

The data point location or LOCATION_UNUSED if the location was not provided.

See Also:

LOCATION_UNUSED, setLocation(Location)

getQuality

public java.lang.Integer getQuality()

Retrieves the data point quality.

Returns:

User-defined 32-bit integer value representing the quality of the data in the data point or QUALITY_UNUSED if the quality was not provided.

See Also:

QUALITY_UNUSED, setQuality(Integer)

getTimestamp

public java.lang.String getTimestamp()

Retrieves the data point timestamp.

Returns:

The data point timestamp or USE_DEFAULT_TIMEOUT if the Device Cloud time will be used.

See Also:

USE_DEFAULT_TIMEOUT, useSystemTime(boolean), setTimestamp(String)

getType

public int getType()

Retrieves the data point type.

Returns:

The data point type.

See Also:

TYPE_BINARY, TYPE_DOUBLE, TYPE_FLOAT, TYPE_INTEGER, TYPE_LONG, TYPE_STRING, getTypeName()

getTypeName

public java.lang.String getTypeName()

Retrieves the data point type name.

Returns:

The data point type name.

See Also:

TYPE_BINARY, TYPE_DOUBLE, TYPE_FLOAT, TYPE_INTEGER, TYPE_LONG, TYPE_STRING, getType()

setDescription

public void setDescription(java.lang.String description)

Sets the data point description.

Parameters:

description - The data point description.

See Also:

DESCRIPTION_UNUSED, getDescription()

setLocation

public void setLocation(Location location)

Sets the data point location.

Parameters:

location - The data point location.

See Also:

LOCATION_UNUSED, getLocation()

setQuality

public void setQuality(java.lang.Integer quality)

Sets the data point quality.

Parameters:

quality - User-defined 32-bit integer value representing the quality of the data in the data point.

See Also:

QUALITY_UNUSED, getQuality()

setTimestamp

public void setTimestamp(java.lang.String timestamp)

Sets the data point timestamp. If set to USE_DEFAULT_TIMEOUT, the defined default timestamp will be used.

Parameters:

timestamp - Data point timestamp or USE_DEFAULT_TIMEOUT to use the system time (default) or Device Cloud time, depending on the static call to useSystemTime(boolean).

See Also:

USE_DEFAULT_TIMEOUT, useSystemTime(boolean), getTimestamp()

toCSVFormat

public java.lang.String toCSVFormat(boolean complete)

Retrieves the data point in CVS format.

Parameters:

complete - if true the stream data (datatype, units, forwardTo) is also added to the CSV string, false otherwise.

Returns:

Data point in CSV format.

useSystemTime

public static void useSystemTime(boolean useSystemTime)

Sets whether system time should be used or not when creating data points.

Parameters:

useSystemTime - true to use system time, false to use Device Cloud time.