org.flowable.image.impl

Class DefaultProcessDiagramGenerator

java.lang.Object

org.flowable.image.impl.DefaultProcessDiagramGenerator

All Implemented Interfaces:

ProcessDiagramGenerator

public class DefaultProcessDiagramGenerator
extends Object
implements ProcessDiagramGenerator

Class to generate an image based the diagram interchange information in a BPMN 2.0 process.

Author:

Joram Barrez, Tijs Rademakers, Zheng Ji

Nested Class Summary

Nested Classes

Modifier and Type	Class and Description
protected static interface	DefaultProcessDiagramGenerator.ActivityDrawInstruction
protected static interface	DefaultProcessDiagramGenerator.ArtifactDrawInstruction

Field Summary

Fields

Modifier and Type	Field and Description
protected Map<Class<? extends BaseElement>,DefaultProcessDiagramGenerator.ActivityDrawInstruction>	activityDrawInstructions
protected Map<Class<? extends BaseElement>,DefaultProcessDiagramGenerator.ArtifactDrawInstruction>	artifactDrawInstructions

Constructor Summary

Constructors

Constructor and Description
DefaultProcessDiagramGenerator()
DefaultProcessDiagramGenerator(double scaleFactor)

Method Summary

Modifier and Type	Method and Description
protected static List<GraphicInfo>	connectionPerfectionizer(DefaultProcessDiagramCanvas processDiagramCanvas, BpmnModel bpmnModel, BaseElement sourceElement, BaseElement targetElement, List<GraphicInfo> graphicInfoList) This method makes coordinates of connection flow better.
protected void	drawActivity(DefaultProcessDiagramCanvas processDiagramCanvas, BpmnModel bpmnModel, FlowNode flowNode, List<String> highLightedActivities, List<String> highLightedFlows, double scaleFactor, Boolean drawSequenceFlowNameWithNoLabelDI)
protected void	drawArtifact(DefaultProcessDiagramCanvas processDiagramCanvas, BpmnModel bpmnModel, Artifact artifact)
protected static List<Artifact>	gatherAllArtifacts(BpmnModel bpmnModel)
protected static List<FlowNode>	gatherAllFlowNodes(BpmnModel bpmnModel)
protected static List<FlowNode>	gatherAllFlowNodes(FlowElementsContainer flowElementsContainer)
InputStream	generateDiagram(BpmnModel bpmnModel, String imageType, List<String> highLightedActivities, boolean drawSequenceFlowNameWithNoLabelDI)
InputStream	generateDiagram(BpmnModel bpmnModel, String imageType, List<String> highLightedActivities, double scaleFactor, boolean drawSequenceFlowNameWithNoLabelDI)
InputStream	generateDiagram(BpmnModel bpmnModel, String imageType, List<String> highLightedActivities, List<String> highLightedFlows, boolean drawSequenceFlowNameWithNoLabelDI) Generates a diagram of the given process definition, using the diagram interchange information of the process.
InputStream	generateDiagram(BpmnModel bpmnModel, String imageType, List<String> highLightedActivities, List<String> highLightedFlows, double scaleFactor, boolean drawSequenceFlowNameWithNoLabelDI)
InputStream	generateDiagram(BpmnModel bpmnModel, String imageType, List<String> highLightedActivities, List<String> highLightedFlows, String activityFontName, String labelFontName, String annotationFontName, ClassLoader customClassLoader, double scaleFactor, boolean drawSequenceFlowNameWithNoLabelDI) Generates a diagram of the given process definition, using the diagram interchange information of the process.
InputStream	generateDiagram(BpmnModel bpmnModel, String imageType, String activityFontName, String labelFontName, String annotationFontName, ClassLoader customClassLoader, boolean drawSequenceFlowNameWithNoLabelDI)
InputStream	generateDiagram(BpmnModel bpmnModel, String imageType, String activityFontName, String labelFontName, String annotationFontName, ClassLoader customClassLoader, double scaleFactor, boolean drawSequenceFlowNameWithNoLabelDI)
BufferedImage	generateImage(BpmnModel bpmnModel, String imageType, List<String> highLightedActivities, List<String> highLightedFlows, double scaleFactor, boolean drawSequenceFlowNameWithNoLabelDI)
BufferedImage	generateImage(BpmnModel bpmnModel, String imageType, List<String> highLightedActivities, List<String> highLightedFlows, String activityFontName, String labelFontName, String annotationFontName, ClassLoader customClassLoader, double scaleFactor, boolean drawSequenceFlowNameWithNoLabelDI)
InputStream	generateJpgDiagram(BpmnModel bpmnModel)
InputStream	generateJpgDiagram(BpmnModel bpmnModel, double scaleFactor, boolean drawSequenceFlowNameWithNoLabelDI)
InputStream	generatePngDiagram(BpmnModel bpmnModel, boolean drawSequenceFlowNameWithNoLabelDI)
InputStream	generatePngDiagram(BpmnModel bpmnModel, double scaleFactor, boolean drawSequenceFlowNameWithNoLabelDI)
BufferedImage	generatePngImage(BpmnModel bpmnModel, double scaleFactor)
protected DefaultProcessDiagramCanvas	generateProcessDiagram(BpmnModel bpmnModel, String imageType, List<String> highLightedActivities, List<String> highLightedFlows, String activityFontName, String labelFontName, String annotationFontName, ClassLoader customClassLoader, double scaleFactor, boolean drawSequenceFlowNameWithNoLabelDI)
Map<Class<? extends BaseElement>,DefaultProcessDiagramGenerator.ActivityDrawInstruction>	getActivityDrawInstructions()
Map<Class<? extends BaseElement>,DefaultProcessDiagramGenerator.ArtifactDrawInstruction>	getArtifactDrawInstructions()
protected static GraphicInfo	getLineCenter(List<GraphicInfo> graphicInfoList)
protected static DefaultProcessDiagramCanvas.SHAPE_TYPE	getShapeType(BaseElement baseElement) This method returns shape type of base element. Each element can be presented as rectangle, rhombus, or ellipse.
protected static DefaultProcessDiagramCanvas	initProcessDiagramCanvas(BpmnModel bpmnModel, String imageType, String activityFontName, String labelFontName, String annotationFontName, ClassLoader customClassLoader)
protected boolean	isPartOfCollapsedSubProcess(FlowElement flowElement, BpmnModel model)
protected void	prepareBpmnModel(BpmnModel bpmnModel)
void	setActivityDrawInstructions(Map<Class<? extends BaseElement>,DefaultProcessDiagramGenerator.ActivityDrawInstruction> activityDrawInstructions)
void	setArtifactDrawInstructions(Map<Class<? extends BaseElement>,DefaultProcessDiagramGenerator.ArtifactDrawInstruction> artifactDrawInstructions)

Methods inherited from class java.lang.Object

clone, equals, finalize, getClass, hashCode, notify, notifyAll, toString, wait, wait, wait

Field Detail

activityDrawInstructions

protected Map<Class<? extends BaseElement>,DefaultProcessDiagramGenerator.ActivityDrawInstruction> activityDrawInstructions

artifactDrawInstructions

protected Map<Class<? extends BaseElement>,DefaultProcessDiagramGenerator.ArtifactDrawInstruction> artifactDrawInstructions

Constructor Detail

DefaultProcessDiagramGenerator

public DefaultProcessDiagramGenerator()

DefaultProcessDiagramGenerator

public DefaultProcessDiagramGenerator(double scaleFactor)

Method Detail

generateDiagram

public InputStream generateDiagram(BpmnModel bpmnModel,
                                   String imageType,
                                   List<String> highLightedActivities,
                                   List<String> highLightedFlows,
                                   String activityFontName,
                                   String labelFontName,
                                   String annotationFontName,
                                   ClassLoader customClassLoader,
                                   double scaleFactor,
                                   boolean drawSequenceFlowNameWithNoLabelDI)

Description copied from interface: ProcessDiagramGenerator

Generates a diagram of the given process definition, using the diagram interchange information of the process.

Specified by:

generateDiagram in interface ProcessDiagramGenerator

Parameters:

bpmnModel - bpmn model to get diagram for

imageType - type of the image to generate.

highLightedActivities - activities to highlight

highLightedFlows - flows to highlight

activityFontName - override the default activity font

labelFontName - override the default label font

customClassLoader - provide a custom classloader for retrieving icon images

drawSequenceFlowNameWithNoLabelDI - provide a option to also include the sequence flow name in case there's no Label DI

generateDiagram

public InputStream generateDiagram(BpmnModel bpmnModel,
                                   String imageType,
                                   List<String> highLightedActivities,
                                   List<String> highLightedFlows,
                                   boolean drawSequenceFlowNameWithNoLabelDI)

Description copied from interface: ProcessDiagramGenerator

Generates a diagram of the given process definition, using the diagram interchange information of the process.

Specified by:

generateDiagram in interface ProcessDiagramGenerator

Parameters:

bpmnModel - bpmn model to get diagram for

imageType - type of the image to generate.

highLightedActivities - activities to highlight

highLightedFlows - flows to highlight

drawSequenceFlowNameWithNoLabelDI - provide a option to also include the sequence flow name in case there's no Label DI

generateDiagram

public InputStream generateDiagram(BpmnModel bpmnModel,
                                   String imageType,
                                   List<String> highLightedActivities,
                                   List<String> highLightedFlows,
                                   double scaleFactor,
                                   boolean drawSequenceFlowNameWithNoLabelDI)

Specified by:

generateDiagram in interface ProcessDiagramGenerator

generateDiagram

public InputStream generateDiagram(BpmnModel bpmnModel,
                                   String imageType,
                                   List<String> highLightedActivities,
                                   boolean drawSequenceFlowNameWithNoLabelDI)

Specified by:

generateDiagram in interface ProcessDiagramGenerator

generateDiagram

public InputStream generateDiagram(BpmnModel bpmnModel,
                                   String imageType,
                                   List<String> highLightedActivities,
                                   double scaleFactor,
                                   boolean drawSequenceFlowNameWithNoLabelDI)

Specified by:

generateDiagram in interface ProcessDiagramGenerator

generateDiagram

public InputStream generateDiagram(BpmnModel bpmnModel,
                                   String imageType,
                                   String activityFontName,
                                   String labelFontName,
                                   String annotationFontName,
                                   ClassLoader customClassLoader,
                                   boolean drawSequenceFlowNameWithNoLabelDI)

Specified by:

generateDiagram in interface ProcessDiagramGenerator

generateDiagram

public InputStream generateDiagram(BpmnModel bpmnModel,
                                   String imageType,
                                   String activityFontName,
                                   String labelFontName,
                                   String annotationFontName,
                                   ClassLoader customClassLoader,
                                   double scaleFactor,
                                   boolean drawSequenceFlowNameWithNoLabelDI)

Specified by:

generateDiagram in interface ProcessDiagramGenerator

generatePngDiagram

public InputStream generatePngDiagram(BpmnModel bpmnModel,
                                      boolean drawSequenceFlowNameWithNoLabelDI)

Specified by:

generatePngDiagram in interface ProcessDiagramGenerator

generatePngDiagram

public InputStream generatePngDiagram(BpmnModel bpmnModel,
                                      double scaleFactor,
                                      boolean drawSequenceFlowNameWithNoLabelDI)

Specified by:

generatePngDiagram in interface ProcessDiagramGenerator

generateJpgDiagram

public InputStream generateJpgDiagram(BpmnModel bpmnModel)

Specified by:

generateJpgDiagram in interface ProcessDiagramGenerator

generateJpgDiagram

public InputStream generateJpgDiagram(BpmnModel bpmnModel,
                                      double scaleFactor,
                                      boolean drawSequenceFlowNameWithNoLabelDI)

Specified by:

generateJpgDiagram in interface ProcessDiagramGenerator

generateImage

public BufferedImage generateImage(BpmnModel bpmnModel,
                                   String imageType,
                                   List<String> highLightedActivities,
                                   List<String> highLightedFlows,
                                   String activityFontName,
                                   String labelFontName,
                                   String annotationFontName,
                                   ClassLoader customClassLoader,
                                   double scaleFactor,
                                   boolean drawSequenceFlowNameWithNoLabelDI)

generateImage

public BufferedImage generateImage(BpmnModel bpmnModel,
                                   String imageType,
                                   List<String> highLightedActivities,
                                   List<String> highLightedFlows,
                                   double scaleFactor,
                                   boolean drawSequenceFlowNameWithNoLabelDI)

generatePngImage

public BufferedImage generatePngImage(BpmnModel bpmnModel,
                                      double scaleFactor)

Specified by:

generatePngImage in interface ProcessDiagramGenerator

generateProcessDiagram

protected DefaultProcessDiagramCanvas generateProcessDiagram(BpmnModel bpmnModel,
                                                             String imageType,
                                                             List<String> highLightedActivities,
                                                             List<String> highLightedFlows,
                                                             String activityFontName,
                                                             String labelFontName,
                                                             String annotationFontName,
                                                             ClassLoader customClassLoader,
                                                             double scaleFactor,
                                                             boolean drawSequenceFlowNameWithNoLabelDI)

prepareBpmnModel

protected void prepareBpmnModel(BpmnModel bpmnModel)

drawActivity

protected void drawActivity(DefaultProcessDiagramCanvas processDiagramCanvas,
                            BpmnModel bpmnModel,
                            FlowNode flowNode,
                            List<String> highLightedActivities,
                            List<String> highLightedFlows,
                            double scaleFactor,
                            Boolean drawSequenceFlowNameWithNoLabelDI)

connectionPerfectionizer

protected static List<GraphicInfo> connectionPerfectionizer(DefaultProcessDiagramCanvas processDiagramCanvas,
                                                            BpmnModel bpmnModel,
                                                            BaseElement sourceElement,
                                                            BaseElement targetElement,
                                                            List<GraphicInfo> graphicInfoList)

This method makes coordinates of connection flow better.

Parameters:

processDiagramCanvas -

bpmnModel -

sourceElement -

targetElement -

graphicInfoList -

Returns:

getShapeType

protected static DefaultProcessDiagramCanvas.SHAPE_TYPE getShapeType(BaseElement baseElement)

This method returns shape type of base element.
Each element can be presented as rectangle, rhombus, or ellipse.

Parameters:

baseElement -

Returns:

DefaultProcessDiagramCanvas.SHAPE_TYPE

getLineCenter

protected static GraphicInfo getLineCenter(List<GraphicInfo> graphicInfoList)

drawArtifact

protected void drawArtifact(DefaultProcessDiagramCanvas processDiagramCanvas,
                            BpmnModel bpmnModel,
                            Artifact artifact)

initProcessDiagramCanvas

protected static DefaultProcessDiagramCanvas initProcessDiagramCanvas(BpmnModel bpmnModel,
                                                                      String imageType,
                                                                      String activityFontName,
                                                                      String labelFontName,
                                                                      String annotationFontName,
                                                                      ClassLoader customClassLoader)

gatherAllArtifacts

protected static List<Artifact> gatherAllArtifacts(BpmnModel bpmnModel)

gatherAllFlowNodes

protected static List<FlowNode> gatherAllFlowNodes(BpmnModel bpmnModel)

gatherAllFlowNodes

protected static List<FlowNode> gatherAllFlowNodes(FlowElementsContainer flowElementsContainer)

isPartOfCollapsedSubProcess

protected boolean isPartOfCollapsedSubProcess(FlowElement flowElement,
                                              BpmnModel model)

getActivityDrawInstructions

public Map<Class<? extends BaseElement>,DefaultProcessDiagramGenerator.ActivityDrawInstruction> getActivityDrawInstructions()

setActivityDrawInstructions

public void setActivityDrawInstructions(Map<Class<? extends BaseElement>,DefaultProcessDiagramGenerator.ActivityDrawInstruction> activityDrawInstructions)

getArtifactDrawInstructions

public Map<Class<? extends BaseElement>,DefaultProcessDiagramGenerator.ArtifactDrawInstruction> getArtifactDrawInstructions()

setArtifactDrawInstructions

public void setArtifactDrawInstructions(Map<Class<? extends BaseElement>,DefaultProcessDiagramGenerator.ArtifactDrawInstruction> artifactDrawInstructions)