org.alfresco.repo.forms.processor
Class AbstractFieldProcessor

java.lang.Object
  extended by org.alfresco.repo.forms.processor.AbstractFieldProcessor
All Implemented Interfaces:
FieldProcessor
Direct Known Subclasses:
QNameFieldProcessor, TransientFieldProcessor

public abstract class AbstractFieldProcessor
extends java.lang.Object
implements FieldProcessor

Abstract base class for all field processors.

Since:
3.4

Constructor Summary
AbstractFieldProcessor()
           
 
Method Summary
 Field generateField(java.lang.String fieldName, FormCreationData data)
           
protected abstract  Field generateTypedField(java.lang.String fieldName, FormCreationData formData, java.lang.Object typedData)
          The method which actually creates the Field.
protected abstract  java.lang.Class getExpectedDataType()
           
protected abstract  org.apache.commons.logging.Log getLogger()
           
protected abstract  java.lang.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(java.lang.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 java.lang.String getRegistryKey()
Returns:
a String key used to identify this FieldProcessor in a FieldProcessorRegistry.

getExpectedDataType

protected abstract java.lang.Class getExpectedDataType()
Returns:
the expected Class of the data parameter for the method generateField.

generateTypedField

protected abstract Field generateTypedField(java.lang.String fieldName,
                                            FormCreationData formData,
                                            java.lang.Object 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.


Copyright © 2005 - 2010 Alfresco Software, Inc. All Rights Reserved.