com.arubanetworks.meridian.triggers

Class ProximityBeacon

java.lang.Object

com.arubanetworks.meridian.triggers.ProximityBeacon

All Implemented Interfaces:

java.io.Serializable

public class ProximityBeacon
extends java.lang.Object
implements java.io.Serializable

Container for a Meridian proximity beacon and its related fields. This is used for triggers.

See Also:

Serialized Form

Constructor Summary

Constructors

Constructor and Description
ProximityBeacon() An empty ProximityBeacon constructor.
ProximityBeacon(int major, int minor) Initialize a MR beacon by its major/minor
ProximityBeacon(java.lang.String address) Initialize a MR beacon by its MAC address

Method Summary

Modifier and Type	Method and Description
static java.util.List<ProximityBeacon>	fromJSONArray(org.json.JSONArray json, java.lang.String locationId) Static initializer for creating a list of ProximityBeacons from its json representation.
static ProximityBeacon	fromJSONObject(org.json.JSONObject json, java.lang.String locationId) Static initializer for creating a ProximityBeacon from its json representation.
java.lang.String	getAddress() The unique Bluetooth MAC address of this beacon.
int	getMajor() The Beacon’s major identifier.
EditorKey	getMapKey() The Beacon’s map key.
int	getMinor() The Beacon’s minor identifier.
java.lang.String	getName() The human readable name of this Beacon (e.g.
java.lang.String	getUUID() Gets the UUID for this beacon.
float	getX() This beacon’s x coordinate on its parent Meridian Map.
float	getY() This beacon’s y coordinate on its parent Meridian Map.
boolean	isInvalid() Returns true if the ProximityBeacon does not represent a point on a map.
java.lang.String	majorMinorString() Gets the major/minor string of this Beacon.
void	setMajor(int major) Set the Beacon’s major identifier.
void	setMinor(int minor) Set the Beacon’s minor identifier.
void	setName(java.lang.String name) Sets the human readable name of this Beacon (e.g.
java.lang.String	toString()

Methods inherited from class java.lang.Object

clone, equals, finalize, getClass, hashCode, notify, notifyAll, wait, wait, wait

Constructor Detail

ProximityBeacon

public ProximityBeacon()

An empty ProximityBeacon constructor.

ProximityBeacon

public ProximityBeacon(int major,
                       int minor)

Initialize a MR beacon by its major/minor

Parameters:

major -

• major value (0-65535)

minor -

• minor value (0-65535)

ProximityBeacon

public ProximityBeacon(java.lang.String address)

Initialize a MR beacon by its MAC address

Parameters:

address -

• MAC addresses (without the :’s)

Method Detail

getUUID

public java.lang.String getUUID()

Gets the UUID for this beacon.

getAddress

public java.lang.String getAddress()

The unique Bluetooth MAC address of this beacon.

getName

public java.lang.String getName()

The human readable name of this Beacon (e.g. ‘Joe’s Office’, ‘Fountain’)

setName

public void setName(java.lang.String name)

Sets the human readable name of this Beacon (e.g. ‘Joe’s Office’, ‘Fountain’)

getX

public float getX()

This beacon’s x coordinate on its parent Meridian Map.

getY

public float getY()

This beacon’s y coordinate on its parent Meridian Map.

getMajor

public int getMajor()

The Beacon’s major identifier.

setMajor

public void setMajor(int major)

Set the Beacon’s major identifier.

getMinor

public int getMinor()

The Beacon’s minor identifier.

setMinor

public void setMinor(int minor)

Set the Beacon’s minor identifier.

getMapKey

public EditorKey getMapKey()

The Beacon’s map key.

fromJSONObject

public static ProximityBeacon fromJSONObject(org.json.JSONObject json,
                                             java.lang.String locationId)
                                      throws org.json.JSONException

Static initializer for creating a ProximityBeacon from its json representation.

Parameters:

json - A known json representation of the ProximityBeacon to be initialized.

locationId - A known Meridian location id for the initialized ProximityBeacon.

Returns:

The initialized ProximityBeacon.

Throws:

org.json.JSONException - on JSON parsing error

fromJSONArray

public static java.util.List<ProximityBeacon> fromJSONArray(org.json.JSONArray json,
                                                            java.lang.String locationId)
                                                     throws org.json.JSONException

Static initializer for creating a list of ProximityBeacons from its json representation.

Parameters:

json - A json representation of the ProximityBeacon list.

locationId - A known Meridian location id for the ProximityBeacon in the list.

Returns:

An initialized list of ProximityBeacon.

Throws:

org.json.JSONException - on JSON parsing error

majorMinorString

public java.lang.String majorMinorString()

Gets the major/minor string of this Beacon.

isInvalid

public boolean isInvalid()

Returns true if the ProximityBeacon does not represent a point on a map.

toString

@NonNull
public java.lang.String toString()

Overrides:

toString in class java.lang.Object