net.sf.mmm.client.ui.base.feature

Class AbstractUiFeatureValueAndValidation<VALUE>

java.lang.Object

net.sf.mmm.client.ui.base.feature.AbstractUiFeatureValueAndValidation<VALUE>

Type Parameters:

VALUE - is the generic type of the value.

All Implemented Interfaces:

AttributeReadValueAdvanced<VALUE>, AttributeWriteValueAdvanced<VALUE>, UiFeature, UiFeatureValidation<VALUE>, UiFeatureValue<VALUE>, UiFeatureValueAndValidation<VALUE>, AttributeReadValue<VALUE>, AttributeWriteValue<VALUE>, AbstractValidatableObject, HasValueValidators<VALUE>, ValidatableObject<VALUE>

Direct Known Subclasses:

AbstractUiFeatureValueAndValidationWithValidators, AbstractUiWidget

public abstract class AbstractUiFeatureValueAndValidation<VALUE>
extends Object
implements UiFeatureValueAndValidation<VALUE>

This is the abstract base implementation of UiFeatureValueAndValidation.

Since:

1.0.0

Author:

Joerg Hohwiller (hohwille at users.sourceforge.net)

Constructor Summary

Constructors

Constructor and Description
AbstractUiFeatureValueAndValidation() The constructor.

Method Summary

Modifier and Type	Method and Description
void	addValidatorMandatory() This is a convenience method for adding the most common validator ValidatorMandatory.
protected void	clearValidity() This method may clear potential state information from previous validations.
protected ValidationFailure	createValidationFailure(Throwable error) This method converts an exception from getValueOrException(Object) to a ValidationFailure.
protected abstract org.slf4j.Logger	getLogger()
protected abstract String	getSource()
VALUE	getValue() This method gets the value of this object.
VALUE	getValueAndValidate(ValidationState state) This method is a combination of AttributeReadValueAdvanced.getValue() and AbstractValidatableObject.validate(ValidationState).
VALUE	getValueOrException(VALUE template) This method is like AttributeReadValueAdvanced.getValue() but does NOT catch exceptions while parsing the value from the user input.
protected void	handleGetValueError(RuntimeException e, ValidationState state) This method handles a RuntimeException that occurred in UiFeatureValueAndValidation.getValueDirect(Object, ValidationState).
void	resetValue() This method resets this widget.
void	setValue(VALUE value) This method sets the value.
void	setValueForUser(VALUE value) This method is like AttributeWriteValueAdvanced.setValue(Object) but will NOT set the original value and will set the modified to true (instead of false).
String	toString()
boolean	validate(ValidationState state) This method performs the actual validation.

Methods inherited from class java.lang.Object

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

Methods inherited from interface net.sf.mmm.client.ui.api.feature.UiFeatureValueAndValidation

getValueDirect

Methods inherited from interface net.sf.mmm.client.ui.api.feature.UiFeatureValue

addChangeHandler, removeChangeHandler

Methods inherited from interface net.sf.mmm.client.ui.api.attribute.AttributeWriteValueAdvanced

setValue

Methods inherited from interface net.sf.mmm.client.ui.api.attribute.AttributeReadValueAdvanced

getOriginalValue

Methods inherited from interface net.sf.mmm.client.ui.api.feature.UiFeatureValidation

isMandatory

Methods inherited from interface net.sf.mmm.util.validation.api.HasValueValidators

addValidator, removeValidator

Constructor Detail

AbstractUiFeatureValueAndValidation

public AbstractUiFeatureValueAndValidation()

The constructor.

Method Detail

getLogger

protected abstract org.slf4j.Logger getLogger()

Returns:

a Logger instance.

setValue

public final void setValue(VALUE value)

This method sets the value. It will also set the modified flag to false.

Specified by:

setValue in interface AttributeWriteValueAdvanced<VALUE>

Specified by:

setValue in interface AttributeWriteValue<VALUE>

Parameters:

value - is the new value. May be null unless otherwise stated.

setValueForUser

public final void setValueForUser(VALUE value)

This method is like AttributeWriteValueAdvanced.setValue(Object) but will NOT set the original value and will set the modified to true (instead of false).

Specified by:

setValueForUser in interface AttributeWriteValueAdvanced<VALUE>

Parameters:

value - is the value to set.

getValue

public final VALUE getValue()

This method gets the value of this object. This will typically be a newly created object.
ATTENTION:
If the current value entered by the user can NOT be parsed, this method will catch and ignore the exception and return null instead. If you want to do validation and give feedback to the user please use AttributeReadValueAdvanced.getValueOrException(Object) instead. However, there are higher-level ways to do this such as getValueAndValidate.

Specified by:

getValue in interface AttributeReadValueAdvanced<VALUE>

Specified by:

getValue in interface AttributeReadValue<VALUE>

Returns:

the value of this object. May be null unless otherwise stated.

handleGetValueError

protected void handleGetValueError(RuntimeException e,
                                   ValidationState state)

This method handles a RuntimeException that occurred in UiFeatureValueAndValidation.getValueDirect(Object, ValidationState).

Parameters:

e - is the RuntimeException to handle.

state - is the ValidationState or null if no validation is performed.

getValueOrException

public VALUE getValueOrException(VALUE template)
                          throws RuntimeException

This method is like AttributeReadValueAdvanced.getValue() but does NOT catch exceptions while parsing the value from the user input. Additionally it allows to provide a template object that gets populated. This allows advanced features with polymorphism as you can also provide a sub-class of <VALUE>.

Specified by:

getValueOrException in interface AttributeReadValueAdvanced<VALUE>

Parameters:

template - is the object where the data is filled in. May also be null - then this method will create a new instance.

Returns:

the current value of this widget. May be null if empty. If the value type is String the empty String has to be returned if no value has been entered. In case <VALUE> is a mutable object (java bean) and template is NOT null, this method is supposed to return template.

Throws:

RuntimeException - if the entered value is invalid (e.g. paring caused a NumberFormatException).

getValueAndValidate

public final VALUE getValueAndValidate(ValidationState state)

This method is a combination of AttributeReadValueAdvanced.getValue() and AbstractValidatableObject.validate(ValidationState). It is designed for API users implementing higher level dialog logic and is therefore easy to use. It performs a validation and only on success it returns the value.
ATTENTION:
The method design assumes that null is not a valid value. Never call this method with null as argument if <VALUE> is Void or anything else that considers null as a valid value. It should be used for high-level UI nodes such as entire input forms or (sub-)dialogs.

Specified by:

getValueAndValidate in interface UiFeatureValueAndValidation<VALUE>

Parameters:

state - is the ValidationState. Shall initially be created as new instance and passed on in case of recursive validations. May also be null and will then be created internally (in case you do not need the validation result).

Returns:

the actual value or null if the validation failed or null is the actual (valid) value.

resetValue

public final void resetValue()

This method resets this widget. It is a convenience method for the following code.

setValue(AttributeReadValueAdvanced.getOriginalValue())

Specified by:

resetValue in interface AttributeWriteValueAdvanced<VALUE>

addValidatorMandatory

public void addValidatorMandatory()

This is a convenience method for adding the most common validator ValidatorMandatory.

Specified by:

addValidatorMandatory in interface UiFeatureValidation<VALUE>

validate

public final boolean validate(ValidationState state)

This method performs the actual validation.

Specified by:

validate in interface AbstractValidatableObject

Parameters:

state - is the ValidationState. Shall initially be created as new instance and passed on in case of recursive validations. May also be null and will then be created internally (in case you do not need more feedback than a boolean result).

Returns:

true if the validation of this object has been successful, false otherwise (if there are validation failures).

clearValidity

protected void clearValidity()

This method may clear potential state information from previous validations.

createValidationFailure

protected ValidationFailure createValidationFailure(Throwable error)

This method converts an exception from getValueOrException(Object) to a ValidationFailure.

Parameters:

error - is the exception.

Returns:

the ValidationFailure.

getSource

protected abstract String getSource()

Returns:

the source for validation failures.

toString

public String toString()

Overrides:

toString in class Object