net.sf.cuf.model

Class AspectAdapter<T,S>

java.lang.Object

net.sf.cuf.model.AbstractValueModel<T>

net.sf.cuf.model.AspectAdapter<T,S>

Type Parameters:

T - the type we contain as our value

S - the type the source is from

All Implemented Interfaces:

EventListener, ChangeListener, DelegateAccess, ExternalUpdate, ValueModel<T>

public class AspectAdapter<T,S>
extends AbstractValueModel<T>
implements ValueModel<T>, ChangeListener, DelegateAccess, ExternalUpdate

A AspectAdapter is a ValueModel that takes a part (=an aspect) of an other object (called the source) as its value.
To detect changes of the aspect, the source must be the value of a ValueModel. If the source is not wrapped in a ValueModel, a change in the source can't be detected.
The aspect is described via a string like "attribut1/attribut2" and getting/setting the aspect is done via reflection like source.getAttribut1().getAttribut2() or source.getAttribut1().setAttribut2().
An alternative to the reflection access is via usage of the Map get/put interface.
The normal mode of operation is that a ValueModel holds some "transport" level type of object, which usally is quite dump, i.e. just a structure ("Value Object") with JavaBeans semantics.
When different AspectAdapters wrap different parts of such a structure, it must be carefully avoided that more than one AspectAdapter maps (parts of) the same data, because those two adapters won't notice each other changes.

Field Summary

Fields

Modifier and Type	Field and Description
static String	GET Default get method name prefix.
static String	SEPARATOR The separator between attributes.
static String	SET Default set method name prefix.

Constructor Summary

Constructors

Constructor and Description
AspectAdapter(S pSource, String pAspectName) Creates a new AspectAdapter.
AspectAdapter(S pSource, String pAspectName, String pGetterPrefix, String pSetterPrefix) Creates a new AspectAdapter.
AspectAdapter(ValueModel<S> pTrigger, Class<S> pSourceClass, AspectAccessAdapter pAccessAdapter, String pAspectName) Creates a new AspectAdapter.
AspectAdapter(ValueModel<S> pTrigger, Class<S> pSourceClass, AspectAccessAdapter pAccessAdapter, String pAspectName, String pGetterPrefix, String pSetterPrefix) Creates a new AspectAdapter.
AspectAdapter(ValueModel<S> pTrigger, Class<S> pSourceClass, String pAspectName) Creates a new AspectAdapter.
AspectAdapter(ValueModel<S> pTrigger, Class<S> pSourceClass, String pAspectName, String pGetterPrefix, String pSetterPrefix) Creates a new AspectAdapter.
AspectAdapter(ValueModel<S> pTrigger, String pAspectName) Creates a new AspectAdapter.
AspectAdapter(ValueModel<S> pTrigger, String pAspectName, String pGetterPrefix, String pSetterPrefix) Creates a new AspectAdapter.

Method Summary

Methods

Modifier and Type	Method and Description
void	dispose() Cleanup all resources: disconnect from any input sources (like other ValueModel's ...), and remove all listeners.
AspectAccessAdapter	getAccessAdapter()
String	getAspectName() Return the aspect of the aspect adapter.
static AspectAdapter<?,?>	getShared(ValueModel<?> pTrigger, String pAspectName) Create a new AspectAdapter or re-use an existing one.
ValueModel<? extends S>	getTrigger() Returns null or the trigger ValueModel of this aspect adapter.
T	getValue() Get the current value, during a callback this is the new value.
Object	getValue(Object pValue) Transform the handed value to a new value.
boolean	isEditable() Returns true if a setValue() is possible, and doesn't throw always an UnsupportedOperationException.
void	setAccessAdapter(AspectAccessAdapter pAccessAdapter) Sets the access adapter to use when setting or getting values.
void	setValue(T pValue, boolean pIsSetForced) Set a new value, this will fire a ChangeEvent if the new value is different from the old value.
void	signalExternalUpdate() Signal this object that portions of its data changed.
void	stateChanged(ChangeEvent pEvent) Invoked when the target of the listener has changed its state.

Methods inherited from class net.sf.cuf.model.AbstractValueModel

addChangeListener, booleanValue, checkDisposed, doubleValue, fireStateChanged, floatValue, getDependents, getName, intValue, isDisposed, isInSetValue, isSetForced, longValue, onChangeSend, removeChangeListener, retractInterestsFor, setInSetValue, setName, setObjectValue, setValue, setValue, setValue, setValue, setValue, setValue, setValueForced, stringValue

Methods inherited from class java.lang.Object

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

Methods inherited from interface net.sf.cuf.model.ValueModel

addChangeListener, booleanValue, doubleValue, floatValue, getDependents, getName, intValue, isDisposed, isSetForced, longValue, onChangeSend, removeChangeListener, retractInterestsFor, setName, setObjectValue, setValue, setValue, setValue, setValue, setValue, setValue, setValueForced, stringValue

Field Detail

SEPARATOR

public static final String SEPARATOR

The separator between attributes.

See Also:

Constant Field Values

GET

public static final String GET

Default get method name prefix.

See Also:

Constant Field Values

SET

public static final String SET

Default set method name prefix.

See Also:

Constant Field Values

Constructor Detail

AspectAdapter

public AspectAdapter(ValueModel<S> pTrigger,
             String pAspectName)

Creates a new AspectAdapter.

Parameters:

pTrigger - the source object of our aspect is the trigger's value

pAspectName - a string describing the attributes (seperated by SEPARATOR) to our aspect.

Throws:

IllegalArgumentException - if pTrigger is null or pAspectName doesn't map to valid methods

AspectAdapter

public AspectAdapter(ValueModel<S> pTrigger,
             String pAspectName,
             String pGetterPrefix,
             String pSetterPrefix)

Creates a new AspectAdapter.

Parameters:

pTrigger - the source object of our aspect is the trigger's value

pAspectName - a string describing the attributes (seperated by SEPARATOR) to our aspect.

pGetterPrefix - the prefix we use for the "getter", must not be null nor empty

pSetterPrefix - the prefix we use for the "getter", must not be null nor empty nor the getter prefix

Throws:

IllegalArgumentException - if pTrigger is null or pAspectName doesn't map to valid methods

AspectAdapter

public AspectAdapter(ValueModel<S> pTrigger,
             Class<S> pSourceClass,
             String pAspectName)

Creates a new AspectAdapter.

Parameters:

pTrigger - the source object of our aspect is the trigger's value

pSourceClass - the class of the value of pTrigger, if this is a Map, the Map.get() and Map.put() methods are used to access the aspect.

pAspectName - a string describing the attributes (seperated by SEPARATOR) to our aspect.

Throws:

IllegalArgumentException - if pTrigger is null or pAspectName doesn't map to valid methods

AspectAdapter

public AspectAdapter(ValueModel<S> pTrigger,
             Class<S> pSourceClass,
             String pAspectName,
             String pGetterPrefix,
             String pSetterPrefix)

Creates a new AspectAdapter.

Parameters:

pTrigger - the source object of our aspect is the trigger's value

pSourceClass - the class of the value of pTrigger, if this is a Map, the Map.get() and Map.put() methods are used to access the aspect.

pAspectName - a string describing the attributes (seperated by SEPARATOR) to our aspect.

pGetterPrefix - the prefix we use for the "getter", must not be null nor empty

pSetterPrefix - the prefix we use for the "getter", must not be null nor empty nor the getter prefix

Throws:

IllegalArgumentException - if pTrigger is null or pAspectName doesn't map to valid methods

AspectAdapter

public AspectAdapter(ValueModel<S> pTrigger,
             Class<S> pSourceClass,
             AspectAccessAdapter pAccessAdapter,
             String pAspectName)

Creates a new AspectAdapter.

Parameters:

pTrigger - the source object of our aspect is the trigger's value

pSourceClass - the class of the value of pTrigger, if this is a Map, the Map.get() and Map.put() methods are used to access the aspect.

pAccessAdapter - the access adapter, may be null

pAspectName - a string describing the attributes (seperated by SEPARATOR) to our aspect.

Throws:

IllegalArgumentException - if pTrigger is null or pAspectName doesn't map to valid methods

AspectAdapter

public AspectAdapter(ValueModel<S> pTrigger,
             Class<S> pSourceClass,
             AspectAccessAdapter pAccessAdapter,
             String pAspectName,
             String pGetterPrefix,
             String pSetterPrefix)

Creates a new AspectAdapter.

Parameters:

pTrigger - the source object of our aspect is the trigger's value

pSourceClass - the class of the value of pTrigger, if this is a Map, the Map.get() and Map.put() methods are used to access the aspect.

pAccessAdapter - the access adapter, may be null

pAspectName - a string describing the attributes (seperated by SEPARATOR) to our aspect.

pGetterPrefix - the prefix we use for the "getter", must not be null nor empty

pSetterPrefix - the prefix we use for the "getter", must not be null nor empty nor the getter prefix

Throws:

IllegalArgumentException - if pTrigger is null or pAspectName doesn't map to valid methods

AspectAdapter

public AspectAdapter(S pSource,
             String pAspectName)

Creates a new AspectAdapter.

Parameters:

pSource - the source object of our aspect

pAspectName - a string describing the attributes (seperated by SEPARATOR) to our aspect.

Throws:

IllegalArgumentException - if pSource or pAspectName is null or pAspectName doesn't map to valid methods

AspectAdapter

public AspectAdapter(S pSource,
             String pAspectName,
             String pGetterPrefix,
             String pSetterPrefix)

Creates a new AspectAdapter.

Parameters:

pSource - the source object of our aspect

pAspectName - a string describing the attributes (seperated by SEPARATOR) to our aspect.

pGetterPrefix - the prefix we use for the "getter", must not be null nor empty

pSetterPrefix - the prefix we use for the "getter", must not be null nor empty nor the getter prefix

Throws:

IllegalArgumentException - if pSource or pAspectName is null or pAspectName doesn't map to valid methods

Method Detail

getShared

public static AspectAdapter<?,?> getShared(ValueModel<?> pTrigger,
                           String pAspectName)

Create a new AspectAdapter or re-use an existing one. This factory method uses the getDependents() method from the AbstractValueModel to find already existing AspectAdapter's for the same aspect. Warning: we don't search recursivly, so the aspect name must be exactly equal.

Parameters:

pTrigger - the trigger, must not be null

pAspectName - string describing the attributes (seperated by SEPARATOR) to our aspect

Returns:

a new or shared aspect adapter

getAccessAdapter

public AspectAccessAdapter getAccessAdapter()

Returns:

the access adapter used to set and get values, never null

setAccessAdapter

public void setAccessAdapter(AspectAccessAdapter pAccessAdapter)

Sets the access adapter to use when setting or getting values.

Parameters:

pAccessAdapter - the adapter to use, must not be null

isEditable

public boolean isEditable()

Returns true if a setValue() is possible, and doesn't throw always an UnsupportedOperationException.

Specified by:

isEditable in interface ValueModel<T>

Returns:

false if setValue will always throw an exception

getAspectName

public String getAspectName()

Return the aspect of the aspect adapter.

Returns:

the access string, never null

getTrigger

public ValueModel<? extends S> getTrigger()

Returns null or the trigger ValueModel of this aspect adapter.

Returns:

null or a ValueModel

dispose

public void dispose()

Cleanup all resources: disconnect from any input sources (like other ValueModel's ...), and remove all listeners.

Specified by:

dispose in interface ValueModel<T>

Overrides:

dispose in class AbstractValueModel<T>

setValue

public void setValue(T pValue,
            boolean pIsSetForced)

Set a new value, this will fire a ChangeEvent if the new value is different from the old value. If our source is null, the call does nothing.

Specified by:

setValue in interface ValueModel<T>

Parameters:

pValue - the new value (null is o.k.)

pIsSetForced - true if a forced setValue should be done

Throws:

UnsupportedOperationException - if this ValueModel is not mutable

getValue

public T getValue()

Get the current value, during a callback this is the new value.

Specified by:

getValue in interface ValueModel<T>

Returns:

null or the value object

getValue

public Object getValue(Object pValue)

Transform the handed value to a new value. This should not change the current value or trigger any updates.

Specified by:

getValue in interface DelegateAccess

Parameters:

pValue - the value we should assume as our value

Returns:

null or the transformed/mapped value object

signalExternalUpdate

public void signalExternalUpdate()

Signal this object that portions of its data changed. If we have a trigger, we notify it, and assume that it will notify us, otherwise we notify our children directly.

Specified by:

signalExternalUpdate in interface ExternalUpdate

Overrides:

signalExternalUpdate in class AbstractValueModel<T>

stateChanged

public void stateChanged(ChangeEvent pEvent)

Invoked when the target of the listener has changed its state.

Specified by:

stateChanged in interface ChangeListener

Parameters:

pEvent - a ChangeEvent object