org.commonreality.sensors.xml

Class XMLSensor

java.lang.Object

org.commonreality.participant.impl.AbstractParticipant

org.commonreality.sensors.AbstractSensor

org.commonreality.sensors.xml.XMLSensor

All Implemented Interfaces:

IIdentifiable, IParticipant, ISensor

public class XMLSensor
extends AbstractSensor

Author:

developer

Nested Class Summary

Nested classes/interfaces inherited from interface org.commonreality.participant.IParticipant

IParticipant.State

Field Summary

Fields

Modifier and Type	Field and Description
protected java.util.List<org.w3c.dom.Element>	_pendingTimeFrames
protected XMLProcessor	_processor
protected java.util.concurrent.ExecutorService	_service
static java.lang.String	DATA_URL

Constructor Summary

Constructors

Constructor and Description
XMLSensor()

Method Summary

Modifier and Type	Method and Description
void	configure(java.util.Map<java.lang.String,java.lang.String> options) configure the participant.
void	executeFrameNow(org.w3c.dom.Element element) will process the frame data immediately in the current thread.
java.lang.String	getName()
boolean	hasPendingTimeFrames()
void	initialize() called in response to a command from Reality to get everything ready to run.
protected void	load(java.lang.String dataURI)
void	load(java.net.URL resource)
void	queueFrame(org.w3c.dom.Element element)
void	queueNextFrame()
void	shutdown() shutdown the participant if it is stopped and disconnect
void	start() called to actually start this participant
void	stop() called when this participant needs to stop

Methods inherited from class org.commonreality.sensors.AbstractSensor

agentAdded, agentRemoved, agentUpdated, connect, createAfferentObjectManager, createAgentObjectManager, createEfferentObjectManager, createRealObjectManager, createSensor, disconnect, getAddressingInformation, getAfferentObjectManager, getCredentials, getEfferentObjectManager, getInterfacedAgents, getRealObjectManager, isInterfacedAgent, setCredentials, setIdentifier, shouldInterface

Methods inherited from class org.commonreality.participant.impl.AbstractParticipant

addClientService, addServerService, checkState, clearObjectManagers, createEfferentCommandManager, createIOExecutorService, createIOHandler, createNotificationManager, createSensorObjectManager, disconnect, getAgentObjectManager, getCentralThreadFactory, getClock, getCommonRealityIdentifier, getEfferentCommandManager, getIdentifier, getIOExecutor, getIOHandler, getIOThreadFactory, getNotificationManager, getPeriodicExecutor, getSensorObjectManager, getServerAddressInformation, getState, reset, resume, send, setClock, setCommonRealityIdentifier, shutdown, stateMatches, suspend, waitForState, waitForState

Methods inherited from class java.lang.Object

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

Methods inherited from interface org.commonreality.participant.IParticipant

disconnect, getAgentObjectManager, getClock, getEfferentCommandManager, getNotificationManager, getSensorObjectManager, getState, reset, resume, send, shutdown, stateMatches, suspend, waitForState, waitForState

Methods inherited from interface org.commonreality.identifier.IIdentifiable

getIdentifier

Field Detail

DATA_URL

public static final java.lang.String DATA_URL

See Also:

Constant Field Values

_pendingTimeFrames

protected java.util.List<org.w3c.dom.Element> _pendingTimeFrames

_processor

protected XMLProcessor _processor

_service

protected java.util.concurrent.ExecutorService _service

Constructor Detail

XMLSensor

public XMLSensor()

Method Detail

getName

public java.lang.String getName()

Specified by:

getName in class AbstractParticipant

See Also:

AbstractParticipant.getName()

hasPendingTimeFrames

public boolean hasPendingTimeFrames()

queueNextFrame

public void queueNextFrame()

start

public void start()
           throws java.lang.Exception

Description copied from class: AbstractParticipant

called to actually start this participant

Specified by:

start in interface IParticipant

Overrides:

start in class AbstractParticipant

Throws:

java.lang.Exception

stop

public void stop()
          throws java.lang.Exception

Description copied from class: AbstractParticipant

called when this participant needs to stop

Specified by:

stop in interface IParticipant

Overrides:

stop in class AbstractParticipant

Throws:

java.lang.Exception

shutdown

public void shutdown()
              throws java.lang.Exception

Description copied from interface: IParticipant

shutdown the participant if it is stopped and disconnect

Specified by:

shutdown in interface IParticipant

Overrides:

shutdown in class AbstractSensor

Throws:

java.lang.Exception

configure

public void configure(java.util.Map<java.lang.String,java.lang.String> options)
               throws java.lang.Exception

Description copied from interface: IParticipant

configure the participant. this may be called at while UNKNOWN, CONNECTED, INITIALIZED, or STOPPED

Specified by:

configure in interface IParticipant

Overrides:

configure in class AbstractParticipant

Throws:

java.lang.Exception

queueFrame

public void queueFrame(org.w3c.dom.Element element)

executeFrameNow

public void executeFrameNow(org.w3c.dom.Element element)

will process the frame data immediately in the current thread. this should be used with caution as no checks are performed to ensure that the frame doesnt contain time relative information. Nor does it take into account any data that is pending delivery through the normal element frame queue

Parameters:

element -

initialize

public void initialize()
                throws java.lang.Exception

Description copied from class: AbstractParticipant

called in response to a command from Reality to get everything ready to run. we must be connected first.

Specified by:

initialize in interface IParticipant

Overrides:

initialize in class AbstractParticipant

Throws:

java.lang.Exception

load

public void load(java.net.URL resource)

load

protected void load(java.lang.String dataURI)