com.estimote.coresdk.observation.region

Class AbstractRegionMonitor<T extends RegionDecorator,E extends Packet>

java.lang.Object

com.estimote.coresdk.observation.region.AbstractRegionMonitor<T,E>

All Implemented Interfaces:

RegionMonitor<T,E>

Direct Known Subclasses:

BeaconRegionMonitor, MirrorRegionMonitor

public abstract class AbstractRegionMonitor<T extends RegionDecorator,E extends Packet>
extends java.lang.Object
implements RegionMonitor<T,E>

This class implements the common monitoring mechanism. Child classes are only responsible for concrete operations on different concrete regions/packets.

Author:

Pawel Dylag (pawel.dylag@estimote.com)

Constructor Summary

Constructors

Constructor and Description
AbstractRegionMonitor(SystemTime timer)

Method Summary

Modifier and Type	Method and Description
void	add(T region)
void	clear()
protected abstract void	invokeEnterRegionCallbacks(T regionDecorator, BeaconServiceMessenger messenger)
protected abstract void	invokeExitRegionCallbacks(T regionDecorator, BeaconServiceMessenger messenger)
boolean	isActive()
boolean	isInsideAnyRegion()
protected abstract boolean	isPacketInRegion(E packet, T regionDecorator)
void	processEnteredRegions(E packet, BeaconServiceMessenger messenger)
protected abstract void	processFoundPacketsInRegion(T regionDecorator, java.util.Set<E> packets)
void	processNewScanCycle(java.util.List<E> singleScan, BeaconServiceMessenger messenger)
boolean	removeByRegionId(java.lang.String regionId)
void	setRegionExitExpiration(long period)

Methods inherited from class java.lang.Object

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

Constructor Detail

AbstractRegionMonitor

public AbstractRegionMonitor(SystemTime timer)

Method Detail

add

public void add(T region)

Specified by:

add in interface RegionMonitor<T extends RegionDecorator,E extends Packet>

isActive

public boolean isActive()

Specified by:

isActive in interface RegionMonitor<T extends RegionDecorator,E extends Packet>

removeByRegionId

public boolean removeByRegionId(java.lang.String regionId)

Specified by:

removeByRegionId in interface RegionMonitor<T extends RegionDecorator,E extends Packet>

isInsideAnyRegion

public boolean isInsideAnyRegion()

Specified by:

isInsideAnyRegion in interface RegionMonitor<T extends RegionDecorator,E extends Packet>

processNewScanCycle

public void processNewScanCycle(java.util.List<E> singleScan,
                                BeaconServiceMessenger messenger)

Specified by:

processNewScanCycle in interface RegionMonitor<T extends RegionDecorator,E extends Packet>

processEnteredRegions

public void processEnteredRegions(E packet,
                                  BeaconServiceMessenger messenger)

Specified by:

processEnteredRegions in interface RegionMonitor<T extends RegionDecorator,E extends Packet>

setRegionExitExpiration

public void setRegionExitExpiration(long period)

Specified by:

setRegionExitExpiration in interface RegionMonitor<T extends RegionDecorator,E extends Packet>

clear

public void clear()

Specified by:

clear in interface RegionMonitor<T extends RegionDecorator,E extends Packet>

isPacketInRegion

protected abstract boolean isPacketInRegion(E packet,
                                            T regionDecorator)

processFoundPacketsInRegion

protected abstract void processFoundPacketsInRegion(T regionDecorator,
                                                    java.util.Set<E> packets)

invokeEnterRegionCallbacks

protected abstract void invokeEnterRegionCallbacks(T regionDecorator,
                                                   BeaconServiceMessenger messenger)

invokeExitRegionCallbacks

protected abstract void invokeExitRegionCallbacks(T regionDecorator,
                                                  BeaconServiceMessenger messenger)