com.digi.android.cloudconnector

Class DataPoint

java.lang.Object

com.digi.android.cloudconnector.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 include other features such as description, quality and location, that can be optionally configured.

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

• CloudConnectorManager.sendDataPoint(DataPoint)
• CloudConnectorManager.sendDataPoints(java.util.List)

See Also:

BinaryDataPoint, DataStream

Field Summary

Fields

Modifier and Type	Field and Description
protected java.lang.String	data
protected java.lang.String	description
protected android.location.Location	location
protected int	quality
protected DataStream	stream
protected java.lang.String	timeStamp
protected com.digi.android.cloudconnector.DataPoint.DataPointType	type

Constructor Summary

Constructors

Constructor and Description
DataPoint(byte[] data, DataStream stream) Class constructor.
DataPoint(double data, DataStream stream) Class constructor.
DataPoint(float data, DataStream stream) Class constructor.
DataPoint(int data, DataStream stream) Class constructor.
DataPoint(long data, DataStream stream) Class constructor.
DataPoint(java.lang.String data, DataStream stream) Class constructor.

Method Summary

Modifier and Type	Method and Description
java.lang.String	getData() Returns the data point data.
DataStream	getDataStream() Returns the data-stream destination of the data point.
java.lang.String	getDescription() Returns the data point description.
android.location.Location	getLocation() Returns the data point location.
int	getQuality() Returns the data point quality.
java.lang.String	getTimestamp() Returns the data point time stamp.
void	setDescription(java.lang.String description) Sets the data point description.
void	setLocation(android.location.Location location) Sets the data point location.
void	setQuality(int quality) Sets the data point quality.
java.lang.String	toCSVFormat(boolean complete) Retrieves the data point in CVS format.

Methods inherited from class java.lang.Object

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

Field Detail

data

protected java.lang.String data

description

protected java.lang.String description

timeStamp

protected java.lang.String timeStamp

stream

protected DataStream stream

location

protected android.location.Location location

quality

protected int quality

type

protected com.digi.android.cloudconnector.DataPoint.DataPointType type

Constructor Detail

DataPoint

public DataPoint(int data,
                 DataStream stream)

Class constructor. Instantiates a new DataPoint of type integer with the given data value.

Parameters:

data - Data point value.

stream - Data stream destination of this data point.

Throws:

java.lang.NullPointerException - If stream == null.

See Also:

DataStream

DataPoint

public DataPoint(long data,
                 DataStream stream)

Class constructor. Instantiates a new DataPoint of type long with the given data value.

Parameters:

data - Data point value.

stream - Data stream destination of this data point.

Throws:

java.lang.NullPointerException - If stream == null.

See Also:

DataStream

DataPoint

public DataPoint(float data,
                 DataStream stream)

Class constructor. Instantiates a new DataPoint of type float with the given data value.

Parameters:

data - Data point value.

stream - Data stream destination of this data point.

Throws:

java.lang.NullPointerException - If stream == null.

See Also:

DataStream

DataPoint

public DataPoint(double data,
                 DataStream stream)

Class constructor. Instantiates a new DataPoint of type double with the given data value.

Parameters:

data - Data point value.

stream - Data stream destination of this data point.

Throws:

java.lang.NullPointerException - If stream == null.

See Also:

DataStream

DataPoint

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

Class constructor. Instantiates a new DataPoint of type string with the given data value.

Parameters:

data - Data point value.

stream - Data stream destination of this data point.

Throws:

java.lang.NullPointerException - If data == null or if stream == null.

See Also:

DataStream

DataPoint

public DataPoint(byte[] data,
                 DataStream stream)

Class constructor. Instantiates a new DataPoint of type binary with the given data value.

The binary data is stored as a Base 64 encoded string in Device Cloud. In order to store the binary data in the original format you can use the BinaryDataPoint class with the CloudConnectorManager.sendBinaryDataPoint(BinaryDataPoint) method.

Parameters:

data - Data point value.

stream - Data stream destination of this data point.

Throws:

java.lang.NullPointerException - If data == null or if stream == null.

See Also:

DataStream

Method Detail

getDataStream

public DataStream getDataStream()

Returns the data-stream destination of the data point.

Returns:

The data-stream destination of the data point.

See Also:

DataStream

getData

public java.lang.String getData()

Returns the data point data.

Returns:

The data point data.

getLocation

public android.location.Location getLocation()

Returns the data point location.

Returns:

The data point location.

setLocation

public void setLocation(android.location.Location location)

Sets the data point location.

Parameters:

location - The data point location.

getQuality

public int getQuality()

Returns the data point quality.

Returns:

The data point quality.

setQuality

public void setQuality(int quality)

Sets the data point quality.

Parameters:

quality - The data point quality.

getDescription

public java.lang.String getDescription()

Returns the data point description.

Returns:

The data point description.

setDescription

public void setDescription(java.lang.String description)

Sets the data point description.

Parameters:

description - The data point description-

getTimestamp

public java.lang.String getTimestamp()

Returns the data point time stamp.

Returns:

The data point time stamp.

toCSVFormat

public java.lang.String toCSVFormat(boolean complete)

Retrieves the data point in CVS format.

Parameters:

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

Returns:

Data point in CSV format.