de.aristaflow.adept2.model.processmodel.xml

Class ProcessModelXMLExport

java.lang.Object

de.aristaflow.adept2.model.processmodel.xml.ProcessModelXMLExport

public class ProcessModelXMLExport
extends java.lang.Object

The XMLExport class allows to export any template or instance data to an xml file, an DOM document, a string or a byte array (containing XML code). TODO Instance: export *histories elements in the histories-namespace?

Author:

Kevin Goeser

Constructor Summary

Constructors

Constructor and Description
ProcessModelXMLExport()

Method Summary

Modifier and Type	Method and Description
org.w3c.dom.Document	getDocumentDataElementList(java.util.Set<DataElement> dataElements) Exports a set of data elements to a document.
org.w3c.dom.Document	getDocumentForAdhocTemplateMapping(java.util.Map<java.util.UUID,java.util.UUID> mapping) Generates and returns a Document representing the given adhoc template id mapping
org.w3c.dom.Document	getDocumentForBaseTemplateMapping(java.util.Map<java.util.UUID,java.util.UUID> mapping) Generates and returns a Document representing the given base template id mapping
org.w3c.dom.Document	getDocumentForEBP(ExecutableBusinessProcess ebp)
org.w3c.dom.Document	getDocumentForEmbeddedTemplateMapping(java.util.Map<java.util.UUID,java.util.UUID> mapping) Generates and returns a Document representing the given embedded template id mapping
org.w3c.dom.Document	getDocumentForExecutableInstanceAndStatus(ExecutableInstance instance, InstanceStatus instanceStatus, boolean storeStructure) Writes the given instance including its status to the given file.
org.w3c.dom.Document	getDocumentForInstance(Instance instance) Creates a DOM document from the instance.
org.w3c.dom.Document	getDocumentForInstanceLocks(java.util.Map<java.util.UUID,ProcessModelXMLHelperTools.LockDescription> locks) Generates and returns a Document for the given instance locks
org.w3c.dom.Document	getDocumentForParameter(ProcessModelParameter parameter, boolean isInputParameter) TODO set namespace, schema location, check schema?
org.w3c.dom.Document	getDocumentForParameterSet(java.util.Collection<ProcessModelParameter> parameter, boolean isInputParameter) TODO set namespace, schema location, check schema?
org.w3c.dom.Document	getDocumentForProcessTypes(java.util.Set<ProcessModelXMLHelperTools.SerialisableProcessType> items) Generates and returns a Document representing the given ProcessTypes
org.w3c.dom.Document	getDocumentForTemplate(Template template) Creates a DOM document from the template.
org.w3c.dom.Document	getDocumentForTemplateAndStatus(Template template, TemplateStatus templateStatus) Returns The corresponding document for a given template and a given template status.
org.w3c.dom.Document	getDocumentForTemplateInformations(java.util.Map<java.util.UUID,ProcessModelXMLHelperTools.TemplateInformation> items) Generates and returns a Document representing the given TemplateInformations.
org.w3c.dom.Document	getDocumentForTemplateLocks(java.util.Map<java.util.UUID,ProcessModelXMLHelperTools.LockDescription> locks) Generates and returns a Document for the given template locks
java.io.InputStream	getInputStreamForInstance(Instance instance) Returns The corresponding stream for a given instance
java.io.InputStream	getInputStreamForInstance(Instance instance, boolean intend) Returns The corresponding stream for a given instance
java.io.InputStream	getInputStreamForTemplate(Template template) Returns The corresponding stream for a given template
java.io.InputStream	getInputStreamForTemplate(Template template, boolean intend) Returns The corresponding stream for a given template
java.io.InputStream	getInputStreamForTemplateAndStatus(Template template, TemplateStatus templateStatus) Returns The corresponding stream for a given template and a given template status.
java.io.InputStream	getInputStreamForTemplateAndStatus(Template template, TemplateStatus templateStatus, boolean intend) Returns The corresponding stream for a given template and a given template status.
java.lang.String	getXMLStringForInstance(Instance instance) Returns the xml code of a given instance as string.
java.lang.String	getXMLStringForInstance(Instance instance, boolean intend) Returns the xml code of a given instance as string.
java.lang.String	getXMLStringForTemplate(Template template) Returns the xml code of a given template as string.
java.lang.String	getXMLStringForTemplate(Template template, boolean intend) Returns the xml code of a given template as string.
void	writeAdhocTemplateMappingToFile(java.util.Map<java.util.UUID,java.util.UUID> mapping, java.io.File file) Writes the given adhoc template id mapping to the specified file.
void	writeBaseTemplateMappingToFile(java.util.Map<java.util.UUID,java.util.UUID> mapping, java.io.File file) Writes the given base template id mapping to the specified file.
void	writeEmbeddedTemplateMappingToFile(java.util.Map<java.util.UUID,java.util.UUID> mapping, java.io.File file) Writes the given embedded template id mapping to the specified file.
void	writeExecutableInstanceAndStatusToFile(ExecutableInstance instance, InstanceStatus instanceStatus, java.io.File file) Writes the given instance including its status to the given file.
void	writeExecutableInstanceAndStatusToFile(ExecutableInstance instance, InstanceStatus instanceStatus, java.io.File file, boolean intend) Writes the given instance including its status to the given file.
void	writeExecutableInstanceAndStatusToFile(ExecutableInstance instance, InstanceStatus instanceStatus, java.io.File file, Template structure) Writes the given instance including its status to the given file.
void	writeExecutableInstanceAndStatusToFile(ExecutableInstance instance, InstanceStatus instanceStatus, java.io.File file, Template structure, boolean intend) Writes the given instance including its status to the given file.
void	writeInstanceAndStatusToFile(Instance instance, InstanceStatus instanceStatus, java.io.File file, boolean storeStructure) Writes the given instance including its status to the given file.
void	writeInstanceAndStatusToFile(Instance instance, InstanceStatus instanceStatus, java.io.File file, boolean storeStructure, boolean intend) Writes the given instance including its status to the given file.
void	writeInstanceLocksToFile(java.util.Map<java.util.UUID,ProcessModelXMLHelperTools.LockDescription> locks, java.io.File file) Writes the given instance locks to the specified file.
void	writeInstanceToFile(Instance instance, java.io.File file) Writes the given instance to the given file.
void	writeInstanceToFile(Instance instance, java.io.File file, boolean intend) Writes the given instance to the given file.
void	writeProcessTypesToFile(java.util.Set<ProcessModelXMLHelperTools.SerialisableProcessType> items, java.io.File file) Writes the given adhoc template id mapping to the specified file.
void	writeTemplateAndStatusToFile(Template template, TemplateStatus templateStatus, java.io.File file) Writes the given template including its status to the given file.
void	writeTemplateAndStatusToFile(Template template, TemplateStatus templateStatus, java.io.File file, boolean intend) Writes the given template including its status to the given file.
void	writeTemplateInformationsToFile(java.util.Map<java.util.UUID,ProcessModelXMLHelperTools.TemplateInformation> items, java.io.File file) Writes the given template informations to the specified file.
void	writeTemplateLocksToFile(java.util.Map<java.util.UUID,ProcessModelXMLHelperTools.LockDescription> locks, java.io.File file) Writes the given template locks to the specified file.
void	writeTemplateToFile(Template template, java.io.File file) Writes the given template to the given file.
void	writeTemplateToFile(Template template, java.io.File file, boolean intend) Writes the given template to the given file.

Methods inherited from class java.lang.Object

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

Constructor Detail

ProcessModelXMLExport

public ProcessModelXMLExport()

Method Detail

writeTemplateToFile

public void writeTemplateToFile(Template template,
                                java.io.File file)
                         throws java.io.IOException,
                                XMLFormatException

Writes the given template to the given file.

Parameters:

file - The target file,

template - The source template,

Throws:

java.io.IOException - Thrown if writing the XML to the file fails, e.g. if the provided file is read-only.

XMLFormatException - Thrown if the validation of the document fails

writeTemplateToFile

public void writeTemplateToFile(Template template,
                                java.io.File file,
                                boolean intend)
                         throws java.io.IOException,
                                XMLFormatException

Writes the given template to the given file.

Parameters:

file - The target file,

template - The source template,

intend - Whether to intend child nodes and text content. Use with care! Text content may contain whitespace and linebreaks afterwards!

Throws:

java.io.IOException - Thrown if writing the XML to the file fails, e.g. if the provided file is read-only.

XMLFormatException - Thrown if the validation of the document fails

writeTemplateAndStatusToFile

public void writeTemplateAndStatusToFile(Template template,
                                         TemplateStatus templateStatus,
                                         java.io.File file)
                                  throws java.io.IOException,
                                         XMLFormatException

Writes the given template including its status to the given file.

Parameters:

file - The target file,

template - The source template,

templateStatus - The status of the template.

Throws:

java.io.IOException - Thrown if writing the XML to the file fails, e.g. if the provided file is read-only.

XMLFormatException - Thrown if the validation of the document fails

writeTemplateAndStatusToFile

public void writeTemplateAndStatusToFile(Template template,
                                         TemplateStatus templateStatus,
                                         java.io.File file,
                                         boolean intend)
                                  throws java.io.IOException,
                                         XMLFormatException

Writes the given template including its status to the given file.

Parameters:

file - The target file,

template - The source template,

templateStatus - The status of the template.

intend - Whether to intend child nodes and text content. Use with care! Text content may contain whitespace and linebreaks afterwards!

Throws:

java.io.IOException - Thrown if writing the XML to the file fails, e.g. if the provided file is read-only.

XMLFormatException - Thrown if the validation of the document fails

writeInstanceToFile

public void writeInstanceToFile(Instance instance,
                                java.io.File file)
                         throws java.io.IOException,
                                XMLFormatException

Writes the given instance to the given file.

Parameters:

file - The target file,

instance - The source instance,

Throws:

java.io.IOException - Thrown if writing the XML to the file fails, e.g. if the provided file is read-only.

XMLFormatException - Thrown if the validation of the document fails

writeInstanceToFile

public void writeInstanceToFile(Instance instance,
                                java.io.File file,
                                boolean intend)
                         throws java.io.IOException,
                                XMLFormatException

Writes the given instance to the given file.

Parameters:

file - The target file,

instance - The source instance,

intend - Whether to intend child nodes and text content. Use with care! Text content may contain whitespace and linebreaks afterwards!

Throws:

java.io.IOException - Thrown if writing the XML to the file fails, e.g. if the provided file is read-only.

XMLFormatException - Thrown if the validation of the document fails

writeInstanceAndStatusToFile

public void writeInstanceAndStatusToFile(Instance instance,
                                         InstanceStatus instanceStatus,
                                         java.io.File file,
                                         boolean storeStructure)
                                  throws java.io.IOException,
                                         XMLFormatException

Writes the given instance including its status to the given file.

Parameters:

instance - The source instance,

instanceStatus - The status object of the instance

file - The target file,

storeStructure - If set to true, the structure is stored to the file, else, only an ID reference will be stored.

Throws:

java.io.IOException - Thrown if writing the XML to the file fails, e.g. if the provided file is read-only.

XMLFormatException - Thrown if the validation of the document fails

writeInstanceAndStatusToFile

public void writeInstanceAndStatusToFile(Instance instance,
                                         InstanceStatus instanceStatus,
                                         java.io.File file,
                                         boolean storeStructure,
                                         boolean intend)
                                  throws java.io.IOException,
                                         XMLFormatException

Writes the given instance including its status to the given file.

Parameters:

instance - The source instance,

instanceStatus - The status object of the instance

file - The target file,

storeStructure - If set to true, the structure is stored to the file, else, only an ID reference will be stored.

intend - Whether to intend child nodes and text content. Use with care! Text content may contain whitespace and linebreaks afterwards!

Throws:

java.io.IOException - Thrown if writing the XML to the file fails, e.g. if the provided file is read-only.

XMLFormatException - Thrown if the validation of the document fails

writeExecutableInstanceAndStatusToFile

public void writeExecutableInstanceAndStatusToFile(ExecutableInstance instance,
                                                   InstanceStatus instanceStatus,
                                                   java.io.File file)
                                            throws java.io.IOException,
                                                   XMLFormatException

Writes the given instance including its status to the given file. The template will be written in case the designated instance is modified.

Parameters:

instance - The source instance,

instanceStatus - The status object of the instance

file - The target file,

Throws:

java.io.IOException - Thrown if writing the XML to the file fails, e.g. if the provided file is read-only.

XMLFormatException - Thrown if the validation of the document fails

See Also:

writeExecutableInstanceAndStatusToFile(ExecutableInstance, InstanceStatus, File, Template)

writeExecutableInstanceAndStatusToFile

public void writeExecutableInstanceAndStatusToFile(ExecutableInstance instance,
                                                   InstanceStatus instanceStatus,
                                                   java.io.File file,
                                                   boolean intend)
                                            throws java.io.IOException,
                                                   XMLFormatException

Writes the given instance including its status to the given file. The template will be written in case the designated instance is modified.

Parameters:

instance - The source instance,

instanceStatus - The status object of the instance

file - The target file,

intend - Whether to intend child nodes and text content. Use with care! Text content may contain whitespace and linebreaks afterwards!

Throws:

java.io.IOException - Thrown if writing the XML to the file fails, e.g. if the provided file is read-only.

XMLFormatException - Thrown if the validation of the document fails

See Also:

writeExecutableInstanceAndStatusToFile(ExecutableInstance, InstanceStatus, File, Template)

writeExecutableInstanceAndStatusToFile

public void writeExecutableInstanceAndStatusToFile(ExecutableInstance instance,
                                                   InstanceStatus instanceStatus,
                                                   java.io.File file,
                                                   Template structure)
                                            throws java.io.IOException,
                                                   XMLFormatException

Writes the given instance including its status to the given file.

Parameters:

instance - The source instance,

instanceStatus - The status object of the instance

file - The target file,

structure - If not null, the designated structure (template or instance delta layer) of the instance, will be stored inline.

Throws:

java.io.IOException - Thrown if writing the XML to the file fails, e.g. if the provided file is read-only.

XMLFormatException - Thrown if the validation of the document fails

writeExecutableInstanceAndStatusToFile

public void writeExecutableInstanceAndStatusToFile(ExecutableInstance instance,
                                                   InstanceStatus instanceStatus,
                                                   java.io.File file,
                                                   Template structure,
                                                   boolean intend)
                                            throws java.io.IOException,
                                                   XMLFormatException

Writes the given instance including its status to the given file.

Parameters:

instance - The source instance,

instanceStatus - The status object of the instance

file - The target file,

structure - If not null, the designated structure (template or instance delta layer) of the instance, will be stored inline.

intend - Whether to intend child nodes and text content. Use with care! Text content may contain whitespace and linebreaks afterwards!

Throws:

java.io.IOException - Thrown if writing the XML to the file fails, e.g. if the provided file is read-only.

XMLFormatException - Thrown if the validation of the document fails

getXMLStringForTemplate

public java.lang.String getXMLStringForTemplate(Template template)
                                         throws XMLFormatException,
                                                java.io.IOException

Returns the xml code of a given template as string.

Parameters:

template - The template which should be transformed.

Returns:

The xml code of the given process as string.

Throws:

XMLFormatException - Thrown if the validation of the document fails

java.io.IOException - Thrown if an unrecoverable error occurs during the course of the transformation

getXMLStringForTemplate

public java.lang.String getXMLStringForTemplate(Template template,
                                                boolean intend)
                                         throws XMLFormatException,
                                                java.io.IOException

Returns the xml code of a given template as string.

Parameters:

template - The template which should be transformed.

intend - Whether to intend child nodes and text content. Use with care! Text content may contain whitespace and linebreaks afterwards!

Returns:

The xml code of the given process as string.

Throws:

XMLFormatException - Thrown if the validation of the document fails

java.io.IOException - Thrown if an unrecoverable error occurs during the course of the transformation

getXMLStringForInstance

public java.lang.String getXMLStringForInstance(Instance instance)
                                         throws XMLFormatException,
                                                java.io.IOException

Returns the xml code of a given instance as string.

Parameters:

instance - The instance which should be transformed.

Returns:

The xml code of the given process as string.

Throws:

XMLFormatException - Thrown if the validation of the document fails

java.io.IOException - Thrown if an unrecoverable error occurs during the course of the transformation

getXMLStringForInstance

public java.lang.String getXMLStringForInstance(Instance instance,
                                                boolean intend)
                                         throws XMLFormatException,
                                                java.io.IOException

Returns the xml code of a given instance as string.

Parameters:

instance - The instance which should be transformed.

intend - Whether to intend child nodes and text content. Use with care! Text content may contain whitespace and linebreaks afterwards!

Returns:

The xml code of the given process as string.

Throws:

XMLFormatException - Thrown if the validation of the document fails

java.io.IOException - Thrown if an unrecoverable error occurs during the course of the transformation

getInputStreamForTemplate

public java.io.InputStream getInputStreamForTemplate(Template template)
                                              throws XMLFormatException,
                                                     java.io.IOException

Returns The corresponding stream for a given template

Parameters:

template - The source template

Returns:

An input stream for the given template

Throws:

XMLFormatException - Thrown if the validation of the document fails

java.io.IOException - Thrown if an unrecoverable error occurs during the course of the transformation

getInputStreamForTemplate

public java.io.InputStream getInputStreamForTemplate(Template template,
                                                     boolean intend)
                                              throws XMLFormatException,
                                                     java.io.IOException

Returns The corresponding stream for a given template

Parameters:

template - The source template

intend - Whether to intend child nodes and text content. Use with care! Text content may contain whitespace and linebreaks afterwards!

Returns:

An input stream for the given template

Throws:

XMLFormatException - Thrown if the validation of the document fails

java.io.IOException - Thrown if an unrecoverable error occurs during the course of the transformation

getInputStreamForTemplateAndStatus

public java.io.InputStream getInputStreamForTemplateAndStatus(Template template,
                                                              TemplateStatus templateStatus)
                                                       throws XMLFormatException,
                                                              java.io.IOException

Returns The corresponding stream for a given template and a given template status.

Parameters:

template - The source template

templateStatus - The template status

Returns:

An input stream for the given template

Throws:

XMLFormatException - Thrown if the validation of the document fails

java.io.IOException - Thrown if an unrecoverable error occurs during the course of the transformation

getInputStreamForTemplateAndStatus

public java.io.InputStream getInputStreamForTemplateAndStatus(Template template,
                                                              TemplateStatus templateStatus,
                                                              boolean intend)
                                                       throws XMLFormatException,
                                                              java.io.IOException

Returns The corresponding stream for a given template and a given template status.

Parameters:

template - The source template

templateStatus - The template status

intend - Whether to intend child nodes and text content. Use with care! Text content may contain whitespace and linebreaks afterwards!

Returns:

An input stream for the given template

Throws:

XMLFormatException - Thrown if the validation of the document fails

java.io.IOException - Thrown if an unrecoverable error occurs during the course of the transformation

getDocumentForTemplateAndStatus

public org.w3c.dom.Document getDocumentForTemplateAndStatus(Template template,
                                                            TemplateStatus templateStatus)
                                                     throws XMLFormatException

Returns The corresponding document for a given template and a given template status.

Parameters:

template - The source template

templateStatus - The template status

Returns:

A document for the given template

Throws:

XMLFormatException - Thrown if the validation of the document fails

getInputStreamForInstance

public java.io.InputStream getInputStreamForInstance(Instance instance)
                                              throws XMLFormatException,
                                                     java.io.IOException

Returns The corresponding stream for a given instance

Parameters:

instance - The source instance

Returns:

An input stream for the given instance

Throws:

XMLFormatException - Thrown if the validation of the document fails

java.io.IOException - Thrown if an unrecoverable error occurs during the course of the transformation

getInputStreamForInstance

public java.io.InputStream getInputStreamForInstance(Instance instance,
                                                     boolean intend)
                                              throws XMLFormatException,
                                                     java.io.IOException

Returns The corresponding stream for a given instance

Parameters:

instance - The source instance

intend - Whether to intend child nodes and text content. Use with care! Text content may contain whitespace and linebreaks afterwards!

Returns:

An input stream for the given instance

Throws:

XMLFormatException - Thrown if the validation of the document fails

java.io.IOException - Thrown if an unrecoverable error occurs during the course of the transformation

getDocumentForExecutableInstanceAndStatus

public org.w3c.dom.Document getDocumentForExecutableInstanceAndStatus(ExecutableInstance instance,
                                                                      InstanceStatus instanceStatus,
                                                                      boolean storeStructure)

Writes the given instance including its status to the given file.

Parameters:

instance - The source instance,

instanceStatus - The status object of the instance

storeStructure - If set to true, the structure is stored to the file, else, only an ID reference will be stored.

Returns:

The input stream

getDocumentForTemplate

public org.w3c.dom.Document getDocumentForTemplate(Template template)
                                            throws XMLFormatException

Creates a DOM document from the template.

Parameters:

template - The source template

Returns:

A DOM document

Throws:

XMLFormatException - Thrown if the validation of the document fails

getDocumentForInstance

public org.w3c.dom.Document getDocumentForInstance(Instance instance)
                                            throws XMLFormatException

Creates a DOM document from the instance.

Parameters:

instance - The source instance

Returns:

A DOM document

Throws:

XMLFormatException - Thrown if the validation of the document fails

getDocumentForEBP

public org.w3c.dom.Document getDocumentForEBP(ExecutableBusinessProcess ebp)
                                       throws XMLFormatException

Parameters:

ebp -

Returns:

A DOM/XML document for the given executable business process.

Throws:

XMLFormatException - Thrown if the validation of the document fails

getDocumentForParameter

public org.w3c.dom.Document getDocumentForParameter(ProcessModelParameter parameter,
                                                    boolean isInputParameter)

TODO set namespace, schema location, check schema?

Parameters:

parameter - The source parameter

isInputParameter - If true, an input parameter will be created, else an output parameter.

Returns:

A DOM/XML document for the given parameter.

getDocumentForParameterSet

public org.w3c.dom.Document getDocumentForParameterSet(java.util.Collection<ProcessModelParameter> parameter,
                                                       boolean isInputParameter)

TODO set namespace, schema location, check schema?

Parameters:

parameter - The source Parameterset.

isInputParameter - If true, an input parameter set will be created, else an output parameter set.

Returns:

A DOM/XML document for the set of parameters.

getDocumentDataElementList

public org.w3c.dom.Document getDocumentDataElementList(java.util.Set<DataElement> dataElements)

Exports a set of data elements to a document.

Parameters:

dataElements - The data elements to be exported.

Returns:

A document with a list of data element XML elements.

getDocumentForTemplateLocks

public org.w3c.dom.Document getDocumentForTemplateLocks(java.util.Map<java.util.UUID,ProcessModelXMLHelperTools.LockDescription> locks)
                                                 throws XMLFormatException

Generates and returns a Document for the given template locks

Parameters:

locks -

Returns:

the generated document

Throws:

XMLFormatException

writeTemplateLocksToFile

public void writeTemplateLocksToFile(java.util.Map<java.util.UUID,ProcessModelXMLHelperTools.LockDescription> locks,
                                     java.io.File file)
                              throws java.io.IOException,
                                     XMLFormatException

Writes the given template locks to the specified file.

Parameters:

locks -

file -

Throws:

XMLFormatException

java.io.IOException

getDocumentForInstanceLocks

public org.w3c.dom.Document getDocumentForInstanceLocks(java.util.Map<java.util.UUID,ProcessModelXMLHelperTools.LockDescription> locks)
                                                 throws XMLFormatException

Generates and returns a Document for the given instance locks

Parameters:

locks -

Returns:

the generated document

Throws:

XMLFormatException

writeInstanceLocksToFile

public void writeInstanceLocksToFile(java.util.Map<java.util.UUID,ProcessModelXMLHelperTools.LockDescription> locks,
                                     java.io.File file)
                              throws java.io.IOException,
                                     XMLFormatException

Writes the given instance locks to the specified file.

Parameters:

locks -

file -

Throws:

XMLFormatException

java.io.IOException

getDocumentForEmbeddedTemplateMapping

public org.w3c.dom.Document getDocumentForEmbeddedTemplateMapping(java.util.Map<java.util.UUID,java.util.UUID> mapping)
                                                           throws XMLFormatException

Generates and returns a Document representing the given embedded template id mapping

Parameters:

mapping - - the embedded IDs mapping to their parent IDs

Returns:

the generated document

Throws:

XMLFormatException

writeEmbeddedTemplateMappingToFile

public void writeEmbeddedTemplateMappingToFile(java.util.Map<java.util.UUID,java.util.UUID> mapping,
                                               java.io.File file)
                                        throws java.io.IOException,
                                               XMLFormatException

Writes the given embedded template id mapping to the specified file.

Parameters:

mapping - - the embedded IDs mapping to their parent ones

file -

Throws:

XMLFormatException

java.io.IOException

getDocumentForBaseTemplateMapping

public org.w3c.dom.Document getDocumentForBaseTemplateMapping(java.util.Map<java.util.UUID,java.util.UUID> mapping)
                                                       throws XMLFormatException

Generates and returns a Document representing the given base template id mapping

Parameters:

mapping - - the template IDs mapping to their base template IDs

Returns:

the generated document

Throws:

XMLFormatException

writeBaseTemplateMappingToFile

public void writeBaseTemplateMappingToFile(java.util.Map<java.util.UUID,java.util.UUID> mapping,
                                           java.io.File file)
                                    throws java.io.IOException,
                                           XMLFormatException

Writes the given base template id mapping to the specified file.

Parameters:

mapping - - the template IDs mapping to their base template IDs

file -

Throws:

XMLFormatException

java.io.IOException

getDocumentForAdhocTemplateMapping

public org.w3c.dom.Document getDocumentForAdhocTemplateMapping(java.util.Map<java.util.UUID,java.util.UUID> mapping)
                                                        throws XMLFormatException

Generates and returns a Document representing the given adhoc template id mapping

Parameters:

mapping - - the adhoc template IDs mapping to their instance IDs

Returns:

the generated document

Throws:

XMLFormatException

writeAdhocTemplateMappingToFile

public void writeAdhocTemplateMappingToFile(java.util.Map<java.util.UUID,java.util.UUID> mapping,
                                            java.io.File file)
                                     throws java.io.IOException,
                                            XMLFormatException

Writes the given adhoc template id mapping to the specified file.

Parameters:

mapping - - the adhoc template IDs mapping to their instance IDs

file -

Throws:

XMLFormatException

java.io.IOException

getDocumentForProcessTypes

public org.w3c.dom.Document getDocumentForProcessTypes(java.util.Set<ProcessModelXMLHelperTools.SerialisableProcessType> items)
                                                throws XMLFormatException

Generates and returns a Document representing the given ProcessTypes

Parameters:

items - The process types

Returns:

the generated document

Throws:

XMLFormatException

writeProcessTypesToFile

public void writeProcessTypesToFile(java.util.Set<ProcessModelXMLHelperTools.SerialisableProcessType> items,
                                    java.io.File file)
                             throws java.io.IOException,
                                    XMLFormatException

Writes the given adhoc template id mapping to the specified file.

Parameters:

items - The process types to be stored

file -

Throws:

XMLFormatException

java.io.IOException

getDocumentForTemplateInformations

public org.w3c.dom.Document getDocumentForTemplateInformations(java.util.Map<java.util.UUID,ProcessModelXMLHelperTools.TemplateInformation> items)
                                                        throws XMLFormatException

Generates and returns a Document representing the given TemplateInformations.

Parameters:

items - maps from ID of template to its information

Returns:

the generated document

Throws:

XMLFormatException

writeTemplateInformationsToFile

public void writeTemplateInformationsToFile(java.util.Map<java.util.UUID,ProcessModelXMLHelperTools.TemplateInformation> items,
                                            java.io.File file)
                                     throws java.io.IOException,
                                            XMLFormatException

Writes the given template informations to the specified file.

Parameters:

items - maps from if of template to its template information.

file -

Throws:

XMLFormatException

java.io.IOException