org.placelab.core
Interface BeaconReading

All Known Implementing Classes:

BluetoothReading, GSMReading, WiFiReading

public interface BeaconReading

A BeaconReading represents a sighting of a single wireless beacon from a Spotter that spots for wireless Beacons. Spotters typically return BeaconMeasurement objects that have zero or more BeaconReadings in them.

Method Summary

java.lang.String	getHumanReadableName()
java.lang.String	getId()
int	getNormalizedSignalStrength()
java.lang.String	getType()
boolean	isValid() returns true if the id for this beacon is within the range of acceptable values, for instance if it is not all zeroes.
void	toCompressedBytes(java.io.DataOutputStream dos)
java.lang.String	toLogString()
java.lang.String	toShortString()

Method Detail

getId

public java.lang.String getId()

Returns:

a globally unique ID for this reading

getType

public java.lang.String getType()

Returns:

the type of reading that this is (WIFI, BLUETOOTH, GSM, etc)

getNormalizedSignalStrength

public int getNormalizedSignalStrength()

Returns:

an int 0-100 depending on the signal strength, or -1 if unsupported

toLogString

public java.lang.String toLogString()

toShortString

public java.lang.String toShortString()

toCompressedBytes

public void toCompressedBytes(java.io.DataOutputStream dos)
                       throws java.io.IOException

Throws:

java.io.IOException

getHumanReadableName

public java.lang.String getHumanReadableName()

Returns:

a human readable name (if any) for this reading

isValid

public boolean isValid()

returns true if the id for this beacon is within the range of acceptable values, for instance if it is not all zeroes.