org.alfresco.repo.forms.processor

Class FilteredFormProcessor<ItemType,PersistType>

java.lang.Object

org.alfresco.repo.forms.processor.AbstractFormProcessor

org.alfresco.repo.forms.processor.FilteredFormProcessor<ItemType,PersistType>

All Implemented Interfaces:

FormProcessor

Direct Known Subclasses:

ActionFormProcessor, ContentModelFormProcessor

public abstract class FilteredFormProcessor<ItemType,PersistType>
extends AbstractFormProcessor

Abstract base class for all FormProcessor implementations that wish to use the filter mechanism.

Author:

Gavin Cornwell, Nick Smith

Field Summary

Fields

Modifier and Type	Field and Description
protected FieldProcessorRegistry	fieldProcessorRegistry
protected FilterRegistry<ItemType,PersistType>	filterRegistry

Fields inherited from class org.alfresco.repo.forms.processor.AbstractFormProcessor

active, DESTINATION, matchPattern, patternMatcher, processorRegistry

Constructor Summary

Constructors

Constructor and Description
FilteredFormProcessor()

Method Summary

Methods

Modifier and Type	Method and Description
Form	generate(Item item, List<String> fields, List<String> forcedFields, Map<String,Object> context) Returns a Form representation for an item
protected List<Field>	generateDefaultFields(FormCreationData data, List<String> fieldsToIgnore) Generates a list of default fields to add if no field names are specified.
protected List<Field>	generateSelectedFields(List<String> fields, FormCreationData data)
protected abstract List<String>	getDefaultIgnoredFields() When a Form is generated with no field names specifically set then a default Form is created.
protected abstract String	getItemType(ItemType item) Returns a String describing the type fo the specified item.
protected abstract String	getItemURI(ItemType item) Returns the URI location of the specified item.
protected abstract org.apache.commons.logging.Log	getLogger() Retrieves a logger instance to log to.
protected abstract ItemType	getTypedItem(Item item) Returns a typed Object representing the given item.
protected void	internalGenerate(ItemType item, List<String> fields, List<String> forcedFields, Form form, Map<String,Object> context) Generates the form.
protected abstract PersistType	internalPersist(ItemType item, FormData data) Persists the form data.
protected abstract Object	makeItemData(ItemType item) Creates a data object used by the FormProcessor and FieldProcessors to create Fields
Object	persist(Item item, FormData data) Persists the given form data for the given item, completed by calling each applicable registered handler
protected void	populateForm(Form form, List<String> fields, FormCreationData data) This method generates all the fields to be added and adds them to the Form, together with the associated field data.
void	setFieldProcessorRegistry(FieldProcessorRegistry fieldProcessorRegistry) Sets the field processor registry.
void	setFilterRegistry(FilterRegistry<ItemType,PersistType> filterRegistry) Sets the filter registry
void	setIgnoredFields(List<String> ignoredFields)

Methods inherited from class org.alfresco.repo.forms.processor.AbstractFormProcessor

isActive, isApplicable, register, setActive, setFormItemType, setFormItemUrl, setMatchPattern, setProcessorRegistry, toString

Methods inherited from class java.lang.Object

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

Field Detail

filterRegistry

protected FilterRegistry<ItemType,PersistType> filterRegistry

fieldProcessorRegistry

protected FieldProcessorRegistry fieldProcessorRegistry

Constructor Detail

FilteredFormProcessor

public FilteredFormProcessor()

Method Detail

setFilterRegistry

public void setFilterRegistry(FilterRegistry<ItemType,PersistType> filterRegistry)

Sets the filter registry

Parameters:

filterRegistry - The FilterRegistry instance

setIgnoredFields

public void setIgnoredFields(List<String> ignoredFields)

Parameters:

ignoredFields - the ignoredFields to set

generate

public Form generate(Item item,
            List<String> fields,
            List<String> forcedFields,
            Map<String,Object> context)

Returns a Form representation for an item

Parameters:

item - The item to generate a Form object for

fields - Restricted list of fields to include, null indicates all possible fields for the item should be included

forcedFields - List of field names from 'fields' list that should be forcibly included, it is up to the form processor implementation to determine how to enforce this

context - Map representing optional context that can be used during retrieval of the form

Returns:

The Form representation

persist

public Object persist(Item item,
             FormData data)

Persists the given form data for the given item, completed by calling each applicable registered handler

Parameters:

item - The item to save the form for

data - The object representing the form data

Returns:

The object persisted

See Also:

FormProcessor.persist(org.alfresco.repo.forms.Item, org.alfresco.repo.forms.FormData)

internalGenerate

protected void internalGenerate(ItemType item,
                    List<String> fields,
                    List<String> forcedFields,
                    Form form,
                    Map<String,Object> context)

Generates the form.

Parameters:

item - The object to generate a form for

fields - Restricted list of fields to include

forcedFields - List of fields to forcibly include

form - The form object being generated

context - Map representing optional context that can be used during retrieval of the form

populateForm

protected void populateForm(Form form,
                List<String> fields,
                FormCreationData data)

This method generates all the fields to be added and adds them to the Form, together with the associated field data.

Parameters:

form - The Form to which the fields are added.

fields - The names of all the fields to be added.

data - FormCreationData used to generate all the fields.

generateDefaultFields

protected List<Field> generateDefaultFields(FormCreationData data,
                                List<String> fieldsToIgnore)

Generates a list of default fields to add if no field names are specified.

Parameters:

data - Used for field creation.

ignoredFields - TODO

Returns:

a List of Fields which may be empty.

generateSelectedFields

protected List<Field> generateSelectedFields(List<String> fields,
                                 FormCreationData data)

setFieldProcessorRegistry

public void setFieldProcessorRegistry(FieldProcessorRegistry fieldProcessorRegistry)

Sets the field processor registry.

Parameters:

fieldProcessorRegistry - The FieldProcessorRegistry to use.

makeItemData

protected abstract Object makeItemData(ItemType item)

Creates a data object used by the FormProcessor and FieldProcessors to create Fields

Returns:

getTypedItem

protected abstract ItemType getTypedItem(Item item)

Returns a typed Object representing the given item.

Subclasses that represent a form type will return a typed object that is then passed to each of it's handlers, the handlers can therefore safely cast the Object to the type they expect.

Parameters:

item - The item to get a typed object for

Returns:

The typed object

getLogger

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

Retrieves a logger instance to log to.

Returns:

Log instance to log to.

getItemType

protected abstract String getItemType(ItemType item)

Returns a String describing the type fo the specified item.

Parameters:

item -

Returns:

getItemURI

protected abstract String getItemURI(ItemType item)

Returns the URI location of the specified item.

Parameters:

item -

Returns:

internalPersist

protected abstract PersistType internalPersist(ItemType item,
                          FormData data)

Persists the form data.

Parameters:

item - The object to persist the form for

data - The data to persist

Returns:

The object that got created or modified

getDefaultIgnoredFields

protected abstract List<String> getDefaultIgnoredFields()

When a Form is generated with no field names specifically set then a default Form is created. The default Form contains all the properties and associations related to the Item, excluding a blacklist of ignored fields which defaults to the return value of this method. The default ignored values can be overridden by setting the property ignoredFields.

Returns:

the names of all the fields to be excluded from the default Form if no defaultFields property is explicitly set.