Package org.ametys.plugins.forms.generators

Class FormEntryInformationGenerator

java.lang.Object

org.apache.avalon.framework.logger.AbstractLogEnabled

org.apache.cocoon.xml.AbstractXMLProducer

org.apache.cocoon.generation.AbstractGenerator

org.apache.cocoon.generation.ServiceableGenerator

org.ametys.plugins.forms.generators.FormEntryInformationGenerator

All Implemented Interfaces:

Poolable, Recyclable, Disposable, Component, LogEnabled, Serviceable, Generator, SitemapModelComponent, XMLProducer

Direct Known Subclasses:

FormAdminEntryInformationGenerator, FormMailEntryInformationGenerator

public class FormEntryInformationGenerator
extends ServiceableGenerator

Generate the entry of a form This generator is used for "my submission" service

Field Summary

Fields

Modifier and Type	Field	Description
protected CurrentUserProvider	_currentUserProvider	The current user provider
protected FormEntryDAO	_formEntryDAO	The form entry DAO
protected FormQuestionDAO	_formQuestionDAO	The form question DAO
protected AmetysObjectResolver	_resolver	The Ametys Object resolver
protected UserManager	_userManager	The user manager

Fields inherited from class org.apache.cocoon.generation.ServiceableGenerator

manager

Fields inherited from class org.apache.cocoon.generation.AbstractGenerator

objectModel, parameters, resolver, source

Fields inherited from class org.apache.cocoon.xml.AbstractXMLProducer

contentHandler, EMPTY_CONTENT_HANDLER, lexicalHandler, xmlConsumer

Fields inherited from interface org.apache.cocoon.generation.Generator

ROLE

Constructor Summary

Constructors

Constructor	Description
FormEntryInformationGenerator()

Method Summary

Modifier and Type	Method	Description
protected void	_addAdditionalEntryAttributes(FormEntry entry, AttributesImpl attrs)	Add additional entry attributes
protected void	_checkRights(FormEntry entry)	Check right before saxing entry
protected List<FormQuestion>	_getQuestions(FormEntry entry, Optional<Long> currentStepId)	Get the questions of the given entry
protected void	_saxEntry(FormEntry entry)	Sax the entry
protected void	_saxQuestion(FormQuestion question, FormEntry entry)	Sax the question
void	generate()
void	service(ServiceManager smanager)

Methods inherited from class org.apache.cocoon.generation.ServiceableGenerator

dispose

Methods inherited from class org.apache.cocoon.generation.AbstractGenerator

recycle, setup

Methods inherited from class org.apache.cocoon.xml.AbstractXMLProducer

setConsumer, setContentHandler, setLexicalHandler

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

Methods inherited from interface org.apache.cocoon.xml.XMLProducer

setConsumer

Field Details

_currentUserProvider

protected CurrentUserProvider _currentUserProvider

The current user provider

_resolver

protected AmetysObjectResolver _resolver

The Ametys Object resolver

_userManager

protected UserManager _userManager

The user manager

_formEntryDAO

protected FormEntryDAO _formEntryDAO

The form entry DAO

_formQuestionDAO

protected FormQuestionDAO _formQuestionDAO

The form question DAO

Constructor Details

FormEntryInformationGenerator

public FormEntryInformationGenerator()

Method Details

service

public void service(ServiceManager smanager)
             throws ServiceException

Specified by:

service in interface Serviceable

Overrides:

service in class ServiceableGenerator

Throws:

ServiceException

generate

public void generate()
              throws IOException,
SAXException,
ProcessingException

Throws:

IOException

SAXException

ProcessingException

_checkRights

protected void _checkRights(FormEntry entry)

Check right before saxing entry

Parameters:

entry - the entry

_saxEntry

protected void _saxEntry(FormEntry entry)
                  throws SAXException

Sax the entry

Parameters:

entry - the entry

Throws:

SAXException - if a saxing error occurred

_getQuestions

protected List<FormQuestion> _getQuestions(FormEntry entry,
 Optional<Long> currentStepId)

Get the questions of the given entry

Parameters:

entry - the entry

currentStepId - the current step id. Can be empty

Returns:

the list of question

_saxQuestion

protected void _saxQuestion(FormQuestion question,
 FormEntry entry)
                     throws SAXException

Sax the question

Parameters:

question - the question

entry - the entry

Throws:

SAXException - if a saxing exception occurred

_addAdditionalEntryAttributes

protected void _addAdditionalEntryAttributes(FormEntry entry,
 AttributesImpl attrs)

Add additional entry attributes

Parameters:

entry - the entry

attrs - the attributes