org.ametys.cms.workflow

Class HistoryGenerator

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.cms.workflow.HistoryGenerator

All Implemented Interfaces:

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

public class HistoryGenerator
extends ServiceableGenerator

Generator for exposing content history and content versions.

Nested Class Summary

Nested Classes

Modifier and Type	Class and Description
private static class	HistoryGenerator.VersionInformation

Field Summary

Fields

Modifier and Type	Field and Description
private static I18nizableText	__MESSAGE_NO_ACTION
private static I18nizableText	__MESSAGE_NO_STEP
private Map<UserIdentity,String>	_identityToFullNameCache
private AmetysObjectResolver	_resolver
private UserManager	_userManager
private WorkflowProvider	_workflowProvider

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
HistoryGenerator()

Method Summary

Modifier and Type	Method and Description
private List<HistoryGenerator.VersionInformation>	_computeVersionsBetween(List<HistoryGenerator.VersionInformation> versionsInformation, Date startDate, Date finishDate)
private long	_getInitialActionId(WorkflowProvider.AmetysObjectWorkflow workflow, WorkflowAwareContent waContent)
private String	_resolveFullName(UserIdentity userIdentity)
private List<HistoryGenerator.VersionInformation>	_resolveVersionInformations(VersionAwareAmetysObject content)
private void	_saxAction(int actionId, com.opensymphony.workflow.loader.WorkflowDescriptor workflowDescriptor)
private void	_saxCaller(UserIdentity caller)
private void	_saxComments(com.opensymphony.workflow.spi.Step previousStep)
private void	_saxContentWorkflowHistory(Content content, List<HistoryGenerator.VersionInformation> versionsInformation)
private void	_saxStep(com.opensymphony.workflow.loader.WorkflowDescriptor workflowDescriptor, List<HistoryGenerator.VersionInformation> versionsInformation, com.opensymphony.workflow.spi.Step step, com.opensymphony.workflow.spi.Step previousStep)
private void	_saxStepDescription(com.opensymphony.workflow.loader.WorkflowDescriptor workflowDescriptor, int stepId)
private void	_saxValidation(com.opensymphony.workflow.spi.Step step, Date startDate, Date finishDate, Date actionStartDate, Date actionFinishDate)
private void	_saxVersionInformation(List<HistoryGenerator.VersionInformation> versionsInformation)
void	generate()
void	recycle()
void	service(ServiceManager serviceManager)

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

dispose

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

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

__MESSAGE_NO_STEP

private static final I18nizableText __MESSAGE_NO_STEP

__MESSAGE_NO_ACTION

private static final I18nizableText __MESSAGE_NO_ACTION

_identityToFullNameCache

private Map<UserIdentity,String> _identityToFullNameCache

_workflowProvider

private WorkflowProvider _workflowProvider

_userManager

private UserManager _userManager

_resolver

private AmetysObjectResolver _resolver

Constructor Detail

HistoryGenerator

public HistoryGenerator()

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 IOException,
                     SAXException,
                     ProcessingException

Throws:

IOException

SAXException

ProcessingException

_resolveVersionInformations

private List<HistoryGenerator.VersionInformation> _resolveVersionInformations(VersionAwareAmetysObject content)
                                                                       throws RepositoryException

Throws:

RepositoryException

_saxVersionInformation

private void _saxVersionInformation(List<HistoryGenerator.VersionInformation> versionsInformation)
                             throws SAXException,
                                    RepositoryException

Throws:

SAXException

RepositoryException

_saxContentWorkflowHistory

private void _saxContentWorkflowHistory(Content content,
                                        List<HistoryGenerator.VersionInformation> versionsInformation)
                                 throws SAXException,
                                        ProcessingException,
                                        RepositoryException

Throws:

SAXException

ProcessingException

RepositoryException

_getInitialActionId

private long _getInitialActionId(WorkflowProvider.AmetysObjectWorkflow workflow,
                                 WorkflowAwareContent waContent)

_saxStep

private void _saxStep(com.opensymphony.workflow.loader.WorkflowDescriptor workflowDescriptor,
                      List<HistoryGenerator.VersionInformation> versionsInformation,
                      com.opensymphony.workflow.spi.Step step,
                      com.opensymphony.workflow.spi.Step previousStep)
               throws SAXException,
                      RepositoryException

Throws:

SAXException

RepositoryException

_saxStepDescription

private void _saxStepDescription(com.opensymphony.workflow.loader.WorkflowDescriptor workflowDescriptor,
                                 int stepId)
                          throws SAXException

Throws:

SAXException

_saxCaller

private void _saxCaller(UserIdentity caller)
                 throws SAXException

Throws:

SAXException

_saxAction

private void _saxAction(int actionId,
                        com.opensymphony.workflow.loader.WorkflowDescriptor workflowDescriptor)
                 throws SAXException

Throws:

SAXException

_saxComments

private void _saxComments(com.opensymphony.workflow.spi.Step previousStep)
                   throws SAXException

Throws:

SAXException

_saxValidation

private void _saxValidation(com.opensymphony.workflow.spi.Step step,
                            Date startDate,
                            Date finishDate,
                            Date actionStartDate,
                            Date actionFinishDate)
                     throws SAXException

Throws:

SAXException

_computeVersionsBetween

private List<HistoryGenerator.VersionInformation> _computeVersionsBetween(List<HistoryGenerator.VersionInformation> versionsInformation,
                                                                          Date startDate,
                                                                          Date finishDate)
                                                                   throws RepositoryException

Throws:

RepositoryException

_resolveFullName

private String _resolveFullName(UserIdentity userIdentity)

recycle

public void recycle()

Specified by:

recycle in interface Recyclable

Overrides:

recycle in class AbstractGenerator