net.sf.cuf.model.converter

Class AbstractTypeConverter<OwnT,SubjectT>

java.lang.Object

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

net.sf.cuf.model.converter.AbstractTypeConverter<OwnT,SubjectT>

Type Parameters:

OwnT - the type of the own value

SubjectT - the type of the subject value

All Implemented Interfaces:

EventListener, ChangeListener, TypeConverter<OwnT,SubjectT>, DelegateAccess, ExternalUpdate, ValueModel<OwnT>

Direct Known Subclasses:

AbstractNumberStringConverter, BigDecimalStringConverter, Collection2ListConverter, FormatConverter, ListFilterConverter, RegExpConverter

public abstract class AbstractTypeConverter<OwnT,SubjectT>
extends AbstractValueModel<OwnT>
implements TypeConverter<OwnT,SubjectT>, ChangeListener, DelegateAccess

The AbstractTypeConverter class provides common code for classes providing the TypeConverter inferface. All TypeConverters are ValueModels, and provide their value by converting the original value called the subject.

To use as a super class, implement TypeConverter.convertOwnToSubjectValue(Object) and TypeConverter.convertSubjectToOwnValue(Object). Return the correct value or throw a ConversionException with an optional alternative value. If you throw the exception, the sync state will be disabled, otherwise enabled. If you provide an alternative value in the exception, that value is used as a result.

By default, the converter will throw an exception if the conversion fails and no alternative value is provided by the converter. You can modify that behaviour by setting propagateFailedConversions to false. In that case, a failed conversion will not throw an exception and, in case of a set, the subject value will not be modified, and in case of a get, the own value will be null.

Constructor Summary

Constructors

Modifier	Constructor and Description
protected	AbstractTypeConverter(ValueModel<SubjectT> pSubject) Create a new converter with the handed subject.
protected	AbstractTypeConverter(ValueModel<SubjectT> pSubject, boolean pPropagateFailedConversions) Create a new converter with the handed subject and remember how conversion failures are propagated.

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.
boolean	getPropagateFailedConversions()
ValueModel<SubjectT>	getSubject() Return our subject ValueModel.
protected Object	getSubjectValue() Return the value of the subject without any conversion.
Object	getSyncKey() Get the sync key for the sync state.
String	getSyncMessage() Return a sync message, usefull when the conversation fails.
ValueModel<Boolean>	getSyncState() Return a ValueModel containing a Boolean that shows if the last conversion in setValue() or getValue() was sucessfull.
OwnT	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 always true
void	setPropagateFailedConversions(boolean pPropagateFailedConversions) Sets the flag if we should propagate a failed conversion
void	setSyncKey(Object pKey) Set the sync key for the sync state.
void	setSyncMessage(String pMessage) Set the sync message.
void	setValue(OwnT pValue, boolean pIsSetForced) Set a new value, this will convert the handed value to the subject's value.
void	stateChanged(ChangeEvent pEvent) Invoked when our subject changed.

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, signalExternalUpdate, 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.converter.TypeConverter

convertOwnToSubjectValue, convertSubjectToOwnValue

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

Constructor Detail

AbstractTypeConverter

protected AbstractTypeConverter(ValueModel<SubjectT> pSubject)

Create a new converter with the handed subject.

Parameters:

pSubject - the ValueModel holding the original value, must not be null

Throws:

IllegalArgumentException - if pSubject is null

AbstractTypeConverter

protected AbstractTypeConverter(ValueModel<SubjectT> pSubject,
                     boolean pPropagateFailedConversions)

Create a new converter with the handed subject and remember how conversion failures are propagated.

Parameters:

pSubject - the ValueModel holding the original value, must not be null

pPropagateFailedConversions - if true, we propagate failed conversions as IllegalStateExceptions

Throws:

IllegalArgumentException - if pSubject is null

Method Detail

setPropagateFailedConversions

public void setPropagateFailedConversions(boolean pPropagateFailedConversions)

Sets the flag if we should propagate a failed conversion

Parameters:

pPropagateFailedConversions - if true, we propagate failed conversions as IllegalStateExceptions

getPropagateFailedConversions

public boolean getPropagateFailedConversions()

Returns:

true if we propagate failed conversions

isEditable

public boolean isEditable()

Returns always true

Specified by:

isEditable in interface ValueModel<OwnT>

Returns:

true

getSubject

public ValueModel<SubjectT> getSubject()

Return our subject ValueModel.

Returns:

the subject, never null

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<OwnT>

Overrides:

dispose in class AbstractValueModel<OwnT>

setValue

public void setValue(OwnT pValue,
            boolean pIsSetForced)

Set a new value, this will convert the handed value to the subject's value.

Specified by:

setValue in interface ValueModel<OwnT>

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

IllegalStateException - if we can't convert the value

getValue

public OwnT getValue()

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

Specified by:

getValue in interface ValueModel<OwnT>

Returns:

null or the value object

Throws:

IllegalStateException - if we can't convert the value

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

getSubjectValue

protected Object getSubjectValue()

Return the value of the subject without any conversion.

Returns:

the value of the subject

getSyncState

public ValueModel<Boolean> getSyncState()

Return a ValueModel containing a Boolean that shows if the last conversion in setValue() or getValue() was sucessfull.

Specified by:

getSyncState in interface TypeConverter<OwnT,SubjectT>

Returns:

a ValueModel holding either Boolean.TRUE or Boolean.FALSE.

getSyncKey

public Object getSyncKey()

Get the sync key for the sync state.

Specified by:

getSyncKey in interface TypeConverter<OwnT,SubjectT>

Returns:

an key, may be null

setSyncKey

public void setSyncKey(Object pKey)

Set the sync key for the sync state.

Specified by:

setSyncKey in interface TypeConverter<OwnT,SubjectT>

Parameters:

pKey - a key, may be null

getSyncMessage

public String getSyncMessage()

Return a sync message, usefull when the conversation fails. If no one was set, a default message is returned.

Specified by:

getSyncMessage in interface TypeConverter<OwnT,SubjectT>

Returns:

a sync message, never null

setSyncMessage

public void setSyncMessage(String pMessage)

Set the sync message.

Specified by:

setSyncMessage in interface TypeConverter<OwnT,SubjectT>

Parameters:

pMessage - the sync message, must not be null

stateChanged

public void stateChanged(ChangeEvent pEvent)

Invoked when our subject changed. We try to convert the subject's value and change ourself

Specified by:

stateChanged in interface ChangeListener

Parameters:

pEvent - a ChangeEvent object