com.swirl

Class Signal

java.lang.Object

com.swirl.SObject

com.swirl.Signal

Direct Known Subclasses:

Beacon, Region, WifiInfo

public abstract class Signal
extends SObject

Signal is the abstract base class for signal objects: beacon, wifi network, region.

Field Summary

Fields

Modifier and Type	Field and Description
protected Location	location
static int	TYPE_BEACON
static int	TYPE_GEOFENCE
static int	TYPE_WIFI

Fields inherited from class com.swirl.SObject

properties

Constructor Summary

Constructors

Constructor and Description
Signal(org.json.JSONObject info, java.lang.String urn)

Method Summary

Modifier and Type	Method and Description
java.util.ArrayList<Attachment>	getAttachments(java.lang.String type) If resolved returns the set of attachments that match the type specifier.
org.json.JSONObject	getAttributes() If resolved, returns the custom attributes associated with this signal.
int	getError() Get any error associated with this signal, or 0 if no error.
java.lang.String[]	getLabels() If resolved, returns the custom labels associated with this signal.
abstract long	getLastDetected() Get the detected timestamp for this signal or return 0, overridden by each signal type
Location	getLocation() Get the logical Location associated with this signal in the platform
abstract double	getRange() Get the approximate range to the singal source in meters.
abstract int	getType() Get the type of signal
java.lang.String	getURN() Get the URN identifier for this signal
void	setError(int ecode) Set the error for this signal or 0 to clear any error condition.

Methods inherited from class com.swirl.SObject

equals, getArray, getArray, getDouble, getIdentifier, getInt, getName, getObject, getObject, getString, getString, hashCode, setProperties

Methods inherited from class java.lang.Object

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

Field Detail

TYPE_BEACON

public static final int TYPE_BEACON

See Also:

Constant Field Values

TYPE_WIFI

public static final int TYPE_WIFI

See Also:

Constant Field Values

TYPE_GEOFENCE

public static final int TYPE_GEOFENCE

See Also:

Constant Field Values

location

protected Location location

Constructor Detail

Signal

public Signal(org.json.JSONObject info,
              java.lang.String urn)

Method Detail

getURN

public java.lang.String getURN()

Get the URN identifier for this signal

Returns:

URN formatted string identifier for this signal

getType

public abstract int getType()

Get the type of signal

Returns:

timestamp of last detection or 0

getRange

public abstract double getRange()

Get the approximate range to the singal source in meters.

Returns:

range in meters

getLastDetected

public abstract long getLastDetected()

Get the detected timestamp for this signal or return 0, overridden by each signal type

Returns:

timestamp of last detection or 0

getError

public int getError()

Get any error associated with this signal, or 0 if no error.

Returns:

error code or 0

setError

public void setError(int ecode)

Set the error for this signal or 0 to clear any error condition.

getLocation

public Location getLocation()

Get the logical Location associated with this signal in the platform

Returns:

The logical location.

See Also:

Location

getAttributes

public org.json.JSONObject getAttributes()

If resolved, returns the custom attributes associated with this signal. These attribute mappings occur through the Swirl platform.

Returns:

the JSONObject representation of attributes or null

getLabels

public java.lang.String[] getLabels()

If resolved, returns the custom labels associated with this signal. These label mappings occur through the Swirl platform.

Returns:

the String array of labels

getAttachments

public java.util.ArrayList<Attachment> getAttachments(java.lang.String type)

If resolved returns the set of attachments that match the type specifier. Pass a string will match the 'namespace/type' as a prefix unless you pass a string which begins with a slash as in '/type' in which case it will match if the type ends with '/type'