net.sf.mmm.client.ui.base.binding

Interface UiDataBindingAdapter<VALUE>

Type Parameters:

VALUE - is the generic type of the value to adapt. Typically a TransferObject or a Datatype.

All Known Implementing Classes:

UiDataBindingAdapterImpl

public interface UiDataBindingAdapter<VALUE>

This is the interface for an adapter that keeps reflective operations out of the implementation of UiDataBinding.
ATTENTION:
This is just a simple abstraction of reflective introspection solutions such as PojoPropertyAccessorBuilder. However, we want to be the minimum needed so users can replace reflective approaches with generated code or the like. Please note that there is no reflection available in GWT context and therefore you will have limitations. If your custom needs differ from what is offered out of the box, this is the place where to hook into.

Since:

1.0.0

Author:

Joerg Hohwiller (hohwille at users.sourceforge.net)

Method Summary

Modifier and Type	Method and Description
VALUE	copy(VALUE value) This method creates a copy (e.g.
VALUE	createNewValue()
<T> Class<T>	getPropertyType(TypedProperty<T> property) This method gets the property type of the given TypedProperty.
<T> ValueValidator<T>	getPropertyValidator(TypedProperty<T> property, Class<T> propertyType) This method gets or creates the ValueValidator for the specified property.
Object	getPropertyValue(VALUE pojo, String property) This method gets the value of the specified property.
<T> T	getPropertyValue(VALUE pojo, TypedProperty<T> property) This method gets the value of the specified property.
<T> Range<?>	getRangeConstraints(TypedProperty<T> property, Class<T> propertyType) This method determines the allowed Range of the value for the specified property in the Pojo associated with this adapter.
void	setPropertyValue(VALUE pojo, String property, Object propertyValue) This method sets the value of the specified property.
<T> void	setPropertyValue(VALUE pojo, TypedProperty<T> property, T propertyValue) This method sets the value of the specified property.

Method Detail

createNewValue

VALUE createNewValue()

Returns:

a new instance of <VALUE>.

copy

VALUE copy(VALUE value)

This method creates a copy (e.g. via copy-constructor or clone) of the given value. If the given value is immutable (like String, Long, etc.) it is legal to return the same given instance.

Parameters:

value - is the value to copy.

Returns:

the copy of the value.

getPropertyValidator

<T> ValueValidator<T> getPropertyValidator(TypedProperty<T> property,
                                           Class<T> propertyType)

This method gets or creates the ValueValidator for the specified property.

Type Parameters:

T - is the generic property type.

Parameters:

property - is the TypedProperty.

propertyType - is the Class reflecting the property type.

Returns:

the ValueValidator for the given property.

getRangeConstraints

<T> Range<?> getRangeConstraints(TypedProperty<T> property,
                                 Class<T> propertyType)

This method determines the allowed Range of the value for the specified property in the Pojo associated with this adapter. It will consider JSR 303 annotations such as Min, Max, DecimalMin, and DecimalMax.

Type Parameters:

T - is the generic type of the property.

Parameters:

property - is the TypedProperty.

propertyType - is the Class reflecting the property type.

Returns:

the Range or null if unbound.

getPropertyType

<T> Class<T> getPropertyType(TypedProperty<T> property)

This method gets the property type of the given TypedProperty. This method might work even if TypedProperty.getPropertyType() returns null.

Type Parameters:

T - is the generic property type.

Parameters:

property - is the TypedProperty.

Returns:

the property type of the given property.

getPropertyValue

<T> T getPropertyValue(VALUE pojo,
                       TypedProperty<T> property)

This method gets the value of the specified property.

Type Parameters:

T - is the generic property type.

Parameters:

pojo - is the Pojo owning the property.

property - is the TypedProperty.

Returns:

the value of the specified property.

See Also:

getPropertyValue(Object, String)

getPropertyValue

Object getPropertyValue(VALUE pojo,
                        String property)

This method gets the value of the specified property.
E.g. getPropertyValue(pojo, "foo") is supposed to return pojo.getFoo().

Parameters:

pojo - is the Pojo owning the property.

property - is the name of the requested property.

Returns:

the value of the specified property.

setPropertyValue

<T> void setPropertyValue(VALUE pojo,
                          TypedProperty<T> property,
                          T propertyValue)

This method sets the value of the specified property.

Type Parameters:

T - is the generic property type.

Parameters:

pojo - is the Pojo owning the property.

property - is the TypedProperty.

propertyValue - is the property value to set.

See Also:

setPropertyValue(Object, String, Object)

setPropertyValue

void setPropertyValue(VALUE pojo,
                      String property,
                      Object propertyValue)

This method sets the value of the specified property.
E.g. setPropertyValue(pojo, "foo", value) is supposed to do pojo.setFoo(value).

Parameters:

pojo - is the Pojo owning the property.

property - is the name of the property to set.

propertyValue - is the property value to set.