org.rifidi.edge.sensors

Class AbstractSensor<T extends SensorSession>

java.lang.Object

org.rifidi.edge.configuration.RifidiService

org.rifidi.edge.sensors.AbstractSensor<T>

All Implemented Interfaces:

CompositeSensor, Sensor, SensorUpdate

Direct Known Subclasses:

Alien9800Reader, AlienAutonomousSensor, AwidSensor, CslSocketSensor, GenericSensor, LLRPReader, Thingmagic6Sensor, ThingmagicReader, ThinkifyUSBSensor

public abstract class AbstractSensor<T extends SensorSession>
extends RifidiService
implements SensorUpdate, CompositeSensor

A reader creates and manages instances of sessions. The reader itself holds all configuration parameters and creates the sessions according to these. The returned sensorSession objects are immutable and if some parameters of the factory change after a session has been created, the created session will retain its configuration until it is destroyed and a new one is created

Author:

Jochen Mader - jochen@pramari.com

Constructor Summary

Constructors

Constructor and Description
AbstractSensor() This constructor is only for CGLIB.

Method Summary

Modifier and Type	Method and Description
void	addReceiver(Sensor receiver) Add a sensor to the list of sensors that receive sensor reads from this sensor.
abstract void	applyPropertyChanges() Send properties that have been modified to the physical reader
abstract java.lang.String	createSensorSession() Create a new sensor session.
abstract java.lang.String	createSensorSession(SessionDTO sessionDTO) This method is called when a sensor session is being created from a DTO, such as restoring the session from persistance.
abstract void	destroySensorSession(java.lang.String id) Destroy a sesnor session.
java.util.Set<java.lang.String>	getChildren() Get the names of child sensors this sensor has.
ReaderDTO	getDTO(Configuration config) This method returns the Data Transfer Object for this Reader
java.lang.String	getName() Get the name of the sensor.
abstract java.util.Map<java.lang.String,SensorSession>	getSensorSessions() Get all currently created reader sessions.
java.lang.Boolean	isImmutable() Check if the sensor is immutable.
java.lang.Boolean	isInUse() Check if the sensor is in use.
EsperEventContainer	receive(java.lang.Object receiver) Objects subscribed to the sensor use this method to acquire the read results.
void	register(org.osgi.framework.BundleContext context, java.lang.String readerType) Register the reader to OSGi.
void	register(org.osgi.framework.BundleContext context, java.lang.String readerType, java.util.Map<java.lang.String,java.lang.String> filterParams) Register the reader to OSGi.
void	removeReceiver(Sensor receiver) Remove a sensor from the list of sensors that receive sensor reads from this sensor.
void	send(ReadCycle cycle) Send sensor results to this sensor.
void	sendEvent(java.lang.Object event) Send a non ReadCycle event to esper.
void	setName(java.lang.String name)
void	setNotifiyService(NotifierService notifierService) Set the wrapper for the Notify Service.
void	subscribe(java.lang.Object receiver) Subscribe an object to the sensor.
java.lang.String	toString()
abstract void	unbindCommandConfiguration(AbstractCommandConfiguration<?> commandConfiguration, java.util.Map<?,?> properties) Notifier the sensor that a command configuration has disappeared.
void	unsubscribe(java.lang.Object receiver) Unsubscribe an object from the sensor.

Methods inherited from class org.rifidi.edge.configuration.RifidiService

getAttribute, getAttributes, getAttributes, getID, getMBeanInfo, setAttribute, setAttributes, setID

Methods inherited from class java.lang.Object

equals, getClass, hashCode, notify, notifyAll, wait, wait, wait

Constructor Detail

AbstractSensor

public AbstractSensor()

This constructor is only for CGLIB. DO NOT OVERWRITE!

Method Detail

createSensorSession

public abstract java.lang.String createSensorSession()
                                              throws CannotCreateSessionException

Create a new sensor session.

Returns:

id of the created session

Throws:

CannotCreateSessionException - - if the session cannot be created

createSensorSession

public abstract java.lang.String createSensorSession(SessionDTO sessionDTO)
                                              throws CannotCreateSessionException

This method is called when a sensor session is being created from a DTO, such as restoring the session from persistance.

Parameters:

sessionDTO -

Returns:

the ID of the session

Throws:

CannotCreateSessionException - if the session cannot be created

getSensorSessions

public abstract java.util.Map<java.lang.String,SensorSession> getSensorSessions()

Get all currently created reader sessions. The Key is the ID of the session, and the value is the actual session

Returns:

destroySensorSession

public abstract void destroySensorSession(java.lang.String id)
                                   throws CannotDestroySensorException

Destroy a sesnor session.

Parameters:

session -

Throws:

CannotDestroySensorException

applyPropertyChanges

public abstract void applyPropertyChanges()

Send properties that have been modified to the physical reader

unbindCommandConfiguration

public abstract void unbindCommandConfiguration(AbstractCommandConfiguration<?> commandConfiguration,
                                                java.util.Map<?,?> properties)

Notifier the sensor that a command configuration has disappeared.

Parameters:

commandConfiguration -

properties -

receive

public EsperEventContainer receive(java.lang.Object receiver)
                            throws NotSubscribedException

Description copied from interface: Sensor

Objects subscribed to the sensor use this method to acquire the read results.

Specified by:

receive in interface Sensor

Throws:

NotSubscribedException

subscribe

public void subscribe(java.lang.Object receiver)
               throws DuplicateSubscriptionException

Description copied from interface: SensorUpdate

Subscribe an object to the sensor.

Specified by:

subscribe in interface SensorUpdate

Throws:

DuplicateSubscriptionException

getName

public java.lang.String getName()

Description copied from interface: Sensor

Get the name of the sensor.

Specified by:

getName in interface Sensor

Returns:

unsubscribe

public void unsubscribe(java.lang.Object receiver)
                 throws NotSubscribedException

Description copied from interface: SensorUpdate

Unsubscribe an object from the sensor.

Specified by:

unsubscribe in interface SensorUpdate

Throws:

NotSubscribedException

removeReceiver

public void removeReceiver(Sensor receiver)

Description copied from interface: SensorUpdate

Remove a sensor from the list of sensors that receive sensor reads from this sensor.

Specified by:

removeReceiver in interface SensorUpdate

addReceiver

public void addReceiver(Sensor receiver)

Description copied from interface: SensorUpdate

Add a sensor to the list of sensors that receive sensor reads from this sensor.

Specified by:

addReceiver in interface SensorUpdate

setName

public void setName(java.lang.String name)
             throws ImmutableException,
                    InUseException

Specified by:

setName in interface SensorUpdate

Throws:

ImmutableException

InUseException

setNotifiyService

public void setNotifiyService(NotifierService notifierService)

Set the wrapper for the Notify Service.

Parameters:

wrapper - The JMS Notifier to set

send

public void send(ReadCycle cycle)

Description copied from interface: Sensor

Send sensor results to this sensor.

Specified by:

send in interface Sensor

sendEvent

public void sendEvent(java.lang.Object event)

Description copied from interface: Sensor

Send a non ReadCycle event to esper.

Specified by:

sendEvent in interface Sensor

isImmutable

public java.lang.Boolean isImmutable()

Description copied from interface: Sensor

Check if the sensor is immutable.

Specified by:

isImmutable in interface Sensor

Returns:

isInUse

public java.lang.Boolean isInUse()

Description copied from interface: Sensor

Check if the sensor is in use.

Specified by:

isInUse in interface Sensor

Returns:

getChildren

public java.util.Set<java.lang.String> getChildren()

Description copied from interface: CompositeSensor

Get the names of child sensors this sensor has.

Specified by:

getChildren in interface CompositeSensor

Returns:

getDTO

public ReaderDTO getDTO(Configuration config)

This method returns the Data Transfer Object for this Reader

Parameters:

config - The Configuration Object for this AbstractSensor

Returns:

A data transfer object for this reader

register

public void register(org.osgi.framework.BundleContext context,
                     java.lang.String readerType)

Register the reader to OSGi. Registers the service with the following params:

 type - "reader"
 reader - the reader type supplied as an argument
 serviceid - the service ID of the reader
 

Parameters:

context - The Bundlecontext to use

readerType - The Type of reader to register it as

register

public void register(org.osgi.framework.BundleContext context,
                     java.lang.String readerType,
                     java.util.Map<java.lang.String,java.lang.String> filterParams)

Register the reader to OSGi. Registers the service with the following params:

 type - "reader"
 reader - the reader type supplied as an argument
 serviceid - the service ID of the reader
 

Parameters:

context - The Bundlecontext to use

readerType - The Type of reader to register it as

filterParams - Any additional OSGi filter params to use when registering the service

toString

public java.lang.String toString()

Overrides:

toString in class java.lang.Object