com.radiusnetworks.proximity.model

Class KitOverlay

java.lang.Object

com.radiusnetworks.proximity.model.KitOverlay

public class KitOverlay
extends Object

An overlay (geofence) created on the ProximityKit server

Since:

0.1.0

Constructor Summary

Constructors

Constructor and Description
KitOverlay() Deprecated. Not for public use - no replacement. As of 0.12.0 this method could possibly be retained only as a private method.

Method Summary

Modifier and Type	Method and Description
static KitOverlay	fromJson(JSONObject json) Create an overlay from the provided JSON.
Map	getAttributes()
String	getIdentifier() Entity identifier for this overlay.
Double	getLatitude()
Double	getLongitude()
String	getName()
Double	getRadius()
ProximityKitGeofenceRegion	toGeofence()

Methods inherited from class java.lang.Object

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

Constructor Detail

KitOverlay

@Deprecated
public KitOverlay()

Deprecated. Not for public use - no replacement. As of 0.12.0 this method could possibly be retained only as a private method.

Create a kit map overlay region.

Not for public use.

This method was not meant to be part of the public API. It is intended to be called internally while processing JSON from the server.

Method Detail

getAttributes

public Map getAttributes()

getIdentifier

public String getIdentifier()

Entity identifier for this overlay.

This uniquely identifies the overlay within the kit.

Returns:

this overlay's entity identifier or null if it wasn't provided by the kit

Since:

0.13.0

getLatitude

public Double getLatitude()

getLongitude

public Double getLongitude()

getRadius

public Double getRadius()

getName

public String getName()

toGeofence

public ProximityKitGeofenceRegion toGeofence()

fromJson

public static KitOverlay fromJson(JSONObject json)
                           throws JSONException

Create an overlay from the provided JSON.

Not for public use.

This method was not meant to be part of the public API. It is intended to be called internally while processing JSON from the server.

The expected JSON format is as follows:

     {
         "name": "Optional: Any Name",
         "center": [-90.0, 180.0],
         "radius": 1.0,
         "attributes": {
             "key1": "value1",
             "key2": "value2"
         }
     }
 

Parameters:

json - JSON object containing the overlay fields.

Returns:

a new KitOverlay with fields matching the provided JSON values.

Throws:

JSONException - If there was an error processing the JSON or if either of the required fields "center" and "radius" were not present or contained invalid values.