org.alfresco.repo.forms.processor.node

Class TypeFormProcessor

java.lang.Object

org.alfresco.repo.forms.processor.AbstractFormProcessor

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

org.alfresco.repo.forms.processor.node.ContentModelFormProcessor<org.alfresco.service.cmr.dictionary.TypeDefinition,org.alfresco.service.cmr.repository.NodeRef>

org.alfresco.repo.forms.processor.node.TypeFormProcessor

All Implemented Interfaces:

FormProcessor

public class TypeFormProcessor
extends ContentModelFormProcessor<org.alfresco.service.cmr.dictionary.TypeDefinition,org.alfresco.service.cmr.repository.NodeRef>

FormProcessor implementation that can generate and persist Form objects for types in the Alfresco content model.

Author:

Gavin Cornwell, Nick Smith, 3.4

Field Summary

Fields

Modifier and Type	Field and Description
protected static String	NAME_PROP_DATA

Fields inherited from class org.alfresco.repo.forms.processor.node.ContentModelFormProcessor

associationNamePattern, contentService, dictionaryService, fileFolderService, namespaceService, nodeService, permissionService, propertyNamePattern, transientPropertyPattern

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

fieldProcessorRegistry, filterRegistry

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

active, DESTINATION, matchPattern, patternMatcher, processorRegistry

Constructor Summary

Constructors

Constructor and Description
TypeFormProcessor()

Method Summary

Modifier and Type	Method and Description
protected org.alfresco.service.cmr.repository.NodeRef	createNode(org.alfresco.service.cmr.dictionary.TypeDefinition typeDef, FormData data) Creates a new instance of the given type.
protected Map<org.alfresco.service.namespace.QName,Serializable>	getAssociationValues(org.alfresco.service.cmr.dictionary.TypeDefinition item)
protected org.alfresco.service.cmr.dictionary.TypeDefinition	getBaseType(org.alfresco.service.cmr.dictionary.TypeDefinition type)
protected String	getItemType(org.alfresco.service.cmr.dictionary.TypeDefinition item) Returns a String describing the type fo the specified item.
protected String	getItemURI(org.alfresco.service.cmr.dictionary.TypeDefinition item) Returns the URI location of the specified item.
protected org.apache.commons.logging.Log	getLogger() Retrieves a logger instance to log to.
protected Map<org.alfresco.service.namespace.QName,Serializable>	getPropertyValues(org.alfresco.service.cmr.dictionary.TypeDefinition item)
protected Map<String,Object>	getTransientValues(org.alfresco.service.cmr.dictionary.TypeDefinition item)
protected org.alfresco.service.cmr.dictionary.TypeDefinition	getTypedItem(Item item) Returns a typed Object representing the given item.
protected org.alfresco.service.cmr.repository.NodeRef	internalPersist(org.alfresco.service.cmr.dictionary.TypeDefinition item, FormData data) Persists the form data.

Methods inherited from class org.alfresco.repo.forms.processor.node.ContentModelFormProcessor

addPropertyDataIfRequired, determineDefaultMimetype, generateDefaultFields, getAspectNames, getDefaultIgnoredFields, makeItemData, persistNode, processAssociationPersist, processContentPropertyPersist, processEncodingPropertyPersist, processMimetypePropertyPersist, processNamePropertyPersist, processPropertyPersist, setContentService, setDictionaryService, setFileFolderService, setNamespaceService, setNodeService, setPermissionService

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

generate, generateSelectedFields, internalGenerate, persist, populateForm, setFieldProcessorRegistry, setFilterRegistry, setIgnoredFields

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

NAME_PROP_DATA

protected static final String NAME_PROP_DATA

See Also:

Constant Field Values

Constructor Detail

TypeFormProcessor

public TypeFormProcessor()

Method Detail

getLogger

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

Description copied from class: FilteredFormProcessor

Retrieves a logger instance to log to.

Specified by:

getLogger in class FilteredFormProcessor<org.alfresco.service.cmr.dictionary.TypeDefinition,org.alfresco.service.cmr.repository.NodeRef>

Returns:

Log instance to log to.

getTypedItem

protected org.alfresco.service.cmr.dictionary.TypeDefinition getTypedItem(Item item)

Description copied from class: FilteredFormProcessor

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.

Specified by:

getTypedItem in class FilteredFormProcessor<org.alfresco.service.cmr.dictionary.TypeDefinition,org.alfresco.service.cmr.repository.NodeRef>

Parameters:

item - The item to get a typed object for

Returns:

The typed object

internalPersist

protected org.alfresco.service.cmr.repository.NodeRef internalPersist(org.alfresco.service.cmr.dictionary.TypeDefinition item,
                                                                      FormData data)

Description copied from class: FilteredFormProcessor

Persists the form data.

Specified by:

internalPersist in class FilteredFormProcessor<org.alfresco.service.cmr.dictionary.TypeDefinition,org.alfresco.service.cmr.repository.NodeRef>

Parameters:

item - The object to persist the form for

data - The data to persist

Returns:

The object that got created or modified

createNode

protected org.alfresco.service.cmr.repository.NodeRef createNode(org.alfresco.service.cmr.dictionary.TypeDefinition typeDef,
                                                                 FormData data)

Creates a new instance of the given type.

If the form data has the name property present it is used as the name of the node.

The new node is placed in the location defined by the "destination" data item in the form data (this will usually be a hidden field), this will also be the NodeRef representation of the parent for the new node.

Parameters:

typeDef - The type defintion of the type to create

data - The form data

Returns:

NodeRef representing the newly created node

getItemType

protected String getItemType(org.alfresco.service.cmr.dictionary.TypeDefinition item)

Description copied from class: FilteredFormProcessor

Returns a String describing the type fo the specified item.

Specified by:

getItemType in class FilteredFormProcessor<org.alfresco.service.cmr.dictionary.TypeDefinition,org.alfresco.service.cmr.repository.NodeRef>

Parameters:

item - ItemType

Returns:

String

getItemURI

protected String getItemURI(org.alfresco.service.cmr.dictionary.TypeDefinition item)

Description copied from class: FilteredFormProcessor

Returns the URI location of the specified item.

Specified by:

getItemURI in class FilteredFormProcessor<org.alfresco.service.cmr.dictionary.TypeDefinition,org.alfresco.service.cmr.repository.NodeRef>

Parameters:

item - ItemType

Returns:

String

getBaseType

protected org.alfresco.service.cmr.dictionary.TypeDefinition getBaseType(org.alfresco.service.cmr.dictionary.TypeDefinition type)

Specified by:

getBaseType in class ContentModelFormProcessor<org.alfresco.service.cmr.dictionary.TypeDefinition,org.alfresco.service.cmr.repository.NodeRef>

getAssociationValues

protected Map<org.alfresco.service.namespace.QName,Serializable> getAssociationValues(org.alfresco.service.cmr.dictionary.TypeDefinition item)

Specified by:

getAssociationValues in class ContentModelFormProcessor<org.alfresco.service.cmr.dictionary.TypeDefinition,org.alfresco.service.cmr.repository.NodeRef>

getPropertyValues

protected Map<org.alfresco.service.namespace.QName,Serializable> getPropertyValues(org.alfresco.service.cmr.dictionary.TypeDefinition item)

Specified by:

getPropertyValues in class ContentModelFormProcessor<org.alfresco.service.cmr.dictionary.TypeDefinition,org.alfresco.service.cmr.repository.NodeRef>

getTransientValues

protected Map<String,Object> getTransientValues(org.alfresco.service.cmr.dictionary.TypeDefinition item)

Specified by:

getTransientValues in class ContentModelFormProcessor<org.alfresco.service.cmr.dictionary.TypeDefinition,org.alfresco.service.cmr.repository.NodeRef>