org.placelab.mapper
Class Beacon

java.lang.Object
  org.placelab.mapper.Beacon

Direct Known Subclasses:

BluetoothBeacon, GSMBeacon, UnknownBeacon, WiFiBeacon

public abstract class Beacon

extends java.lang.Object

A beacon is a generalized access point for a cellular network (like 802.11 or Bluetooth or GSM). In the case of 802.11, humanReadableName maps to the SSID and uniqueID maps to BSSID. All beacons must have a known location.

Constructor Summary

Beacon()

Method Summary

static Beacon	create(java.lang.Class klass, java.util.Hashtable map)
abstract void	fromHashMap(java.util.Hashtable map) Loads the Beacon from a HashMap where values are keyed by the appropriate fields for the Beacon type in Types
abstract java.lang.String	getId() Gets the unique id for this Beacon as a String
abstract int	getMaximumRange() Gets a sensible maximum range, further than which the Beacon won't be detectable
abstract Coordinate	getPosition() Gets the position for where this Beacon resides in the world
abstract java.lang.String	getType() Gets the type of this Beacon as a String.
abstract java.util.Hashtable	toHashMap() Stores the Beacon into a HashMap where values are keyed by the appropriate fields for the Beacon type in Types
java.lang.String	toString()

Methods inherited from class java.lang.Object

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

Constructor Detail

Beacon

public Beacon()

Method Detail

create

public static Beacon create(java.lang.Class klass,
                            java.util.Hashtable map)

toString

public java.lang.String toString()

fromHashMap

public abstract void fromHashMap(java.util.Hashtable map)

Loads the Beacon from a HashMap where values are keyed by the appropriate fields for the Beacon type in Types

toHashMap

public abstract java.util.Hashtable toHashMap()

Stores the Beacon into a HashMap where values are keyed by the appropriate fields for the Beacon type in Types

getId

public abstract java.lang.String getId()

Gets the unique id for this Beacon as a String

getType

public abstract java.lang.String getType()

Gets the type of this Beacon as a String. Known Beacon types are listed in Types

getPosition

public abstract Coordinate getPosition()

Gets the position for where this Beacon resides in the world

getMaximumRange

public abstract int getMaximumRange()

Gets a sensible maximum range, further than which the Beacon won't be detectable