Package org.ametys.odf.workflow.task

Class AbstractOdfWorkflowTasksWithChangesComponent

java.lang.Object

org.apache.avalon.framework.logger.AbstractLogEnabled

org.ametys.cms.workflow.WorkflowTasksComponent

org.ametys.odf.workflow.task.AbstractOdfWorkflowTasksComponent

org.ametys.odf.workflow.task.AbstractOdfWorkflowTasksWithChangesComponent

All Implemented Interfaces:

Component, Configurable, LogEnabled, Serviceable, ThreadSafe

Direct Known Subclasses:

ProgramWorkflowTasksComponent, SubProgramWorkflowTasksComponent

public abstract class AbstractOdfWorkflowTasksWithChangesComponent
extends AbstractOdfWorkflowTasksComponent

Override AbstractOdfWorkflowTasksComponent to add the change informations

Nested Class Summary

Nested classes/interfaces inherited from class org.ametys.cms.workflow.WorkflowTasksComponent

WorkflowTasksComponent.LastModifiedDateComparator, WorkflowTasksComponent.Task, WorkflowTasksComponent.TaskStep

Field Summary

Fields

Modifier and Type	Field	Description
protected CompareVersionHelper	_compareVersionHelper	The helper for comparing versions
protected Map<String,Collection<String>>	_importantAttributes	The (defined in configuration) important attributes by task
protected JSONUtils	_jsonUtils	The JSON util
protected Map<String,Boolean>	_showChanges	Map of show changes indexed by task id
protected Map<String,Boolean>	_showImportantChanges	Map of show important changes indexed by task id

Fields inherited from class org.ametys.odf.workflow.task.AbstractOdfWorkflowTasksComponent

_catalogsManager

Fields inherited from class org.ametys.cms.workflow.WorkflowTasksComponent

_allowUserQuery, _contentHelper, _contentTypesHelper, _cTypeEP, _languagesManager, _objectResolver, _rightManager, _tasks, _userManager, _workflowProvider, ROLE

Constructor Summary

Constructors

Constructor	Description
AbstractOdfWorkflowTasksWithChangesComponent()

Method Summary

Modifier and Type	Method	Description
protected void	_configureAdditional(WorkflowTasksComponent.Task task, Configuration taskConf)	Configure additional configuration
protected void	_configureChanges(Configuration taskConfiguration)	Configures the changes to SAX
protected List<Map<String,Object>>	_getAttributeChanges(WorkflowTasksComponent.Task task, List<ContentComparatorChange> changes)	Gets the attribute changes (as JSON) of the given content which changed since the last validation
protected <C extends Content & VersionAwareAmetysObject> Optional<String>	_getBaseVersion(C versionable)	Gets the base version of comparison.
protected <C extends Content & VersionAwareAmetysObject> List<ContentComparatorChange>	_getChanges(C content)	Gets the changes
protected <C extends Content & VersionAwareAmetysObject> String	_getTargetVersion(C versionable)	Gets the source version of comparison.
protected boolean	_isImportant(WorkflowTasksComponent.Task task, ModelItem changedModelItem)	Determines if a change is important
protected void	_saxAdditionalData(ContentHandler ch, Content content, WorkflowTasksComponent.Task task)	SAX additional data
protected void	_saxAttributeChanges(ContentHandler ch, Content content, WorkflowTasksComponent.Task task, List<ContentComparatorChange> changes)	SAX attributes of the given content which changed since the last validation
void	service(ServiceManager manager)
boolean	showChanges(WorkflowTasksComponent.Task task)	Determines if changes have to be shown for the given task
boolean	showImportantChanges(WorkflowTasksComponent.Task task)	Determines if important changes have to be shown for the given task

Methods inherited from class org.ametys.odf.workflow.task.AbstractOdfWorkflowTasksComponent

_getContentsAndExpressions, getContentTypeExpression

Methods inherited from class org.ametys.cms.workflow.WorkflowTasksComponent

_configureStep, _configureStepIds, _configureTasks, _getContents, _getCorrespondingWorkflows, _getTaskContents, _getTaskContents, _saxAdditionalAttributes, _saxAdditionalAttributes, _saxContent, _saxContentCurrentState, _saxTask, _testContent, allowUserQuery, configure, getContents, getTasks, toSAX, toSAX

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

_jsonUtils

protected JSONUtils _jsonUtils

The JSON util

_compareVersionHelper

protected CompareVersionHelper _compareVersionHelper

The helper for comparing versions

_showChanges

protected Map<String,Boolean> _showChanges

Map of show changes indexed by task id

_showImportantChanges

protected Map<String,Boolean> _showImportantChanges

Map of show important changes indexed by task id

_importantAttributes

protected Map<String,Collection<String>> _importantAttributes

The (defined in configuration) important attributes by task

Constructor Detail

AbstractOdfWorkflowTasksWithChangesComponent

public AbstractOdfWorkflowTasksWithChangesComponent()

Method Detail

service

public void service(ServiceManager manager)
             throws ServiceException

Specified by:

service in interface Serviceable

Overrides:

service in class AbstractOdfWorkflowTasksComponent

Throws:

ServiceException

_configureAdditional

protected void _configureAdditional(WorkflowTasksComponent.Task task,
                                    Configuration taskConf)
                             throws ConfigurationException

Description copied from class: WorkflowTasksComponent

Configure additional configuration

Overrides:

_configureAdditional in class WorkflowTasksComponent

Parameters:

task - task the current task

taskConf - the task configuration.

Throws:

ConfigurationException - if a configuration error occurs.

showChanges

public boolean showChanges(WorkflowTasksComponent.Task task)

Determines if changes have to be shown for the given task

Parameters:

task - the task

Returns:

true if changes are configured to be SAXed

showImportantChanges

public boolean showImportantChanges(WorkflowTasksComponent.Task task)

Determines if important changes have to be shown for the given task

Parameters:

task - the task

Returns:

true if changes are configured to be SAXed

_configureChanges

protected void _configureChanges(Configuration taskConfiguration)
                          throws ConfigurationException

Configures the changes to SAX

Parameters:

taskConfiguration - The task configuration

Throws:

ConfigurationException - If the configuration is invalid.

_saxAdditionalData

protected void _saxAdditionalData(ContentHandler ch,
                                  Content content,
                                  WorkflowTasksComponent.Task task)
                           throws SAXException

Description copied from class: WorkflowTasksComponent

SAX additional data

Overrides:

_saxAdditionalData in class AbstractOdfWorkflowTasksComponent

Parameters:

ch - the content handler.

content - the content

task - the task

Throws:

SAXException - If an error occurred

_getChanges

protected <C extends Content & VersionAwareAmetysObject> List<ContentComparatorChange> _getChanges(C content)
                                                                                            throws AmetysRepositoryException,
                                                                                                   IOException

Gets the changes

Type Parameters:

C - The type of the VersionAwareAmetysObject Content

Parameters:

content - The content

Returns:

The changes

Throws:

AmetysRepositoryException - repository exception

IOException - IO exception

_getTargetVersion

protected <C extends Content & VersionAwareAmetysObject> String _getTargetVersion(C versionable)

Gets the source version of comparison. By default, it is the current one.

Type Parameters:

C - The type of the VersionAwareAmetysObject Content

Parameters:

versionable - The Content

Returns:

the source version

_getBaseVersion

protected <C extends Content & VersionAwareAmetysObject> Optional<String> _getBaseVersion(C versionable)

Gets the base version of comparison. By default, it is the last validated one.

Type Parameters:

C - The type of the VersionAwareAmetysObject Content

Parameters:

versionable - The Content

Returns:

the target version

_saxAttributeChanges

protected void _saxAttributeChanges(ContentHandler ch,
                                    Content content,
                                    WorkflowTasksComponent.Task task,
                                    List<ContentComparatorChange> changes)
                             throws SAXException

SAX attributes of the given content which changed since the last validation

Parameters:

ch - The content handler

content - The content

task - the current task

changes - The changes

Throws:

SAXException - If an error occurred

_getAttributeChanges

protected List<Map<String,Object>> _getAttributeChanges(WorkflowTasksComponent.Task task,
                                                              List<ContentComparatorChange> changes)

Gets the attribute changes (as JSON) of the given content which changed since the last validation

Parameters:

task - the current task

changes - The changes

Returns:

The changes as JSON

_isImportant

protected boolean _isImportant(WorkflowTasksComponent.Task task,
                               ModelItem changedModelItem)

Determines if a change is important

Parameters:

task - the current task

changedModelItem - The changed ModelItem

Returns:

true if the change is important