de.richtercloud.reflection.form.builder

Class ReflectionFormBuilder<F extends de.richtercloud.validation.tools.FieldRetriever>

java.lang.Object

de.richtercloud.reflection.form.builder.ReflectionFormBuilder<F>

Type Parameters:

F - allows enforcing a type of FieldRetriever

public class ReflectionFormBuilder<F extends de.richtercloud.validation.tools.FieldRetriever>
extends Object

Builds a ReflectionFormPanel by recursing over all fields of all subclasses of an class and arranging form components for each item. The components to choose are configurable. The handling of fields is conrolled with different mappings which are fieldAnnotationMapping, classAnnotationMapping, classMapping and primitiveMapping which all associate a characteristic of a class field to an instance of JComponent which is put into the panel (some components are generated using the Reflection API, others use more complex factories, like FieldAnnotationHandler and ClassAnnotationHandler. The precedence of the mappings is static and reads as listed above. It can be overwritten by subclassing field and class annotation handlers to ignore certain type or fields (or what ever criteria you can imagine) and omitting entires in class mapping.

Author:

richter

Constructor Summary

Constructors

Constructor and Description
ReflectionFormBuilder(String fieldDescriptionDialogTitle, de.richtercloud.message.handler.IssueHandler issueHandler, F fieldRetriever) Creates a new reflection form builder.

Method Summary

Modifier and Type	Method and Description
protected JComponent	getClassComponent(Field field, Class<?> entityClass, Object instance, FieldHandler fieldHandler) Retrieves the associated JComponent to be displayed in the form.
protected F	getFieldRetriever()
de.richtercloud.message.handler.IssueHandler	getIssueHandler()
protected void	onFieldUpdate(FieldUpdateEvent event, Field field, Object instance)
protected Object	prepareInstance(Class<?> entityClass, Object entityToUpdate)
protected void	transformClass(Class<?> clazz, Object instance, Map<Field,JComponent> fieldMapping, ReflectionFormPanel reflectionFormPanel, FieldHandler fieldHandler) Code used by entity and embeddable transformation.
ReflectionFormPanel	transformEntityClass(Class<?> entityClass, Object entityToUpdate, FieldHandler fieldHandler)
static void	validateMapping(Map<?,?> mapping, String argumentName)

Methods inherited from class java.lang.Object

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

Constructor Detail

ReflectionFormBuilder

public ReflectionFormBuilder(String fieldDescriptionDialogTitle,
                             de.richtercloud.message.handler.IssueHandler issueHandler,
                             F fieldRetriever)

Creates a new reflection form builder.

Parameters:

fieldRetriever - the field retriever to use

fieldDescriptionDialogTitle - the field description dialog title

issueHandler - the issue handler to use

Method Detail

validateMapping

public static void validateMapping(Map<?,?> mapping,
                                   String argumentName)

getIssueHandler

public de.richtercloud.message.handler.IssueHandler getIssueHandler()

getFieldRetriever

protected F getFieldRetriever()

getClassComponent

protected JComponent getClassComponent(Field field,
                                       Class<?> entityClass,
                                       Object instance,
                                       FieldHandler fieldHandler)
                                throws FieldHandlingException,
                                       ResetException

Retrieves the associated JComponent to be displayed in the form.

Parameters:

field - the field to get the class component for

entityClass - the entity class declaring the field

instance - the instance to create for

fieldHandler - the field handler to use

Returns:

the created component, never null

Throws:

FieldHandlingException - wraps all exceptions occuring during read or write access to fields

ResetException - if an exception during resetting the field occurs

onFieldUpdate

protected void onFieldUpdate(FieldUpdateEvent event,
                             Field field,
                             Object instance)
                      throws FieldUpdateException

Throws:

FieldUpdateException

transformClass

protected void transformClass(Class<?> clazz,
                              Object instance,
                              Map<Field,JComponent> fieldMapping,
                              ReflectionFormPanel reflectionFormPanel,
                              FieldHandler fieldHandler)
                       throws TransformationException,
                              ResetException

Code used by entity and embeddable transformation.

Parameters:

clazz - the class to transform

instance - the instance to transform

fieldMapping - the field mapping to use

reflectionFormPanel - the resulting reflection form panel to add to

fieldHandler - the field handler to use

Throws:

TransformationException - wraps any exception which occurs during field access

ResetException - if an exception during resetting the field occurs

transformEntityClass

public ReflectionFormPanel transformEntityClass(Class<?> entityClass,
                                                Object entityToUpdate,
                                                FieldHandler fieldHandler)
                                         throws TransformationException,
                                                ResetException

Parameters:

entityClass - the entity class

entityToUpdate - an entity to update (instead of creating a new instance of entityClass). null indicates to create a new instance and write changes of the ReflectionFormPanel into it.

fieldHandler - the field handler to sue

Returns:

the created component

Throws:

TransformationException - wraps all exception occuring during field access

ResetException - if an exception during resetting the field occurs

prepareInstance

protected Object prepareInstance(Class<?> entityClass,
                                 Object entityToUpdate)
                          throws TransformationException

Throws:

TransformationException