Package org.alfresco.repo.forms.processor

Class AbstractFieldProcessor<Data>

java.lang.Object

org.alfresco.repo.forms.processor.AbstractFieldProcessor<Data>

Type Parameters:

Data -

All Implemented Interfaces:

FieldProcessor

Direct Known Subclasses:

QNameFieldProcessor, TransientFieldProcessor

public abstract class AbstractFieldProcessor<Data>
extends Object
implements FieldProcessor

Abstract base class for all field processors.

Since:

3.4

Author:

Nick Smith

Constructor Summary

Constructors

Constructor	Description
AbstractFieldProcessor()

Method Summary

Modifier and Type	Method	Description
Field	generateField(String fieldName, FormCreationData data)
protected abstract Field	generateTypedField(String fieldName, FormCreationData formData, Data typedData)	The method which actually creates the Field.
protected abstract Class<Data>	getExpectedDataType()
protected abstract org.apache.commons.logging.Log	getLogger()
protected abstract String	getRegistryKey()
void	setFieldProcessorRegistry(FieldProcessorRegistry registry)	Registers this FieldProcessor with the supplied registry.

Methods inherited from class java.lang.Object

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

Constructor Detail

AbstractFieldProcessor

public AbstractFieldProcessor()

Method Detail

generateField

public Field generateField(String fieldName,
                           FormCreationData data)

Specified by:

generateField in interface FieldProcessor

setFieldProcessorRegistry

public void setFieldProcessorRegistry(FieldProcessorRegistry registry)

Registers this FieldProcessor with the supplied registry.

Parameters:

registry - The registry to which this FieldProcessor is added.

getLogger

protected abstract org.apache.commons.logging.Log getLogger()

Returns:

a Log used to log events that occur while processing fields.

getRegistryKey

protected abstract String getRegistryKey()

Returns:

a String key used to identify this FieldProcessor in a FieldProcessorRegistry.

getExpectedDataType

protected abstract Class<Data> getExpectedDataType()

Returns:

the expected Class of the data parameter for the method generateField.

generateTypedField

protected abstract Field generateTypedField(String fieldName,
                                            FormCreationData formData,
                                            Data typedData)

The method which actually creates the Field.

Parameters:

fieldName - the name of the Field to be genereated.

formData - TODO

typedData - the data used to create the field.

Returns:

a Field or null.