Package org.ametys.plugins.workflow.readers

Class AbstractPlantUMLSVGReader

java.lang.Object

org.apache.avalon.framework.logger.AbstractLogEnabled

org.apache.cocoon.reading.AbstractReader

org.ametys.plugins.workflow.readers.AbstractPlantUMLSVGReader

All Implemented Interfaces:

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

Direct Known Subclasses:

AbstractPlantUMLMindmapSVGReader, PlantUMLSVGReader

public abstract class AbstractPlantUMLSVGReader
extends AbstractReader
implements Serviceable

Abstract class for reading PlantUML SVG

Field Summary

Fields

Modifier and Type	Field	Description
protected static final String	__MAIN_STEP_NODE_COLOR	The color for step nodes
protected I18nUtils	_i18nUtils	I18n Utils
protected WorkflowHelper	_workflowHelper	The workflow helper
protected WorkflowStepDAO	_workflowStepDAO	The workflow step DAO

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

Method Summary

Modifier and Type	Method	Description
protected String	_getActionLabel(com.opensymphony.workflow.loader.ActionDescriptor action)	Get the action label for node
protected String	_getActionTooltip(com.opensymphony.workflow.loader.ActionDescriptor action)	Get the tooltip for a link on action
protected String	_getJsFunction(String workflowName, String stepId, String actionId)	Get js function to send selection
protected String	_getPlantUMLContent(Request request, com.opensymphony.workflow.loader.WorkflowDescriptor workflowDescriptor)	Get the PlantUML SVG content to read
protected abstract String	_getPlantUMLGraphContent(Request request, com.opensymphony.workflow.loader.WorkflowDescriptor workflowDescriptor)	Get the plantUML diagram body
protected abstract String	_getPlantUMLStyle()	Get plantUML style for current diagram
protected abstract String	_getPlantUMLType()	Get the diagram type
protected String	_getStepNodeLabel(com.opensymphony.workflow.loader.WorkflowDescriptor workflowDescriptor, int stepId)	Get the node label for step
protected String	_getStepTooltip(com.opensymphony.workflow.loader.StepDescriptor step)	Get the tooltip for a link on step
protected void	_setPlantUMLProperties()	Set common plantUML svg properties
void	generate()
void	service(ServiceManager serviceManager)

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

Field Details

__MAIN_STEP_NODE_COLOR

protected static final String __MAIN_STEP_NODE_COLOR

The color for step nodes

See Also:

• Constant Field Values

_workflowHelper

protected WorkflowHelper _workflowHelper

The workflow helper

_i18nUtils

protected I18nUtils _i18nUtils

I18n Utils

_workflowStepDAO

protected WorkflowStepDAO _workflowStepDAO

The workflow step DAO

Constructor Details

AbstractPlantUMLSVGReader

public AbstractPlantUMLSVGReader()

Method Details

service

public void service(ServiceManager serviceManager)
             throws ServiceException

Specified by:

service in interface Serviceable

Throws:

ServiceException

generate

public void generate()
              throws IOException,
SAXException,
ProcessingException

Specified by:

generate in interface Reader

Throws:

IOException

SAXException

ProcessingException

_setPlantUMLProperties

protected void _setPlantUMLProperties()

Set common plantUML svg properties

_getPlantUMLContent

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

Get the PlantUML SVG content to read

Parameters:

request - the request

workflowDescriptor - descriptor of current workflow

Returns:

The content to read

_getPlantUMLType

protected abstract String _getPlantUMLType()

Get the diagram type

Returns:

the diagram type

_getPlantUMLStyle

protected abstract String _getPlantUMLStyle()

Get plantUML style for current diagram

Returns:

the style as string

_getPlantUMLGraphContent

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

Get the plantUML diagram body

Parameters:

request - the request

workflowDescriptor - descriptor of current workflow

Returns:

the diagram body as string

_getJsFunction

protected String _getJsFunction(String workflowName,
 String stepId,
 String actionId)

Get js function to send selection

Parameters:

workflowName - unique name of current workflow

stepId - current or incoming step's id

actionId - current action's, can be null

Returns:

the js function

_getStepNodeLabel

protected String _getStepNodeLabel(com.opensymphony.workflow.loader.WorkflowDescriptor workflowDescriptor,
 int stepId)

Get the node label for step

Parameters:

workflowDescriptor - current workflow

stepId - current step id

Returns:

the node label which is the translated step name and its id

_getStepTooltip

protected String _getStepTooltip(com.opensymphony.workflow.loader.StepDescriptor step)

Get the tooltip for a link on step

Parameters:

step - current step

Returns:

the tooltip

_getActionLabel

protected String _getActionLabel(com.opensymphony.workflow.loader.ActionDescriptor action)

Get the action label for node

Parameters:

action - current action

Returns:

the label as action's name and id

_getActionTooltip

protected String _getActionTooltip(com.opensymphony.workflow.loader.ActionDescriptor action)

Get the tooltip for a link on action

Parameters:

action - current action

Returns:

the tooltip