io.github.privacystreams.core

Class Item

java.lang.Object

io.github.privacystreams.core.Item

Direct Known Subclasses:

Acceleration, AccEvent, AirPressure, AmbientTemperature, Audio, BluetoothDevice, BrowserSearch, BrowserVisit, CalendarEvent, Call, Contact, DeviceEvent, DeviceState, Email, EmptyItem, Geolocation, Gravity, GroupItem, Gyroscope, Image, Light, LinearAcceleration, Message, MockItem, Notification, RelativeHumidity, RotationVector, StepCounter, TestItem, WifiAp

@PSItem
public class Item
extends java.lang.Object

An Item is a basic element in a stream. This class is the base class of all type of personal data items in PrivacyStream.

Field Summary

Fields

Modifier and Type	Field and Description
static Item	EOS
static java.lang.String	TIME_CREATED The timestamp of when this item is created.

Constructor Summary

Constructors

Constructor and Description
Item()
Item(java.util.Map<java.lang.String,java.lang.Object> itemMap)

Method Summary

Modifier and Type	Method and Description
boolean	containsField(java.lang.String fieldName) Test if current item contains a field
boolean	equals(Item anotherItem)
void	excludeFields(java.lang.String... fieldKeys) Exclude some fields from current item the excluded fields will not be available for output
java.lang.Boolean	getAsBoolean(java.lang.String fieldName) Get the value of a Boolean field in the item.
java.lang.Double	getAsDouble(java.lang.String fieldName) Get the value of a Double field in the item.
java.lang.Float	getAsFloat(java.lang.String fieldName) Get the value of a Float field in the item.
java.lang.Integer	getAsInteger(java.lang.String fieldName) Get the value of a Integer field in the item.
java.lang.Long	getAsLong(java.lang.String fieldName) Get the value of a Long field in the item.
java.lang.String	getAsString(java.lang.String fieldName) Get the value of a String field in the item.
<TValue> TValue	getValueByField(java.lang.String fieldName) Get the value of a field in the item.
void	includeFields(java.lang.String... fieldKeys) Include certain fields for output the included fields will be available for output, while other fields will not
boolean	isEndOfStream()
<TValue> void	setFieldValue(java.lang.String fieldName, TValue value) Set a value to a field in the item
java.lang.String	toDebugString()
org.json.JSONObject	toJson()
java.util.Map<java.lang.String,java.lang.Object>	toMap()
java.lang.String	toString()

Methods inherited from class java.lang.Object

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

Field Detail

TIME_CREATED

@PSItemField(type=java.lang.Long.class)
public static final java.lang.String TIME_CREATED

The timestamp of when this item is created. It is a general field for all items.

See Also:

Constant Field Values

EOS

public static final Item EOS

Constructor Detail

Item

public Item()

Item

public Item(java.util.Map<java.lang.String,java.lang.Object> itemMap)

Method Detail

isEndOfStream

public boolean isEndOfStream()

toMap

public java.util.Map<java.lang.String,java.lang.Object> toMap()

toJson

public org.json.JSONObject toJson()

toString

public java.lang.String toString()

Overrides:

toString in class java.lang.Object

toDebugString

public java.lang.String toDebugString()

getValueByField

public <TValue> TValue getValueByField(java.lang.String fieldName)

Get the value of a field in the item.

Type Parameters:

TValue - the type of field value

Parameters:

fieldName - the name of the field

Returns:

the field value

getAsString

public java.lang.String getAsString(java.lang.String fieldName)

Get the value of a String field in the item.

Parameters:

fieldName - the name of the field

Returns:

the field value

getAsBoolean

public java.lang.Boolean getAsBoolean(java.lang.String fieldName)

Get the value of a Boolean field in the item.

Parameters:

fieldName - the name of the field

Returns:

the field value

getAsInteger

public java.lang.Integer getAsInteger(java.lang.String fieldName)

Get the value of a Integer field in the item.

Parameters:

fieldName - the name of the field

Returns:

the field value

getAsLong

public java.lang.Long getAsLong(java.lang.String fieldName)

Get the value of a Long field in the item.

Parameters:

fieldName - the name of the field

Returns:

the field value

getAsDouble

public java.lang.Double getAsDouble(java.lang.String fieldName)

Get the value of a Double field in the item.

Parameters:

fieldName - the name of the field

Returns:

the field value

getAsFloat

public java.lang.Float getAsFloat(java.lang.String fieldName)

Get the value of a Float field in the item.

Parameters:

fieldName - the name of the field

Returns:

the field value

setFieldValue

public <TValue> void setFieldValue(java.lang.String fieldName,
                                   TValue value)

Set a value to a field in the item

Type Parameters:

TValue - the type of field value

Parameters:

fieldName - the name of field

value - the value of field

containsField

public boolean containsField(java.lang.String fieldName)

Test if current item contains a field

Parameters:

fieldName - the field name to test

Returns:

true if the item contains the field, otherwise false

includeFields

public void includeFields(java.lang.String... fieldKeys)

Include certain fields for output the included fields will be available for output, while other fields will not

Parameters:

fieldKeys - the names of fields to include

excludeFields

public void excludeFields(java.lang.String... fieldKeys)

Exclude some fields from current item the excluded fields will not be available for output

Parameters:

fieldKeys - the names of fields to exclude

equals

public boolean equals(Item anotherItem)