Package org.ametys.plugins.workflow.readers

Class PlantUMLSVGReader

java.lang.Object

org.apache.avalon.framework.logger.AbstractLogEnabled

org.apache.cocoon.reading.AbstractReader

org.ametys.plugins.workflow.readers.AbstractPlantUMLSVGReader

org.ametys.plugins.workflow.readers.PlantUMLSVGReader

All Implemented Interfaces:

Poolable, Recyclable, Component, LogEnabled, Serviceable, Reader, SitemapModelComponent, SitemapOutputComponent

public class PlantUMLSVGReader
extends AbstractPlantUMLSVGReader

Serialize PlantUML state diagram

Field Summary

Fields inherited from class org.ametys.plugins.workflow.readers.AbstractPlantUMLSVGReader

__MAIN_STEP_NODE_COLOR, _i18nHelper, _i18nUtils, _jsonUtils, _workflowRightHelper, _workflowSessionHelper, _workflowStepDAO, _workflowTransitionDAO

Fields inherited from class org.apache.cocoon.reading.AbstractReader

objectModel, out, parameters, resolver, source

Fields inherited from interface org.apache.cocoon.reading.Reader

ROLE

Constructor Summary

Constructors

Constructor	Description
PlantUMLSVGReader()

Method Summary

Modifier and Type	Method	Description
protected String	_createState(com.opensymphony.workflow.loader.WorkflowDescriptor workflow, com.opensymphony.workflow.loader.StepDescriptor step)	Create new state in diagram
protected String	_createTransition(com.opensymphony.workflow.loader.WorkflowDescriptor workflow, com.opensymphony.workflow.loader.StepDescriptor step, com.opensymphony.workflow.loader.ActionDescriptor transition)	Create a new transition between two states in diagram
protected String	_getPlantUMLGraphContent(Request request, com.opensymphony.workflow.loader.WorkflowDescriptor workflowDescriptor)	Get the plantUML diagram body
protected String	_getPlantUMLStyle()	Get plantUML style for current diagram
protected String	_getPlantUMLType()	Get the diagram type
protected String	_getTransitionArrow(String incomingState, String outgoingState, String label, String iconPath, String jsFunction, String linkTooltip, boolean isDashed)	Get the transition arrow between 2 states

Methods inherited from class org.ametys.plugins.workflow.readers.AbstractPlantUMLSVGReader

_getActionLabel, _getActionTooltip, _getJsFunction, _getPlantUMLContent, _getStepNodeLabel, _getStepTooltip, _getStringWithEscapedSpace, _setContextInRequestAttributes, _setPlantUMLProperties, generate, service

Methods inherited from class org.apache.cocoon.reading.AbstractReader

getLastModified, getMimeType, recycle, setOutputStream, setup, shouldSetContentLength

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

Constructor Details

PlantUMLSVGReader

public PlantUMLSVGReader()

Method Details

_getPlantUMLType

protected String _getPlantUMLType()

Description copied from class: AbstractPlantUMLSVGReader

Get the diagram type

Specified by:

_getPlantUMLType in class AbstractPlantUMLSVGReader

Returns:

the diagram type

_getPlantUMLStyle

protected String _getPlantUMLStyle()

Description copied from class: AbstractPlantUMLSVGReader

Get plantUML style for current diagram

Specified by:

_getPlantUMLStyle in class AbstractPlantUMLSVGReader

Returns:

the style as string

_getPlantUMLGraphContent

protected String _getPlantUMLGraphContent(Request request,
 com.opensymphony.workflow.loader.WorkflowDescriptor workflowDescriptor)

Description copied from class: AbstractPlantUMLSVGReader

Get the plantUML diagram body

Specified by:

_getPlantUMLGraphContent in class AbstractPlantUMLSVGReader

Parameters:

request - the request

workflowDescriptor - descriptor of current workflow

Returns:

the diagram body as string

_getTransitionArrow

protected String _getTransitionArrow(String incomingState,
 String outgoingState,
 String label,
 String iconPath,
 String jsFunction,
 String linkTooltip,
 boolean isDashed)

Get the transition arrow between 2 states

Parameters:

incomingState - state's id before transition

outgoingState - state's id after transition

label - the transition's label

iconPath - the transition's icon path

jsFunction - the js function for sending current transition as selection

linkTooltip - the transition link's tooltip

isDashed - true if the arrow must be dashed

Returns:

the transition arrow content

_createState

protected String _createState(com.opensymphony.workflow.loader.WorkflowDescriptor workflow,
 com.opensymphony.workflow.loader.StepDescriptor step)

Create new state in diagram

Parameters:

workflow - unique id of current workflow

step - a step of the workflow

Returns:

a string defining a plantUML state

_createTransition

protected String _createTransition(com.opensymphony.workflow.loader.WorkflowDescriptor workflow,
 com.opensymphony.workflow.loader.StepDescriptor step,
 com.opensymphony.workflow.loader.ActionDescriptor transition)

Create a new transition between two states in diagram

Parameters:

workflow - unique id of current workflow

step - the initial step of this transition

transition - the current action

Returns:

a string defining a plantUML transition