com.whitestein.lsps.engine.state.xml

Class Signal

java.lang.Object

com.whitestein.lsps.engine.state.xml.Signal

All Implemented Interfaces:

Collectible, EntityWithId, ModelInstanceAware

public class Signal
extends java.lang.Object
implements Collectible, ModelInstanceAware, EntityWithId

Entity representing an item in the signal queue.

Author:

rba

Constructor Summary

Constructors

Constructor and Description
Signal(long id, ModelInstance modelInstance, Value value, java.lang.String sourceDescription) Creates new instance.
Signal(ModelInstance modelInstance, Value value, java.lang.String sourceDescription) Creates new instance.

Method Summary

Modifier and Type	Method and Description
void	collect() Removes itself from the process.
Signal	createCopy(ModelInstance targetModelInstance) Returns deep copy.
void	finishCopy(com.whitestein.lsps.engine.state.xml.Copiable source, CopyHelper helper) Copy references.
long	getId() Returns the id.
ModelInstance	getModelInstance() Returns the model instance.
java.util.Collection<Collectible>	getReferences() Returns collection of all referenced collectible objects.
java.lang.String	getSourceDescription() Gets the description of the signals source.
Value	getValue() Returns the value.
boolean	isConsumed() Returns true if consumed.
boolean	isInserted() Returns true if inserted.
boolean	isPersistent() Returns true if this object cannot be collected.
void	rebind(ModelInstance modelInstance) Re-bind to the provided model instance.
void	setConsumed(boolean consumed) Sets consumed.
void	setInserted(boolean inserted) Sets inserted.
void	setSourceDescription(java.lang.String description)
SSignal	toSerializable(SModelInstance smi, MarshallerConfig config) Creates a serializable object.
java.lang.String	toString()

Methods inherited from class java.lang.Object

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

Constructor Detail

Signal

public Signal(ModelInstance modelInstance,
              Value value,
              java.lang.String sourceDescription)

Creates new instance.

Parameters:

modelInstance -

value -

sourceDescription - the description of the signals source

Throws:

java.lang.NullPointerException - if modelInstance or value is null

Signal

public Signal(long id,
              ModelInstance modelInstance,
              Value value,
              java.lang.String sourceDescription)

Creates new instance.

Parameters:

id -

modelInstance -

value -

sourceDescription - the description of the signals source

Throws:

java.lang.NullPointerException - if modelInstance or value is null

Method Detail

toSerializable

public SSignal toSerializable(SModelInstance smi,
                              MarshallerConfig config)

Creates a serializable object.

Parameters:

smi -

config -

Returns:

a serializable object

getId

public long getId()

Description copied from interface: EntityWithId

Returns the id.

Specified by:

getId in interface EntityWithId

Returns:

the id

getValue

public Value getValue()

Returns the value.

Returns:

the value

getModelInstance

public ModelInstance getModelInstance()

Description copied from interface: ModelInstanceAware

Returns the model instance.

Specified by:

getModelInstance in interface ModelInstanceAware

Returns:

the model instance

rebind

public void rebind(ModelInstance modelInstance)

Description copied from interface: ModelInstanceAware

Re-bind to the provided model instance.

Specified by:

rebind in interface ModelInstanceAware

isConsumed

public boolean isConsumed()

Returns true if consumed.

Returns:

true if consumed

setConsumed

public void setConsumed(boolean consumed)

Sets consumed.

Parameters:

consumed -

isInserted

public boolean isInserted()

Returns true if inserted.

Returns:

true if inserted

setInserted

public void setInserted(boolean inserted)

Sets inserted.

Parameters:

inserted -

getSourceDescription

public java.lang.String getSourceDescription()

Gets the description of the signals source.

Returns:

the signals source description

setSourceDescription

public void setSourceDescription(java.lang.String description)

Parameters:

description - the description of the source

See Also:

getSourceDescription()

isPersistent

public boolean isPersistent()

Description copied from interface: Collectible

Returns true if this object cannot be collected.

Specified by:

isPersistent in interface Collectible

Returns:

collected

getReferences

public java.util.Collection<Collectible> getReferences()

Description copied from interface: Collectible

Returns collection of all referenced collectible objects.

Specified by:

getReferences in interface Collectible

Returns:

collection of all referenced collectible objects

collect

public void collect()

Description copied from interface: Collectible

Removes itself from the process. This method is called only when the element is not persistence and is not referenced directly or indirectly from any other persistence element.

Specified by:

collect in interface Collectible

createCopy

public Signal createCopy(ModelInstance targetModelInstance)

Returns deep copy.

Parameters:

targetModelInstance -

Returns:

deep copy

finishCopy

public void finishCopy(com.whitestein.lsps.engine.state.xml.Copiable source,
                       CopyHelper helper)

Copy references.

toString

public java.lang.String toString()

Overrides:

toString in class java.lang.Object