org.ametys.plugins.survey.generators

Class SurveyStatisticsGenerator

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.survey.generators.SurveyStatisticsGenerator

All Implemented Interfaces:

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

public class SurveyStatisticsGenerator
extends ServiceableGenerator

Generate statistics on each question of a survey.

Field Summary

Fields

Modifier and Type	Field and Description
protected org.ametys.plugins.repository.AmetysObjectResolver	_resolver The ametys object resolver.
protected SurveyAnswerDao	_surveyDao The survey data DAO.

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 and Description
SurveyStatisticsGenerator()

Method Summary

Modifier and Type	Method and Description
protected java.util.Map<java.lang.String,java.util.Map<java.lang.String,java.util.Map<java.lang.String,java.lang.Object>>>	createStatsMap(Survey survey) Create the statistics Map for a survey.
protected void	dispatchChoiceStats(SurveySession session, java.util.Map<java.lang.String,java.util.Map<java.lang.String,java.lang.Object>> questionStats, java.util.Map<java.lang.String,java.util.Set<java.lang.String>> valueMap) Dispatch stats on a choice question.
protected void	dispatchMatrixStats(SurveySession session, java.util.Map<java.lang.String,java.util.Map<java.lang.String,java.lang.Object>> questionStats, java.util.Map<java.lang.String,java.util.Set<java.lang.String>> valueMap) Dispatch stats on a matrix question.
protected void	dispatchStats(Survey survey, java.util.Collection<SurveySession> sessions, java.util.Map<java.lang.String,java.util.Map<java.lang.String,java.util.Map<java.lang.String,java.lang.Object>>> stats) Dispatch the survey user sessions (input) in the statistics map.
protected void	dispatchTextStats(SurveySession session, java.util.Map<java.lang.String,java.util.Map<java.lang.String,java.lang.Object>> questionStats, java.util.Map<java.lang.String,java.util.Set<java.lang.String>> valueMap) Dispatch stats on a text question.
void	generate()
protected java.lang.String	getChoiceLabel(SurveyQuestion question, java.lang.String choiceId) Get an option label, depending on the question type.
protected java.lang.String	getOptionLabel(SurveyQuestion question, java.lang.String optionId) Get an option label, depending on the question type.
protected java.util.Map<java.lang.String,java.util.Set<java.lang.String>>	getValueMap(SurveyQuestion question, java.lang.String value) Get the user-input value as a Map from the database value, which is a single serialized string.
protected void	saxStats(Survey survey, java.util.Map<java.lang.String,java.util.Map<java.lang.String,java.util.Map<java.lang.String,java.lang.Object>>> stats) Generate the statistics as XML.
void	service(ServiceManager serviceManager)

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 Detail

_resolver

protected org.ametys.plugins.repository.AmetysObjectResolver _resolver

The ametys object resolver.

_surveyDao

protected SurveyAnswerDao _surveyDao

The survey data DAO.

Constructor Detail

SurveyStatisticsGenerator

public SurveyStatisticsGenerator()

Method Detail

service

public void service(ServiceManager serviceManager)
             throws ServiceException

Specified by:

service in interface Serviceable

Overrides:

service in class ServiceableGenerator

Throws:

ServiceException

generate

public void generate()
              throws java.io.IOException,
                     org.xml.sax.SAXException,
                     ProcessingException

Throws:

java.io.IOException

org.xml.sax.SAXException

ProcessingException

createStatsMap

protected java.util.Map<java.lang.String,java.util.Map<java.lang.String,java.util.Map<java.lang.String,java.lang.Object>>> createStatsMap(Survey survey)

Create the statistics Map for a survey.

Parameters:

survey - the survey.

Returns:

the statistics Map. It is of the following form: questionId -> optionId -> choiceId -> count.

dispatchStats

protected void dispatchStats(Survey survey,
                             java.util.Collection<SurveySession> sessions,
                             java.util.Map<java.lang.String,java.util.Map<java.lang.String,java.util.Map<java.lang.String,java.lang.Object>>> stats)

Dispatch the survey user sessions (input) in the statistics map.

Parameters:

survey - the survey.

sessions - the user sessions.

stats - the statistics Map to fill.

dispatchTextStats

protected void dispatchTextStats(SurveySession session,
                                 java.util.Map<java.lang.String,java.util.Map<java.lang.String,java.lang.Object>> questionStats,
                                 java.util.Map<java.lang.String,java.util.Set<java.lang.String>> valueMap)

Dispatch stats on a text question.

Parameters:

session - the survey session.

questionStats - the Map to fill with the stats.

valueMap - the value map.

dispatchChoiceStats

protected void dispatchChoiceStats(SurveySession session,
                                   java.util.Map<java.lang.String,java.util.Map<java.lang.String,java.lang.Object>> questionStats,
                                   java.util.Map<java.lang.String,java.util.Set<java.lang.String>> valueMap)

Dispatch stats on a choice question.

Parameters:

session - the survey session.

questionStats - the Map to fill with the stats.

valueMap - the value map.

dispatchMatrixStats

protected void dispatchMatrixStats(SurveySession session,
                                   java.util.Map<java.lang.String,java.util.Map<java.lang.String,java.lang.Object>> questionStats,
                                   java.util.Map<java.lang.String,java.util.Set<java.lang.String>> valueMap)

Dispatch stats on a matrix question.

Parameters:

session - the survey session.

questionStats - the Map to fill with the stats.

valueMap - the value map.

saxStats

protected void saxStats(Survey survey,
                        java.util.Map<java.lang.String,java.util.Map<java.lang.String,java.util.Map<java.lang.String,java.lang.Object>>> stats)
                 throws org.xml.sax.SAXException

Generate the statistics as XML.

Parameters:

survey - the survey.

stats - the filled statistics Map.

Throws:

org.xml.sax.SAXException - if an error occurs generating the stats as XML.

getOptionLabel

protected java.lang.String getOptionLabel(SurveyQuestion question,
                                          java.lang.String optionId)

Get an option label, depending on the question type.

Parameters:

question - the question.

optionId - the option ID.

Returns:

the question label, can be the empty string.

getChoiceLabel

protected java.lang.String getChoiceLabel(SurveyQuestion question,
                                          java.lang.String choiceId)

Get an option label, depending on the question type.

Parameters:

question - the question.

choiceId - the choice id.

Returns:

the option label, can be the empty string.

getValueMap

protected java.util.Map<java.lang.String,java.util.Set<java.lang.String>> getValueMap(SurveyQuestion question,
                                                                                      java.lang.String value)

Get the user-input value as a Map from the database value, which is a single serialized string.

Parameters:

question - the question.

value - the value from the database.

Returns:

the value as a Map.