Node (IoTIgnite APIs (Version 0.8.2))

java.lang.Object
- com.ardic.android.iotignite.connection.ServiceInstance
- - com.ardic.android.iotignite.nodes.Node

All Implemented Interfaces:

INode, NodeListener
```
public final class Node
extends ServiceInstance
implements INode, NodeListener
```
Node class which implements INode interface. This class hold information about node itself and its Things. Every Node is handled by one NodeManager.

Field Summary
- Fields inherited from class com.ardic.android.iotignite.connection.ServiceInstance
  agentService

Constructor Summary

Constructors
Modifier	Constructor and Description
`protected`	`Node(java.lang.String nodeName, java.lang.String nodeID, IotIgniteManager instance, java.lang.String uniqueID, NodeListener nodeListener)`

Method Summary

All Methods Static Methods Instance Methods Concrete Methods
Modifier and Type	Method and Description
`Thing`	`createThing(android.hardware.Sensor androidSensor, ThingListener listener)` Create `Thing` object which is an Android `Sensor`.
`Thing`	`createThing(java.lang.String thingID, ThingType thingType, ThingCategory thingCategory, boolean isActuator, ThingListener listener, java.lang.String uniqueID)` Creates `Thing` object and assigns to `Node`.
`boolean`	`equals(java.lang.Object obj)`
`android.content.Context`	`getContext()` Get `Context` of `Node`.
`java.util.List<Thing>`	`getEveryThing()` Get list of registered `Thing`s in IotIgnite.
`static java.lang.String`	`getNodeAsJSONString(Node mNode)`
`java.lang.String`	`getNodeID()` Get id of `Node`.
`NodeListener`	`getNodeListener()` Return node's listener object.
`java.lang.String`	`getNodeName()` Get human readable `Node` name.
`static Node`	`getNodeObjectFromJsonString(java.lang.String nodeObjectString)`
`java.lang.String`	`getPackageName()` Package name of `Node` object.
`Thing`	`getThingByID(java.lang.String thingID)` Get `Thing` object by thingID in registered `Node`.
`java.util.List<Thing>`	`getThingByName(java.lang.String name)` Get list of registered `Thing`s with same name in IotIgnite.
`java.lang.String`	`getUniqueID()` Get unique id of `Node`.
`int`	`hashCode()`
`boolean`	`isConnected()` Get connection status of `Node`.
`boolean`	`isRegistered()` Check a `Thing` object registered on IotIgnite or not.
`void`	`onNodeUnregistered(java.lang.String nodeID)` If `Node` is unregistered, callback method notifies the application.
`boolean`	`register()` Register `Node` to IotIgnite.
`protected void`	`setConnected(boolean state)`
`void`	`setConnected(boolean connected, java.lang.String description)` Set connection status of `Node`.
`void`	`setContext(android.content.Context context)` Set `Context` of `Node`.
`void`	`setNodeID(java.lang.String nodeID)` Set an id to `Node`.
`void`	`setNodeListener(NodeListener listener)` Sets `NodeListener` for callbacks.
`void`	`setNodeName(java.lang.String nodeName)` Set human readable name to `Node`.
`void`	`setUniqueID(java.lang.String uniqueID)` Set an uniqueID to `Node`.
`boolean`	`unregister()` Unregister `Node` from IotIgnite.

Methods inherited from class java.lang.Object
clone, finalize, getClass, notify, notifyAll, toString, wait, wait, wait

- Constructor Detail
  - Node
```
protected Node(@NonNull
               java.lang.String nodeName,
               @NonNull
               java.lang.String nodeID,
               IotIgniteManager instance,
               java.lang.String uniqueID,
               NodeListener nodeListener)
```
- Method Detail
  - setConnected
```
protected void setConnected(boolean state)
```
  - getNodeName
```
public java.lang.String getNodeName()
```
    Description copied from interface: INode
    
    Get human readable Node name.
    
    Specified by:
    
    getNodeName in interface INode
    
    Returns:
    
    nodeName : Human readable name of Node.
  - setNodeName
```
public void setNodeName(java.lang.String nodeName)
```
    Description copied from interface: INode
    
    Set human readable name to Node.
    
    Specified by:
    
    setNodeName in interface INode
    
    Parameters:
    
    nodeName - : Name of Node.
  - getNodeID
```
public java.lang.String getNodeID()
```
    Description copied from interface: INode
    
    Get id of Node.
    
    Specified by:
    
    getNodeID in interface INode
    
    Returns:
    
    nodeID : node ID of Node.
  - setNodeID
```
public void setNodeID(java.lang.String nodeID)
```
    Description copied from interface: INode
    
    Set an id to Node. ID must be UNIQUE.
    
    Specified by:
    
    setNodeID in interface INode
    
    Parameters:
    
    nodeID - id of the Node
  - isConnected
```
public boolean isConnected()
```
    Description copied from interface: INode
    
    Get connection status of Node.
    
    Specified by:
    
    isConnected in interface INode
    
    Returns:
    
    nodeName : Human readable name of Node.
  - setConnected
```
public void setConnected(boolean connected,
                         java.lang.String description)
```
    Description copied from interface: INode
    
    Set connection status of Node.
    
    Specified by:
    
    setConnected in interface INode
    
    Parameters:
    
    connected - : Status of connection.
    
    description - : Description about connection state.
  - getPackageName
```
public java.lang.String getPackageName()
```
    Description copied from interface: INode
    
    Package name of Node object.
    
    Specified by:
    
    getPackageName in interface INode
    
    Returns:
    
    packageName : String
  - getUniqueID
```
public java.lang.String getUniqueID()
```
    Description copied from interface: INode
    
    Get unique id of Node.
    
    Specified by:
    
    getUniqueID in interface INode
    
    Returns:
    
    nodeID : unique ID of Node.
  - setUniqueID
```
public void setUniqueID(java.lang.String uniqueID)
```
    Description copied from interface: INode
    
    Set an uniqueID to Node. ID must be UNIQUE.
    
    Specified by:
    
    setUniqueID in interface INode
    
    Parameters:
    
    uniqueID - unique of the Node
  - getContext
```
public android.content.Context getContext()
```
    Description copied from interface: INode
    
    Get Context of Node.
    
    Specified by:
    
    getContext in interface INode
    
    Returns:
    
    Context
  - setContext
```
public void setContext(android.content.Context context)
```
    Description copied from interface: INode
    
    Set Context of Node.
    
    Specified by:
    
    setContext in interface INode
    
    Parameters:
    
    context - Context of the Application
  - register
```
public boolean register()
```
    Description copied from interface: INode
    
    Register Node to IotIgnite. To register Node, nodeID must be unique on this device.
    
    Specified by:
    
    register in interface INode
    
    Returns:
    
    true or false success state.
  - unregister
```
public boolean unregister()
```
    Description copied from interface: INode
    
    Unregister Node from IotIgnite. Application can only unregister its own Nodes. Nodes registered by different application are not accessable.
    
    Specified by:
    
    unregister in interface INode
    
    Returns:
    
    true or false success state.
    
    See Also:
    
    IotIgniteManager, Thing
  - createThing
```
public Thing createThing(java.lang.String thingID,
                         ThingType thingType,
                         ThingCategory thingCategory,
                         boolean isActuator,
                         ThingListener listener,
                         java.lang.String uniqueID)
```
    Description copied from interface: INode
    
    Creates Thing object and assigns to Node. To create Thing object the application must be authorized in IotIgnite platform. After that it can create Node and Node assigned Thing objects. thingID must follow the rules which are defined with the Regex below: ^[a-zA-Z0-9]+([ ]?[a-zA-Z0-9-.:@]+)*$
    
    Specified by:
    
    createThing in interface INode
    
    Parameters:
    
    thingID - Set Thing's ID. Every node must has unique thingId.
    
    thingType - thingType type of the Thing
    
    thingCategory - Could be ThingCategory.BUILTIN or ThingCategory.EXTERNAL
    
    isActuator - Actuator state of Thing object
    
    listener - ThingListener object.
    
    uniqueID - uniqueID of Thing
    
    Returns:
    
    Thing : The created Thing object.
    
    See Also:
    
    ThingManager, Thing, ThingType, ThingListener, ThingCategory
  - createThing
```
public Thing createThing(android.hardware.Sensor androidSensor,
                         ThingListener listener)
```
    Description copied from interface: INode
    
    Create Thing object which is an Android Sensor. It wraps Android Sensor to Thing object. Creating Thing objects from builtin Android Sensor has fewer parameters than generic Thing object. It only needs Android Sensor and ThingListener. Other parameters such as thingID, thingType, vendor has already provided in Sensor.
  - Android Sensors can not act as an actuator so by default this parameter is false. Application cannot change it.

Specified by:: createThing in interface INode
Parameters:: androidSensor - Sensor of the Android; listener - ThingListener object.
Returns:: Thing : Thing object.
See Also:: ThingManager, Thing, Sensor, ThingListener

getEveryThing
```
public java.util.List<Thing> getEveryThing()
```
Description copied from interface: INode

Get list of registered Things in IotIgnite. If no such a Thing is registered, Node returns empty list.

Specified by:

getEveryThing in interface INode

Returns:

List<Thing>: List of Thing's registered on IotIgnite.

getThingByID
```
public Thing getThingByID(java.lang.String thingID)
```
Description copied from interface: INode

Get Thing object by thingID in registered Node. If no such Thing is registered thingID returns null object.

Specified by:

getThingByID in interface INode

Parameters:

thingID - : Unique thingID of object.

Returns:

Thing : Returns null if no such a thing in that id.

getThingByName
```
public java.util.List<Thing> getThingByName(java.lang.String name)
```
Description copied from interface: INode

Get list of registered Things with same name in IotIgnite. If no such Thing is registered, Node returns empty list.

Specified by:

getThingByName in interface INode

Parameters:

name - Name of the Thing

Returns:

List<Thing>: List of Things with same thingNames registered on IotIgnite.

isRegistered
```
public boolean isRegistered()
```
Description copied from interface: INode

Check a Thing object registered on IotIgnite or not.

Specified by:

isRegistered in interface INode

Returns:

true or false : Thing registration state on IotIgnite.

setNodeListener
```
public void setNodeListener(NodeListener listener)
```
Description copied from interface: INode

Sets NodeListener for callbacks.

Specified by:

setNodeListener in interface INode

Parameters:

listener - : NodeListener object.

See Also:

NodeListener

getNodeListener
```
public NodeListener getNodeListener()
```
Description copied from interface: INode

Return node's listener object.

Specified by:

getNodeListener in interface INode

Returns:

NodeListener : Node listener object.

See Also:

NodeListener

hashCode
```
public int hashCode()
```
Overrides:

hashCode in class java.lang.Object

equals

public boolean equals(java.lang.Object obj)

Overrides:: equals in class java.lang.Object

getNodeAsJSONString

public static java.lang.String getNodeAsJSONString(Node mNode)

Parameters:: mNode -
Returns:

getNodeObjectFromJsonString

public static Node getNodeObjectFromJsonString(java.lang.String nodeObjectString)

Parameters:: nodeObjectString -
Returns:

onNodeUnregistered
```
public void onNodeUnregistered(java.lang.String nodeID)
```
Description copied from interface: NodeListener

If Node is unregistered, callback method notifies the application.

Specified by:

onNodeUnregistered in interface NodeListener

Parameters:

nodeID - : id of Node's assigned node.

See Also:

Node}

Class Node

Field Summary

Fields inherited from class com.ardic.android.iotignite.connection.ServiceInstance

Constructor Summary

Method Summary

Methods inherited from class java.lang.Object

Constructor Detail

Node

Method Detail

setConnected

getNodeName

setNodeName

getNodeID

setNodeID

isConnected

setConnected

getPackageName

getUniqueID

setUniqueID

getContext

setContext

register

unregister

createThing

createThing

getEveryThing

getThingByID

getThingByName

isRegistered

setNodeListener

getNodeListener

hashCode

equals

getNodeAsJSONString

getNodeObjectFromJsonString

onNodeUnregistered