com.erudika.para.core

Class Thing

java.lang.Object

com.erudika.para.core.Sysprop

com.erudika.para.core.Thing

All Implemented Interfaces:

Linkable, ParaObject, Votable, Serializable

public class Thing
extends Sysprop

A "thing" in the Internet of Things. Generic IoT object for describing a device in the cloud.

Author:

Alex Bogdanovski [alex@erudika.com]

See Also:

Serialized Form

Nested Class Summary

Nested classes/interfaces inherited from interface com.erudika.para.core.Votable

Votable.VoteValue

Constructor Summary

Constructors

Constructor and Description
Thing() No-args constructor.
Thing(String id) The default constructor.

Method Summary

Modifier and Type	Method and Description
Thing	addStateProperty(String key, Object value) Adds a new key/value pair to the map.
String	create() Stores this object in the data store.
void	delete() Deletes the object permanently by removing it from the data store.
boolean	equals(Object obj)
Map<String,Object>	getDeviceDetails() Temporarily set when a Thing is created.
Map<String,Object>	getDeviceMetadata() Returns the device's metadata.
Map<String,Object>	getDeviceState() The deviceState of the device.
String	getServiceBroker() Returns the service broker, e.g.
Object	getStateProperty(String key) Returns the value of a property for a given key.
int	hashCode()
boolean	hasStateProperty(String key) Checks for the existence of a property.
Thing	removeStateProperty(String key) Removes a property from the map.
void	setDeviceMetadata(Map<String,Object> deviceMetadata) Sets the device's metadata.
void	setDeviceState(Map<String,Object> state) Sets the device's deviceState.
void	setServiceBroker(String serviceBroker) Sets the service broker which will handle the messages in the cloud.
void	update() Updates the object permanently.

Methods inherited from class com.erudika.para.core.Sysprop

addProperty, countChildren, countLinks, deleteChildren, exists, findChildren, findLinkedObjects, getAppid, getCached, getChildren, getChildren, getCreatorid, getId, getIndexed, getLinkedObjects, getLinks, getName, getObjectURI, getParentid, getPlural, getProperties, getProperty, getStored, getTags, getTimestamp, getType, getUpdated, getVersion, getVotes, hasProperty, isLinked, isLinked, link, removeProperty, setAppid, setCached, setCreatorid, setId, setIndexed, setName, setParentid, setProperties, setStored, setTags, setTimestamp, setType, setUpdated, setVersion, setVotes, toString, unlink, unlinkAll, voteDown, voteUp

Methods inherited from class java.lang.Object

getClass, notify, notifyAll, wait, wait, wait

Constructor Detail

Thing

public Thing()

No-args constructor.

Thing

public Thing(String id)

The default constructor.

Parameters:

id - the object id

Method Detail

getServiceBroker

public String getServiceBroker()

Returns the service broker, e.g. AWS. Used for switching cloud providers.

Returns:

a string

setServiceBroker

public void setServiceBroker(String serviceBroker)

Sets the service broker which will handle the messages in the cloud.

Parameters:

serviceBroker - a name

getDeviceMetadata

public Map<String,Object> getDeviceMetadata()

Returns the device's metadata.

Returns:

a map

setDeviceMetadata

public void setDeviceMetadata(Map<String,Object> deviceMetadata)

Sets the device's metadata.

Parameters:

deviceMetadata - a map

getDeviceState

public Map<String,Object> getDeviceState()

The deviceState of the device.

Returns:

a map of keys/values

setDeviceState

public void setDeviceState(Map<String,Object> state)

Sets the device's deviceState.

Parameters:

state - a map of keys/values

addStateProperty

public Thing addStateProperty(String key,
                              Object value)

Adds a new key/value pair to the map.

Parameters:

key - a key

value - a value

Returns:

this

getStateProperty

public Object getStateProperty(String key)

Returns the value of a property for a given key.

Parameters:

key - the key

Returns:

the value

removeStateProperty

public Thing removeStateProperty(String key)

Removes a property from the map.

Parameters:

key - the key

Returns:

this

hasStateProperty

public boolean hasStateProperty(String key)

Checks for the existence of a property.

Parameters:

key - the key

Returns:

true if a property with this key exists

getDeviceDetails

public Map<String,Object> getDeviceDetails()

Temporarily set when a Thing is created. Contains sensitive info shown only on create()

Returns:

device informations (same as metadata, but shown only once)

delete

public void delete()

Description copied from interface: ParaObject

Deletes the object permanently by removing it from the data store.

Specified by:

delete in interface ParaObject

Overrides:

delete in class Sysprop

See Also:

DAO.delete(com.erudika.para.core.ParaObject)

update

public void update()

Description copied from interface: ParaObject

Updates the object permanently. Changes to Locked fields are ignored.

Specified by:

update in interface ParaObject

Overrides:

update in class Sysprop

See Also:

Locked, DAO.update(com.erudika.para.core.ParaObject)

create

public String create()

Description copied from interface: ParaObject

Stores this object in the data store.

Specified by:

create in interface ParaObject

Overrides:

create in class Sysprop

Returns:

the id of the object (a new id if object is new)

See Also:

Stored, DAO.create(com.erudika.para.core.ParaObject)

equals

public boolean equals(Object obj)

Overrides:

equals in class Sysprop

hashCode

public int hashCode()

Overrides:

hashCode in class Sysprop