com.abiquo.api.resources.SquidResource Class Reference

This class represents a SquidResource. More...

Inheritance diagram for com.abiquo.api.resources.SquidResource:

List of all members.

Public Member Functions

SquidResource ()

Creates a new SquidResource with the default values.

SquidResource (ResourceInstance resourceInstance)

Creates a new SquidResource based on a generic ResourceInstance.

Job getMoteList ()

Creates a new Job which once executed, returns the list of connected SquidBee devices.

Job getSample (String moteId, String sensor)

Creates a new Job which once executed, returns the sample for the specified SquidBee device.

Job listen (InstanceName resourceInstance)

Creates a new Job which once executed, provides a ZigBee feed for the resource.

Static Public Member Functions

static SquidResource cast (ResourceInstance resourceInstance)

Converts a generic ResourceInstance into a new one of type SquidResource.

Static Public Attributes

static String ID = "Squid"

String containing the identifier for this resource.

Detailed Description

This class represents a SquidResource.

It gathers information from SquidBee devices through a ZigBee gateway.

 <?xml version="1.0" encoding="utf-8"?>
 <Resource xmlns="http://http://cpal.abiquo.com/schema/Domain.xsd" LocalId="SquidResource">
    <FunctionalityList >

      <Functionality LocalId="listen" ReturnType="void">
        <AttributeList>
          <Attribute Name="Session" Type="DataReference" />
        </AttributeList>
      </Functionality>

      <Functionality LocalId="getSample" ReturnType="string">
        <AttributeList>
          <Attribute Name="Sensor" Type="String" />
          <Attribute Name="MoteId" Type="String" />
        </AttributeList>
      </Functionality>        

      <Functionality LocalId="GetMoteList" ReturnType="string"/>
      
    </FunctionalityList>
 </Resource>

See also:: SquidFakeResource
SquidPlusResource

Constructor & Destructor Documentation

com.abiquo.api.resources.SquidResource.SquidResource ( ResourceInstance resourceInstance )

Creates a new SquidResource based on a generic ResourceInstance.

Parameters:

resourceInstance

The generic ResourceInstance

Member Function Documentation

static SquidResource com.abiquo.api.resources.SquidResource.cast ( ResourceInstance resourceInstance ) [static]

Converts a generic ResourceInstance into a new one of type SquidResource.

Parameters:

resourceInstance

The generic ResourceInstance

Returns:: The resultant SquidResource

Reimplemented in com.abiquo.api.resources.SquidPlusResource.

Job com.abiquo.api.resources.SquidResource.getMoteList ( )

Creates a new Job which once executed, returns the list of connected SquidBee devices.

Returns:: The Job to perform the inquiry

Job com.abiquo.api.resources.SquidResource.getSample	(	String	moteId,
		String	sensor
	)

Creates a new Job which once executed, returns the sample for the specified SquidBee device.

Parameters:

	moteId	A string containing the mote identifier
	sensor	A sensor type (humidity, lightness, temperature, and so on)

Returns:: The Job to perform the demand

Job com.abiquo.api.resources.SquidResource.listen ( InstanceName resourceInstance )

Creates a new Job which once executed, provides a ZigBee feed for the resource.

Parameters:

resourceInstance

A valid ResourseInstance of a previously created ZigBee resource.

Returns:: The Job to perform the demand

Member Data Documentation

String com.abiquo.api.resources.SquidResource.ID = "Squid" [static]

String containing the identifier for this resource.

Note:: To avoid misspellings when provision a resource, you should use this constant ID instead of a manually typed string.

Reimplemented in com.abiquo.api.resources.SquidPlusResource.

The documentation for this class was generated from the following file:

src/com/abiquo/api/resources/SquidResource.java


Public Member Functions
	SquidResource ()
	Creates a new SquidResource with the default values.
	SquidResource (ResourceInstance resourceInstance)
	Creates a new SquidResource based on a generic ResourceInstance.
Job	getMoteList ()
	Creates a new Job which once executed, returns the list of connected SquidBee devices.
Job	getSample (String moteId, String sensor)
	Creates a new Job which once executed, returns the sample for the specified SquidBee device.
Job	listen (InstanceName resourceInstance)
	Creates a new Job which once executed, provides a ZigBee feed for the resource.
Static Public Member Functions
static SquidResource	cast (ResourceInstance resourceInstance)
	Converts a generic ResourceInstance into a new one of type SquidResource.
Static Public Attributes
static String	ID = "Squid"
	String containing the identifier for this resource.