org.ametys.plugins.forms

Class FormManager

java.lang.Object

org.apache.avalon.framework.logger.AbstractLogEnabled

org.ametys.plugins.forms.FormManager

All Implemented Interfaces:

Component, Contextualizable, LogEnabled, Serviceable

public class FormManager
extends AbstractLogEnabled
implements Component, Serviceable, Contextualizable

Class to handle forms in contents

Field Summary

Fields

Modifier and Type	Field and Description
private static String	__FORM_TYPE_CMS
private Context	_context
private FormParser	_formParser
private FormPropertiesManager	_formPropertiesManager
private FormTableManager	_formTableManager
private JdbcWorkflowStore	_jdbcWorkflowStore
private ServiceManager	_manager
private DOMParser	_parser
private WorkflowHelper	_workflowHelper
private WorkflowProvider	_workflowProvider
static String	ENTRY_WORKFLOW_REINITIALIZATION Constant for entry workflow reinitialization
static String	ROLE Avalon Role

Constructor Summary

Constructors

Constructor and Description
FormManager()

Method Summary

Modifier and Type	Method and Description
protected Set<RichText>	_getRichTexts(CompositeMetadata metadataHolder) Get the rich texts
private void	_processForm(Content content, String contentName, String siteName, List<Form> forms, Node formNode)
private void	_removeUnusedForms(Content content, String contentName, List<Form> forms) Remove the unused forms
private void	_resetWorkflowTables(Content content, Form form, boolean dropColumn, boolean addColumn) Remove the workflow tables and the workflow id column if needed
void	contextualize(Context context)
private FormPropertiesManager	getFormPropertiesManager()
private FormTableManager	getFormTableManager()
private JdbcWorkflowStore	getJdbcWorkflowStore()
private WorkflowHelper	getWorkflowHelper()
private WorkflowProvider	getWorkflowProvider()
void	processContentForms(Content content) Find all the forms the content contains and process them.
void	service(ServiceManager smanager)

Methods inherited from class org.apache.avalon.framework.logger.AbstractLogEnabled

enableLogging, getLogger, setupLogger, setupLogger, setupLogger

Methods inherited from class java.lang.Object

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

Field Detail

ROLE

public static final String ROLE

Avalon Role

ENTRY_WORKFLOW_REINITIALIZATION

public static final String ENTRY_WORKFLOW_REINITIALIZATION

Constant for entry workflow reinitialization

See Also:

Constant Field Values

__FORM_TYPE_CMS

private static final String __FORM_TYPE_CMS

See Also:

Constant Field Values

_manager

private ServiceManager _manager

_formPropertiesManager

private FormPropertiesManager _formPropertiesManager

_parser

private DOMParser _parser

_formParser

private FormParser _formParser

_formTableManager

private FormTableManager _formTableManager

_workflowProvider

private WorkflowProvider _workflowProvider

_jdbcWorkflowStore

private JdbcWorkflowStore _jdbcWorkflowStore

_workflowHelper

private WorkflowHelper _workflowHelper

_context

private Context _context

Constructor Detail

FormManager

public FormManager()

Method Detail

service

public void service(ServiceManager smanager)
             throws ServiceException

Specified by:

service in interface Serviceable

Throws:

ServiceException

contextualize

public void contextualize(Context context)
                   throws ContextException

Specified by:

contextualize in interface Contextualizable

Throws:

ContextException

getFormPropertiesManager

private FormPropertiesManager getFormPropertiesManager()

getFormTableManager

private FormTableManager getFormTableManager()

getWorkflowProvider

private WorkflowProvider getWorkflowProvider()

getWorkflowHelper

private WorkflowHelper getWorkflowHelper()

getJdbcWorkflowStore

private JdbcWorkflowStore getJdbcWorkflowStore()

processContentForms

public void processContentForms(Content content)
                         throws SAXException,
                                IOException,
                                com.opensymphony.workflow.WorkflowException

Find all the forms the content contains and process them.

Parameters:

content - the content.

Throws:

SAXException - if a SAX exception occurs during content parsing.

IOException - if an I/O exception occurs during content parsing.

com.opensymphony.workflow.WorkflowException - if an exception occurs while handling the form's workflow

_processForm

private void _processForm(Content content,
                          String contentName,
                          String siteName,
                          List<Form> forms,
                          Node formNode)
                   throws com.opensymphony.workflow.WorkflowException

Throws:

com.opensymphony.workflow.WorkflowException

_resetWorkflowTables

private void _resetWorkflowTables(Content content,
                                  Form form,
                                  boolean dropColumn,
                                  boolean addColumn)
                           throws FormsException,
                                  com.opensymphony.workflow.WorkflowException,
                                  SQLException

Remove the workflow tables and the workflow id column if needed

Parameters:

content - The content holding the form

form - the form

dropColumn - true to drop the workflow id column

addColumn - true to add the workflow id column

Throws:

FormsException - if an error occurs while retrieving the workflow instances ids

com.opensymphony.workflow.WorkflowException - if an error occurs during the reset of the workflow of the form entries

SQLException - if an error occurs during the SQL queries

_removeUnusedForms

private void _removeUnusedForms(Content content,
                                String contentName,
                                List<Form> forms)

Remove the unused forms

Parameters:

content - The content

contentName - The name of the content

forms - The forms submitted

_getRichTexts

protected Set<RichText> _getRichTexts(CompositeMetadata metadataHolder)

Get the rich texts

Parameters:

metadataHolder - the metadata holder

Returns:

the rich texts in a Set