jadex.bpmn.model.io

Class SBpmnModelWriter

java.lang.Object

jadex.bpmn.model.io.SBpmnModelWriter

public class SBpmnModelWriter
extends java.lang.Object

Writer for BPMN models.

Field Summary

Fields

Modifier and Type	Field and Description
static java.util.Map<java.lang.String,java.lang.String>	ACT_TYPE_MAPPING Activity type mapping.
static int	BUILD The build number
static java.lang.String	END_EVENT_TAG Tag for end events.
static java.lang.String	INDENT_STRING The indentation string.
static java.lang.String	INTERMEDIATE_EVENT_TAG Tag for intermediate events.
static java.lang.String	START_EVENT_TAG Tag for start events.

Constructor Summary

Constructors

Constructor and Description
SBpmnModelWriter()

Method Summary

Modifier and Type	Method and Description
static java.lang.String	getIndent(int num) Generates indentation.
static java.util.List<MActivity>	getPoolActivities(MPool pool) Gets all activities in a pool.
static java.lang.String	handleNullStr(java.lang.String input) Returns an empty string for null and null for an empty string.
protected static void	writeActivitySemantics(java.io.PrintStream out, java.util.List<MActivity> activities, java.lang.String evthandlerref, int baseind, java.util.List<MSequenceEdge> seqedges, java.util.List<MMessagingEdge> medges, java.util.List<MDataEdge> dataedges) Writes the activities of the semantics sections.
protected static void	writeArguments(java.io.PrintStream out, int ind, boolean results, jadex.bridge.modelinfo.IArgument[] args) Writes the arguments or results.
protected static void	writeConfigurations(java.io.PrintStream out, int ind, MBpmnModel mmodel, jadex.bridge.modelinfo.ConfigurationInfo[] configurations) Writes the configurations.
protected static void	writeContextVariables(java.io.PrintStream out, int ind, MBpmnModel mmodel) Writes the context variables.
protected static void	writeImports(java.io.PrintStream out, int ind, java.lang.String[] imports) Writes the imports.
protected static void	writeInitialBoilerPlate(java.io.PrintStream out) Writes the initial XML boiler plate.
protected static void	writeJadexModelInfo(java.io.PrintStream out, int ind, MBpmnModel mmodel) Writes the Jadex-specific model information
protected static void	writeLaneSemantics(java.io.PrintStream out, int ind, java.util.List<MLane> lanes) Writes the lanes of the semantics sections.
protected static void	writeMessagingEdgeSemantics(java.io.PrintStream out, java.util.List<MMessagingEdge> medges, int baseind) Writes the messaging edges of the semantics sections.
static void	writeModel(java.io.File outputfile, MBpmnModel mmodel, IBpmnVisualModelWriter vmodelwriter) Writes a BPMN model.
static void	writeModel(java.io.OutputStream os, MBpmnModel mmodel, IBpmnVisualModelWriter vmodelwriter) Writes a BPMN model.
protected static void	writePoolExtensions(java.io.PrintStream out, int ind, java.util.List<MDataEdge> dataedges) Writes the pool extension elements (e.g.
protected static void	writePoolSemantics(java.io.PrintStream out, int ind, java.util.List<MPool> pools) Writes the pools of the semantics sections.
protected static void	writeProvidedServices(java.io.PrintStream out, int ind, MBpmnModel mmodel) Writes the provided services.
protected static void	writeRequiredServices(java.io.PrintStream out, int ind, MBpmnModel mmodel) Writes the required services.
protected static void	writeSequenceEdgeSemantics(java.io.PrintStream out, java.util.List<MSequenceEdge> seqedges, int baseind) Writes the sequence edges of the semantics sections.
protected static void	writeSubcomponents(java.io.PrintStream out, int ind, jadex.bridge.modelinfo.SubcomponentTypeInfo[] scti) Writes the subcomponents.

Methods inherited from class java.lang.Object

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

Field Detail

BUILD

public static final int BUILD

The build number

See Also:

Constant Field Values

INDENT_STRING

public static final java.lang.String INDENT_STRING

The indentation string.

See Also:

Constant Field Values

START_EVENT_TAG

public static final java.lang.String START_EVENT_TAG

Tag for start events.

See Also:

Constant Field Values

INTERMEDIATE_EVENT_TAG

public static final java.lang.String INTERMEDIATE_EVENT_TAG

Tag for intermediate events.

See Also:

Constant Field Values

END_EVENT_TAG

public static final java.lang.String END_EVENT_TAG

Tag for end events.

See Also:

Constant Field Values

ACT_TYPE_MAPPING

public static final java.util.Map<java.lang.String,java.lang.String> ACT_TYPE_MAPPING

Activity type mapping.

Constructor Detail

SBpmnModelWriter

public SBpmnModelWriter()

Method Detail

writeModel

public static final void writeModel(java.io.File outputfile,
                                    MBpmnModel mmodel,
                                    IBpmnVisualModelWriter vmodelwriter)
                             throws java.io.IOException

Writes a BPMN model.

Parameters:

outputfile - The output file.

mmodel - The BPMN model.

vmodelwriter - The visual model writer, can be null.

Throws:

java.io.IOException

writeModel

public static final void writeModel(java.io.OutputStream os,
                                    MBpmnModel mmodel,
                                    IBpmnVisualModelWriter vmodelwriter)
                             throws java.io.IOException

Writes a BPMN model.

Parameters:

os - The output stream.

mmodel - The BPMN model.

vmodelwriter - The visual model writer, can be null.

Throws:

java.io.IOException

writeInitialBoilerPlate

protected static final void writeInitialBoilerPlate(java.io.PrintStream out)

Writes the initial XML boiler plate.

Parameters:

out - The output.

semid - The semantics ID.

writeJadexModelInfo

protected static final void writeJadexModelInfo(java.io.PrintStream out,
                                                int ind,
                                                MBpmnModel mmodel)

Writes the Jadex-specific model information

Parameters:

out - The output.

ind - The indentation level.

mmodel - The model.

writeImports

protected static final void writeImports(java.io.PrintStream out,
                                         int ind,
                                         java.lang.String[] imports)

Writes the imports.

Parameters:

out - The output.

ind - The indentation level.

imports - The imports.

writeSubcomponents

protected static final void writeSubcomponents(java.io.PrintStream out,
                                               int ind,
                                               jadex.bridge.modelinfo.SubcomponentTypeInfo[] scti)

Writes the subcomponents.

Parameters:

out - The output.

ind - The indentation level.

scti - The subcomponent type infos.

writeArguments

protected static final void writeArguments(java.io.PrintStream out,
                                           int ind,
                                           boolean results,
                                           jadex.bridge.modelinfo.IArgument[] args)

Writes the arguments or results.

Parameters:

out - The output.

ind - The indentation level.

results - Set true for writing results.

args - The arguments or results.

writeContextVariables

protected static final void writeContextVariables(java.io.PrintStream out,
                                                  int ind,
                                                  MBpmnModel mmodel)

Writes the context variables.

Parameters:

out - The output.

ind - The indentation level.

mmodel - The BPMN model.

writeProvidedServices

protected static final void writeProvidedServices(java.io.PrintStream out,
                                                  int ind,
                                                  MBpmnModel mmodel)

Writes the provided services.

Parameters:

out - The output.

mmodel - The BPMN model.

writeRequiredServices

protected static final void writeRequiredServices(java.io.PrintStream out,
                                                  int ind,
                                                  MBpmnModel mmodel)

Writes the required services.

Parameters:

out - The output.

mmodel - The BPMN model.

writeConfigurations

protected static final void writeConfigurations(java.io.PrintStream out,
                                                int ind,
                                                MBpmnModel mmodel,
                                                jadex.bridge.modelinfo.ConfigurationInfo[] configurations)

Writes the configurations.

Parameters:

out - The output.

ind - The indentation level.

configurations - The configurations.

writePoolSemantics

protected static final void writePoolSemantics(java.io.PrintStream out,
                                               int ind,
                                               java.util.List<MPool> pools)

Writes the pools of the semantics sections.

Parameters:

out - The output.

ind - The indentation level.

pools - The pools.

writePoolExtensions

protected static final void writePoolExtensions(java.io.PrintStream out,
                                                int ind,
                                                java.util.List<MDataEdge> dataedges)

Writes the pool extension elements (e.g. data edges).

Parameters:

out - The output.

ind - The indentation level.

seqedges - The sequence edges.

writeLaneSemantics

protected static final void writeLaneSemantics(java.io.PrintStream out,
                                               int ind,
                                               java.util.List<MLane> lanes)

Writes the lanes of the semantics sections.

Parameters:

out - The output.

ind - The indentation level.

lanes - The lanes.

writeActivitySemantics

protected static final void writeActivitySemantics(java.io.PrintStream out,
                                                   java.util.List<MActivity> activities,
                                                   java.lang.String evthandlerref,
                                                   int baseind,
                                                   java.util.List<MSequenceEdge> seqedges,
                                                   java.util.List<MMessagingEdge> medges,
                                                   java.util.List<MDataEdge> dataedges)

Writes the activities of the semantics sections.

Parameters:

out - The output.

activities - The activities.

writeSequenceEdgeSemantics

protected static final void writeSequenceEdgeSemantics(java.io.PrintStream out,
                                                       java.util.List<MSequenceEdge> seqedges,
                                                       int baseind)

Writes the sequence edges of the semantics sections.

Parameters:

out - The output.

seqedges - The sequence edges.

writeMessagingEdgeSemantics

protected static final void writeMessagingEdgeSemantics(java.io.PrintStream out,
                                                        java.util.List<MMessagingEdge> medges,
                                                        int baseind)

Writes the messaging edges of the semantics sections.

Parameters:

out - The output.

seqedges - The messaging edges.

getPoolActivities

public static final java.util.List<MActivity> getPoolActivities(MPool pool)

Gets all activities in a pool. TODO: Support nested lanes.

Parameters:

pool - The pool.

Returns:

The contained activities.

getIndent

public static final java.lang.String getIndent(int num)

Generates indentation.

Parameters:

num - The indentation number.

Returns:

Indentation string.

handleNullStr

public static final java.lang.String handleNullStr(java.lang.String input)

Returns an empty string for null and null for an empty string.