Package org.operaton.bpm.model.cmmn

Class Cmmn

java.lang.Object

org.operaton.bpm.model.cmmn.Cmmn

public class Cmmn
extends Object

Provides access to the operaton CMMN model api.

Author:

Roman Smirnov

Field Summary

Fields

Modifier and Type	Field	Description
static final Cmmn	INSTANCE	The singleton instance of Cmmn created by the first CmmnFactory found via the ServiceLoader.

Constructor Summary

Constructors

Constructor	Description
Cmmn()	Register known types of the Cmmn model

Method Summary

Modifier and Type	Method	Description
static String	convertToString(CmmnModelInstance modelInstance)	Allows the conversion of a CmmnModelInstance to an String.
static CmmnModelInstance	createEmptyModel()	Allows creating an new, empty CmmnModelInstance.
protected String	doConvertToString(CmmnModelInstance modelInstance)
protected CmmnModelInstance	doCreateEmptyModel()
protected CmmnModelInstance	doReadModelFromFile(File file)
protected CmmnModelInstance	doReadModelFromInputStream(InputStream is)
protected void	doRegisterTypes(ModelBuilder modelBuilder)
protected void	doValidateModel(CmmnModelInstance modelInstance)
protected void	doWriteModelToFile(File file, CmmnModelInstance modelInstance)
protected void	doWriteModelToOutputStream(OutputStream os, CmmnModelInstance modelInstance)
Model	getCmmnModel()
ModelBuilder	getCmmnModelBuilder()
static CmmnModelInstance	readModelFromFile(File file)	Allows reading a CmmnModelInstance from a File.
static CmmnModelInstance	readModelFromStream(InputStream stream)	Allows reading a CmmnModelInstance from an InputStream
void	setCmmnModel(Model cmmnModel)
static void	validateModel(CmmnModelInstance modelInstance)	Validate model DOM document
static void	writeModelToFile(File file, CmmnModelInstance modelInstance)	Allows writing a CmmnModelInstance to a File.
static void	writeModelToStream(OutputStream stream, CmmnModelInstance modelInstance)	Allows writing a CmmnModelInstance to an OutputStream.

Methods inherited from class java.lang.Object

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

Field Details

INSTANCE

public static final Cmmn INSTANCE

The singleton instance of Cmmn created by the first CmmnFactory found via the ServiceLoader.

To customize the behavior of Cmmn, add the fully qualified class name of the custom implementation to the file: META-INF/services/org.operaton.bpm.model.cmmn.CmmnFactory

.

Constructor Details

Cmmn

public Cmmn()

Register known types of the Cmmn model

Method Details

readModelFromFile

public static CmmnModelInstance readModelFromFile(File file)

Allows reading a CmmnModelInstance from a File.

Parameters:

file - the File to read the CmmnModelInstance from

Returns:

the model read

Throws:

CmmnModelException - if the model cannot be read

readModelFromStream

public static CmmnModelInstance readModelFromStream(InputStream stream)

Allows reading a CmmnModelInstance from an InputStream

Parameters:

stream - the InputStream to read the CmmnModelInstance from

Returns:

the model read

Throws:

ModelParseException - if the model cannot be read

writeModelToFile

public static void writeModelToFile(File file,
 CmmnModelInstance modelInstance)

Allows writing a CmmnModelInstance to a File. It will be validated before writing.

Parameters:

file - the File to write the CmmnModelInstance to

modelInstance - the CmmnModelInstance to write

Throws:

CmmnModelException - if the model cannot be written

ModelValidationException - if the model is not valid

writeModelToStream

public static void writeModelToStream(OutputStream stream,
 CmmnModelInstance modelInstance)

Allows writing a CmmnModelInstance to an OutputStream. It will be validated before writing.

Parameters:

stream - the OutputStream to write the CmmnModelInstance to

modelInstance - the CmmnModelInstance to write

Throws:

ModelException - if the model cannot be written

ModelValidationException - if the model is not valid

convertToString

public static String convertToString(CmmnModelInstance modelInstance)

Allows the conversion of a CmmnModelInstance to an String. It will be validated before conversion.

Parameters:

modelInstance - the model instance to convert

Returns:

the XML string representation of the model instance

validateModel

public static void validateModel(CmmnModelInstance modelInstance)

Validate model DOM document

Parameters:

modelInstance - the CmmnModelInstance to validate

Throws:

ModelValidationException - if the model is not valid

createEmptyModel

public static CmmnModelInstance createEmptyModel()

Allows creating an new, empty CmmnModelInstance.

Returns:

the empty model.

doReadModelFromFile

protected CmmnModelInstance doReadModelFromFile(File file)

doReadModelFromInputStream

protected CmmnModelInstance doReadModelFromInputStream(InputStream is)

doWriteModelToFile

protected void doWriteModelToFile(File file,
 CmmnModelInstance modelInstance)

doWriteModelToOutputStream

protected void doWriteModelToOutputStream(OutputStream os,
 CmmnModelInstance modelInstance)

doConvertToString

protected String doConvertToString(CmmnModelInstance modelInstance)

doValidateModel

protected void doValidateModel(CmmnModelInstance modelInstance)

doCreateEmptyModel

protected CmmnModelInstance doCreateEmptyModel()

doRegisterTypes

protected void doRegisterTypes(ModelBuilder modelBuilder)

getCmmnModel

public Model getCmmnModel()

Returns:

the Model instance to use

getCmmnModelBuilder

public ModelBuilder getCmmnModelBuilder()

setCmmnModel

public void setCmmnModel(Model cmmnModel)

Parameters:

cmmnModel - the cmmnModel to set