net.sf.mmm.util.pojo.descriptor.base

Class AbstractPojoDescriptor<POJO>

java.lang.Object

net.sf.mmm.util.pojo.descriptor.base.AbstractPojoDescriptor<POJO>

Type Parameters:

POJO - is the templated type of the POJO.

All Implemented Interfaces:

PojoAttributeType<POJO>, PojoDescriptor<POJO>

Direct Known Subclasses:

AbstractPojoDescriptorImpl

public abstract class AbstractPojoDescriptor<POJO>
extends Object
implements PojoDescriptor<POJO>

This is the abstract base implementation of the PojoDescriptor interface.

Since:

1.1.0

Author:

Joerg Hohwiller (hohwille at users.sourceforge.net)

Field Summary

Fields

Modifier and Type	Field and Description
private PojoDescriptorBuilder	pojoDescriptorBuilder
private GenericType<POJO>	pojoType

Constructor Summary

Constructors

Constructor and Description
AbstractPojoDescriptor(GenericType<POJO> pojoType, PojoDescriptorBuilder pojoDescriptorBuilder) The constructor.

Method Summary

Modifier and Type	Method and Description
Object	addPropertyItem(POJO pojo, String propertyName, Object item) This method adds the given item to the list-like property with the given propertyName from the given pojo using the add accessor.
<ACCESSOR extends PojoPropertyAccessor> ACCESSOR	getAccessor(String property, PojoPropertyAccessorMode<ACCESSOR> mode) This method gets the accessor for the property with the given propertyName and for the given access mode.
abstract PojoPropertyDescriptorImpl	getOrCreatePropertyDescriptor(String propertyName) This method gets the property-descriptor for the given propertyName.
Class<POJO>	getPojoClass() This method gets the type reflecting the Pojo this object is related to.
protected PojoDescriptorBuilder	getPojoDescriptorBuilder()
GenericType<POJO>	getPojoType() This method gets the GenericType reflecting the Pojo this object is related to.
Object	getProperty(POJO pojo, String property) This method gets the property identified by the given property from the given pojo.
private Object	getProperty(POJO pojo, String propertyPath, boolean required)
<V> V	getProperty(POJO pojo, TypedProperty<V> property) This method gets the value of the specified property in a type-safe way.
PojoPropertyDescriptor	getPropertyDescriptor(TypedProperty<?> property) This method gets the descriptor for the given property.
abstract Collection<? extends AbstractPojoPropertyDescriptor>	getPropertyDescriptors() This method gets the descriptors of all properties of the according pojo.
Object	getPropertyItem(POJO pojo, String propertyName, int index) This method gets the item with the given index from the list-like property with the given propertyName of the given pojo using the indexed getter accessor.
int	getPropertySize(POJO pojo, String propertyName) This method gets the size of the property with the given propertyName from the given pojo.
Boolean	removePropertyItem(POJO pojo, String propertyName, Object item) This method removes the given item from an array or Collection using the remove property with the given propertyName from the given pojo accessor.
Object	setProperty(POJO pojo, String propertyName, Object value) This method sets the given value for the property with the given property of the given pojo.
<V> void	setProperty(POJO pojo, TypedProperty<V> property, V value) This method sets the value of the specified property in a type-safe way.
Object	setPropertyItem(POJO pojo, String propertyName, int index, Object item) This method sets the given item at the given index in the list-like property with the given propertyName of the given pojo using the indexed setter accessor.
String	toString()

Methods inherited from class java.lang.Object

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

Methods inherited from interface net.sf.mmm.util.pojo.descriptor.api.PojoDescriptor

getAccessor, getPropertyDescriptor, newInstance

Field Detail

pojoDescriptorBuilder

private final PojoDescriptorBuilder pojoDescriptorBuilder

See Also:

getPojoDescriptorBuilder()

pojoType

private final GenericType<POJO> pojoType

See Also:

getPojoType()

Constructor Detail

AbstractPojoDescriptor

public AbstractPojoDescriptor(GenericType<POJO> pojoType,
                              PojoDescriptorBuilder pojoDescriptorBuilder)

The constructor.

Parameters:

pojoType - is the pojo-type.

pojoDescriptorBuilder - is the PojoDescriptorBuilder.

Method Detail

getPojoClass

public Class<POJO> getPojoClass()

This method gets the type reflecting the Pojo this object is related to.

Specified by:

getPojoClass in interface PojoAttributeType<POJO>

Returns:

the type of the according Pojo.

getPojoType

public GenericType<POJO> getPojoType()

This method gets the GenericType reflecting the Pojo this object is related to.

Specified by:

getPojoType in interface PojoAttributeType<POJO>

Returns:

the type of the according Pojo.

getPojoDescriptorBuilder

protected PojoDescriptorBuilder getPojoDescriptorBuilder()

Returns:

the PojoDescriptorBuilder instance.

getPropertyDescriptors

public abstract Collection<? extends AbstractPojoPropertyDescriptor> getPropertyDescriptors()

This method gets the descriptors of all properties of the according pojo.

Specified by:

getPropertyDescriptors in interface PojoDescriptor<POJO>

Returns:

a collection with all property descriptors

getOrCreatePropertyDescriptor

public abstract PojoPropertyDescriptorImpl getOrCreatePropertyDescriptor(String propertyName)

This method gets the property-descriptor for the given propertyName.

Parameters:

propertyName - is the name of the requested property-descriptor.

Returns:

the requested property-descriptor or null if NO property exists with the given propertyName.

getAccessor

public <ACCESSOR extends PojoPropertyAccessor> ACCESSOR getAccessor(String property,
                                                                    PojoPropertyAccessorMode<ACCESSOR> mode)

This method gets the accessor for the property with the given propertyName and for the given access mode.

Specified by:

getAccessor in interface PojoDescriptor<POJO>

Type Parameters:

ACCESSOR - is the type of the requested accessor.

Parameters:

property - is the name of the property. If the given mode is GET it is treated as for PojoDescriptor.getProperty(Object, String). If the given mode is SET it is treated as for PojoDescriptor.setProperty(Object, String, Object).

mode - is the mode of the requested accessor. Use PojoPropertyAccessorModes for available modes.

Returns:

the requested accessor or null if NOT found (there is no property named propertyName, the property has no accessor for the given mode, etc.).

getProperty

public Object getProperty(POJO pojo,
                          String property)

This method gets the property identified by the given property from the given pojo. The result depends on the form of the given property as shown by the following table:

property	accessor	example	equivalent
[a-zA-Z][a-zA-Z0-9]*	PojoPropertyAccessorNonArgMode.GET	fooBar	getFooBar()
[a-zA-Z][a-zA-Z0-9]* "[" [0-9]+ "]"	PojoPropertyAccessorIndexedNonArgMode.GET_INDEXED	fooBar[42]	getFooBar(42) getFooBar()[42] getFooBar().get(42)
[a-zA-Z][a-zA-Z0-9]* "['" [a-zA-Z0-9]+ "']"	PojoPropertyAccessorOneArgMode.GET_MAPPED	fooBar['key']	getFooBar("key") getFooBar().get("key")

Specified by:

getProperty in interface PojoDescriptor<POJO>

Parameters:

pojo - is the POJO instance where to access the property.

property - identifies the property to get as described above.

Returns:

the value of the requested property. It will be an instance of the type of the according getter. Depending on the POJO, the value may be null.

getProperty

public <V> V getProperty(POJO pojo,
                         TypedProperty<V> property)
                  throws PojoPropertyNotFoundException,
                         ReflectionException

This method gets the value of the specified property in a type-safe way.

Specified by:

getProperty in interface PojoDescriptor<POJO>

Type Parameters:

V - is the generic type of the requested property value.

Parameters:

pojo - is the POJO instance where to access the property.

property - is the TypedProperty identifying the property to get.

Returns:

the value of the specified property.

Throws:

PojoPropertyNotFoundException - if the property with the given propertyName was NOT found or has no such accessor (getter).

ReflectionException - if the underlying accessor caused an error during reflection.

See Also:

PojoDescriptor.getProperty(Object, String)

setProperty

public Object setProperty(POJO pojo,
                          String propertyName,
                          Object value)

This method sets the given value for the property with the given property of the given pojo. The effect depends on the form of the given property as shown by the following table:

property	accessor	example	equivalent
[a-zA-Z][a-zA-Z0-9]*	PojoPropertyAccessorOneArgMode.SET	fooBar	setFooBar(value)
[a-zA-Z][a-zA-Z0-9]* "[" [0-9]+ "]"	PojoPropertyAccessorIndexedOneArgMode.SET_INDEXED	fooBar[42]	setFooBar(42, value) getFooBar()[42]=value getFooBar().set(42, value)
[a-zA-Z][a-zA-Z0-9]* "['" [a-zA-Z0-9]+ "']"	PojoPropertyAccessorTwoArgMode.SET_MAPPED	fooBar['key']	setFooBar("key", value) getFooBar().put("key", value)

Specified by:

setProperty in interface PojoDescriptor<POJO>

Parameters:

pojo - is the POJO instance where to access the property.

propertyName - identifies the property to set as explained above.

value - is the property value to set. Depending on the POJO the value may be null.

Returns:

the result of the setter method. Will be null if the return type is void what should be the regular case.

setProperty

public <V> void setProperty(POJO pojo,
                            TypedProperty<V> property,
                            V value)
                     throws PojoPropertyNotFoundException,
                            ReflectionException

This method sets the value of the specified property in a type-safe way.

Specified by:

setProperty in interface PojoDescriptor<POJO>

Type Parameters:

V - is the generic type of the property value to set.

Parameters:

pojo - is the Pojo owning the property.

property - is the TypedProperty identifying the property to set.

value - is the new property value to set.

Throws:

PojoPropertyNotFoundException - if the property with the given propertyName was NOT found or has no such accessor (setter).

ReflectionException - if the underlying accessor caused an error during reflection.

See Also:

PojoDescriptor.setProperty(Object, String, Object)

getProperty

private Object getProperty(POJO pojo,
                           String propertyPath,
                           boolean required)

Parameters:

pojo - is the POJO instance where to access the property.

propertyPath - is the POJO property path.

required - - true if the result is required, false if any intermediate or the end result may be null resulting in null being returned.

Returns:

the requested property value.

getPropertySize

public int getPropertySize(POJO pojo,
                           String propertyName)

This method gets the size of the property with the given propertyName from the given pojo.

Specified by:

getPropertySize in interface PojoDescriptor<POJO>

Parameters:

pojo - is the POJO instance where to access the property.

propertyName - is the name of the property.

Returns:

the size of the requested property.

addPropertyItem

public Object addPropertyItem(POJO pojo,
                              String propertyName,
                              Object item)

This method adds the given item to the list-like property with the given propertyName from the given pojo using the add accessor.

Specified by:

addPropertyItem in interface PojoDescriptor<POJO>

Parameters:

pojo - is the POJO instance where to access the property.

propertyName - is the name of the property.

item - is the item to add to the property.

Returns:

the result of the add-method. Will be null if the return type is void what should be the regular case.

removePropertyItem

public Boolean removePropertyItem(POJO pojo,
                                  String propertyName,
                                  Object item)

This method removes the given item from an array or Collection using the remove property with the given propertyName from the given pojo accessor.

Specified by:

removePropertyItem in interface PojoDescriptor<POJO>

Parameters:

pojo - is the POJO instance where to access the property.

propertyName - is the name of the property.

item - is the item to remove from the property.

Returns:

Boolean.TRUE if the item has been removed successfully and Boolean.FALSE if the item was NOT present in the array or Collection, or null if the accessor is pointing to a remove method that returns no boolean.

getPropertyItem

public Object getPropertyItem(POJO pojo,
                              String propertyName,
                              int index)

This method gets the item with the given index from the list-like property with the given propertyName of the given pojo using the indexed getter accessor.

Specified by:

getPropertyItem in interface PojoDescriptor<POJO>

Parameters:

pojo - is the POJO instance where to add the given property item.

propertyName - is the name of the property.

index - is the position of the requested item (see List.get(int)).

Returns:

the result of the add-method. Will be null if the return type is void what should be the regular case.

setPropertyItem

public Object setPropertyItem(POJO pojo,
                              String propertyName,
                              int index,
                              Object item)

This method sets the given item at the given index in the list-like property with the given propertyName of the given pojo using the indexed setter accessor.

Specified by:

setPropertyItem in interface PojoDescriptor<POJO>

Parameters:

pojo - is the POJO instance where to access the property.

propertyName - is the name of the property.

index - is the position of the item to set (see List.set(int, Object)).

item - is the item to set at the given index.

Returns:

the result of the add-method. Will be null if the return type is void what should be the regular case.

getPropertyDescriptor

public PojoPropertyDescriptor getPropertyDescriptor(TypedProperty<?> property)

This method gets the descriptor for the given property.

Specified by:

getPropertyDescriptor in interface PojoDescriptor<POJO>

Parameters:

property - is the TypedProperty.

Returns:

the descriptor for the property identified by the given property.

toString

public String toString()

Overrides:

toString in class Object