buzz.getcoco.iot

Class Identifier

java.lang.Object

buzz.getcoco.iot.Identifier

Direct Known Subclasses:

Identifier.SourceIdentifier, Identifier.TriggerIdentifier

public class Identifier
extends java.lang.Object

This class encapsulates ids for Network, Device, Resource, Capability, Attribute, Zone, Scene, Rule.

Nested Class Summary

Nested Classes

Modifier and Type	Class and Description
static class	Identifier.SerializedId A helper class for generating Identifier object using fromSerializable(java.io.Serializable).
static class	Identifier.SourceIdentifier This class serves as blueprint for a source URI in StorageContentMetadata.
static class	Identifier.TriggerIdentifier This class serves as a trigger attribute in making content search InfoRequest and as upload triggered identifier StorageContentMetadata.

Field Summary

Fields

Modifier and Type	Field and Description
int	attributeId Attribute ID of parent capability.
int	capabilityId Capability ID of the parent resource.
long	deviceNodeId Node ID of the device in the network.
java.lang.String	networkId ID of the network generated after successful creation of the network.
java.lang.String	resourceEui Unique identifier of the resource in the parent device.
int	ruleId ID of the Rule under consideration.
int	sceneId ID of the Scene under consideration.
int	zoneId ID of the zone in the network.

Constructor Summary

Constructors

Constructor and Description
Identifier(Identifier id) Constructor for current class using Identifier param.
Identifier(java.lang.String networkId, long deviceNodeId, java.lang.String resourceEui, int capabilityId, int attributeId, int zoneId, int sceneId, int ruleId) An overloaded constructor for current class.

Method Summary

Modifier and Type	Method and Description
boolean	equals(java.lang.Object obj)
static Identifier	fromJson(com.google.gson.Gson gson, java.lang.String jsonIdentifier) An overloaded function to deserialize the String param to the Identifier object using custom Gson instance.
static Identifier	fromJson(java.lang.String jsonIdentifier) A function to deserialize the String param to the Identifier object.
static Identifier	fromJsonTree(com.google.gson.Gson gson, com.google.gson.JsonElement jsonElement) An overloaded function to deserialize the JsonElement param to the Identifier object using custom Gson instance.
static Identifier	fromJsonTree(com.google.gson.JsonElement jsonElement) A function to deserialize the JsonElement param to the Identifier object.
static Identifier	fromSerializable(java.io.Serializable serializable) A function to make an Identifier object out of serializable param.
<T extends Attribute> T	getAttribute() A generic method to fetch attribute for the identifier instance.
<T extends Capability> T	getCapability() A generic method to fetch capability for the identifier instance.
<T extends Device> T	getDevice() A generic method to fetch device for the identifier instance.
static Identifier	getIdentifier(Attribute attribute) A function to get all identification information for attribute param.
static Identifier	getIdentifier(Capability capability) A function to get all identification information for capability param.
static Identifier	getIdentifier(Device device) A function to get all identification information for device param.
static Identifier	getIdentifier(Network network) A function to get all identification information for device param.
static Identifier	getIdentifier(Resource resource) A function to get all identification information for resource param.
static Identifier	getIdentifier(Rule rule) A function to get all identification information for rule param.
static Identifier	getIdentifier(Scene scene) A function to get all identification information for scene param.
static Identifier	getIdentifier(Zone zone) A function to get all identification information for zone param.
<T extends Network> T	getNetwork() A generic method to fetch network for the identifier instance.
<T extends Resource> T	getResource() A generic method to fetch Resource for the identifier instance.
<T extends Rule> T	getRule() A generic method to fetch rule for the identifier instance.
<T extends Scene> T	getScene() A generic method to fetch scene for the identifier instance.
<T extends Zone> T	getZone() A generic method to fetch zone for the identifier instance.
int	hashCode()
java.lang.String	toJson() A function to convert the current instance of Identifier to Json String.
java.lang.String	toJson(com.google.gson.Gson gson) A function to convert the current instance of Identifier to Json String.
com.google.gson.JsonElement	toJsonTree() A function to facilitate serialization of Identifier object to an equivalent representation of tree of JsonElements.
com.google.gson.JsonElement	toJsonTree(com.google.gson.Gson gson) An overloaded function to facilitate serialization of Identifier object to an equivalent representation of tree of JsonElements.
java.io.Serializable	toSerializable() A function to create Serializable version of Identifier instance under interest.
java.lang.String	toString()

Methods inherited from class java.lang.Object

clone, finalize, getClass, notify, notifyAll, wait, wait, wait

Field Detail

networkId

@SerializedName(value="networkId")
public final java.lang.String networkId

ID of the network generated after successful creation of the network.

See Also:

Network.getId()

deviceNodeId

@SerializedName(value="nodeId",
                alternate="gatewayNodeId")
public final long deviceNodeId

Node ID of the device in the network.

See Also:

Device.getId()

resourceEui

@SerializedName(value="resourceEui")
public final java.lang.String resourceEui

Unique identifier of the resource in the parent device.

See Also:

Resource.getId()

capabilityId

@SerializedName(value="capabilityId")
public final int capabilityId

Capability ID of the parent resource.

See Also:

Capability.getId()

attributeId

@SerializedName(value="attributeId")
public final int attributeId

Attribute ID of parent capability.

See Also:

Attribute.getId()

zoneId

@SerializedName(value="zoneId")
public final int zoneId

ID of the zone in the network.

See Also:

Zone.getId()

sceneId

@SerializedName(value="sceneId")
public final int sceneId

ID of the Scene under consideration.

See Also:

Scene.getId()

ruleId

@SerializedName(value="ruleId")
public final int ruleId

ID of the Rule under consideration.

See Also:

Rule.getId()

Constructor Detail

Identifier

public Identifier(Identifier id)

Constructor for current class using Identifier param.

Parameters:

id - identifier with information of all ids.

Identifier

public Identifier(java.lang.String networkId,
                  long deviceNodeId,
                  java.lang.String resourceEui,
                  int capabilityId,
                  int attributeId,
                  int zoneId,
                  int sceneId,
                  int ruleId)

An overloaded constructor for current class.

Parameters:

networkId - The network to which the device belongs will respond

deviceNodeId - The device which has to respond to this request

resourceEui - The ID corresponding to the resource

capabilityId - CapabilityID of the recipient resource

attributeId - ID of the attribute value as in Capability.AttributeId

zoneId - ID of the zone in the network

sceneId - ID of the scene created by user in network

ruleId - ID of the rule created by user in network

Method Detail

getIdentifier

public static Identifier getIdentifier(Network network)

A function to get all identification information for device param.

Parameters:

network - Network object in interest, for an Identifier

Returns:

Identifier object corresponding to the network with default deviceNodeId, resourceEui, capabilityId and attributeId values.

getIdentifier

public static Identifier getIdentifier(Device device)

A function to get all identification information for device param.

Parameters:

device - Device object in interest, for an Identifier

Returns:

Identifier object corresponding to the device with default resourceEui, capabilityId and attributeId values.

getIdentifier

public static Identifier getIdentifier(Resource resource)

A function to get all identification information for resource param.

Parameters:

resource - Resource object in interest, for an Identifier

Returns:

Identifier object corresponding to the resource with default capabilityId and attributeId values.

getIdentifier

public static Identifier getIdentifier(Capability capability)

A function to get all identification information for capability param.

Parameters:

capability - Capability object in interest, for an Identifier

Returns:

Identifier object corresponding to the capability with default attributeId value.

getIdentifier

public static Identifier getIdentifier(Attribute attribute)

A function to get all identification information for attribute param.

Parameters:

attribute - Attribute object in interest, for an Identifier

Returns:

Identifier object corresponding to the attribute.

getIdentifier

public static Identifier getIdentifier(Zone zone)

A function to get all identification information for zone param.

Parameters:

zone - Zone object in interest, for an Identifier

Returns:

Identifier object corresponding to the zone with default deviceNodeId, resourceEui, capabilityId and attributeId values.

getIdentifier

public static Identifier getIdentifier(Scene scene)

A function to get all identification information for scene param.

Parameters:

scene - Scene object in interest, for an Identifier

Returns:

Identifier object corresponding to the scene with default deviceNodeId, resourceEui, capabilityId and attributeId values.

getIdentifier

public static Identifier getIdentifier(Rule rule)

A function to get all identification information for rule param.

Parameters:

rule - Rule object in interest, for an Identifier

Returns:

Identifier object corresponding to the rule with default deviceNodeId, resourceEui, capabilityId and attributeId values.

getNetwork

public <T extends Network> T getNetwork()

A generic method to fetch network for the identifier instance.

Type Parameters:

T - any immediate subclass of Network class

Returns:

Network corresponding to networkId for the Identifier instance

getDevice

public <T extends Device> T getDevice()

A generic method to fetch device for the identifier instance.

Type Parameters:

T - any immediate subclass of Device class

Returns:

Device corresponding to deviceNodeId for the Identifier instance

getResource

public <T extends Resource> T getResource()

A generic method to fetch Resource for the identifier instance.

Type Parameters:

T - any immediate subclass of Resource class

Returns:

Resource corresponding to resourceEui for the Identifier instance

getCapability

public <T extends Capability> T getCapability()

A generic method to fetch capability for the identifier instance.

Type Parameters:

T - any immediate subclass of Capability class

Returns:

Capability corresponding to capabilityId for the Identifier instance

getAttribute

public <T extends Attribute> T getAttribute()

A generic method to fetch attribute for the identifier instance.

Type Parameters:

T - any immediate subclass of Attribute class

Returns:

Attribute corresponding to attributeId for the Identifier instance

getZone

public <T extends Zone> T getZone()

A generic method to fetch zone for the identifier instance.

Type Parameters:

T - any immediate subclass of Zone class

Returns:

Zone corresponding to zoneId for the Identifier instance

getScene

public <T extends Scene> T getScene()

A generic method to fetch scene for the identifier instance.

Type Parameters:

T - any immediate subclass of Scene class

Returns:

Scene corresponding to sceneId for the Identifier instance

getRule

public <T extends Rule> T getRule()

A generic method to fetch rule for the identifier instance.

Type Parameters:

T - any immediate subclass of Rule class

Returns:

Rule corresponding to ruleId for the Identifier instance

equals

public boolean equals(java.lang.Object obj)

Overrides:

equals in class java.lang.Object

hashCode

public int hashCode()

Overrides:

hashCode in class java.lang.Object

toJsonTree

public com.google.gson.JsonElement toJsonTree()

A function to facilitate serialization of Identifier object to an equivalent representation of tree of JsonElements.

Returns:

A serialized tree of JsonElements for Identifier instance.

toJsonTree

public com.google.gson.JsonElement toJsonTree(com.google.gson.Gson gson)

An overloaded function to facilitate serialization of Identifier object to an equivalent representation of tree of JsonElements.

Parameters:

gson - To serialize using Google's Gson class.

Returns:

A serialized tree of JsonElements for Identifier instance.

toJson

public java.lang.String toJson()

A function to convert the current instance of Identifier to Json String.

Returns:

Json representation of the Identifier.

toJson

public java.lang.String toJson(com.google.gson.Gson gson)

A function to convert the current instance of Identifier to Json String.

Parameters:

gson - To serialize using Google's Gson class.

Returns:

Json representation of the Identifier.

toSerializable

public java.io.Serializable toSerializable()

A function to create Serializable version of Identifier instance under interest.

Returns:

A Serializable Identifier.

See Also:

Identifier.SerializedId

fromSerializable

public static Identifier fromSerializable(java.io.Serializable serializable)

A function to make an Identifier object out of serializable param.

Parameters:

serializable - Serializable instance in interest, for an Identifier instance.

Returns:

Identifier from provided Json.

fromJson

public static Identifier fromJson(java.lang.String jsonIdentifier)

A function to deserialize the String param to the Identifier object.

Parameters:

jsonIdentifier - A String representation of Identifier data class.

Returns:

Identifier from provided Json.

fromJson

public static Identifier fromJson(com.google.gson.Gson gson,
                                  java.lang.String jsonIdentifier)

An overloaded function to deserialize the String param to the Identifier object using custom Gson instance.

Parameters:

gson - To deserialize using Google's Gson class.

jsonIdentifier - A String representation of Identifier data class.

Returns:

Identifier from provided Json.

fromJsonTree

public static Identifier fromJsonTree(com.google.gson.JsonElement jsonElement)

A function to deserialize the JsonElement param to the Identifier object.

Parameters:

jsonElement - An element of Json that holds data for Identifier.

Returns:

Identifier from provided Json.

fromJsonTree

public static Identifier fromJsonTree(com.google.gson.Gson gson,
                                      com.google.gson.JsonElement jsonElement)

An overloaded function to deserialize the JsonElement param to the Identifier object using custom Gson instance.

Parameters:

gson - To deserialize using Google's Gson class.

jsonElement - An element of Json that holds data for Identifier.

Returns:

Identifier from provided Json.

toString

public java.lang.String toString()

Overrides:

toString in class java.lang.Object