de.aristaflow.adept2.model.processmodel.xml

Class ProcessModelXMLImport

java.lang.Object

de.aristaflow.adept2.model.processmodel.xml.ProcessModelXMLImport

All Implemented Interfaces:

org.xml.sax.ErrorHandler

public class ProcessModelXMLImport
extends java.lang.Object
implements org.xml.sax.ErrorHandler

Import templates and instances from XML. The XML constructs a process using the ProcessModelFactory. TODO Validate the Document in getTemplateFromDocument using the Validator.

Author:

Kevin Goeser, Patrick Schmidt

See Also:

ProcessModelFactory

Field Summary

Fields

Modifier and Type	Field and Description
protected java.util.logging.Logger	logger The logger for XML imports.

Constructor Summary

Constructors

Constructor and Description
ProcessModelXMLImport(ProcessModelFactory factory) Constructor, requiring the factory to use.

Method Summary

Modifier and Type	Method and Description
void	error(org.xml.sax.SAXParseException spe)
void	fatalError(org.xml.sax.SAXParseException spe)
static java.util.Map<java.util.UUID,java.util.UUID>	getAdhocTemplateMappingFromFile(java.io.File file) Fetches the adhoc template ID mappings stored in the specified file.
static java.util.Map<java.util.UUID,java.util.UUID>	getBaseTemplateMappingFromFile(java.io.File file) Fetches the base template ID mappings stored in the specified file.
ExecutableBusinessProcess	getEBPForDocument(org.w3c.dom.Document document) Retrieves the corresponding ExecutableBusinessProcess
static java.util.Map<java.util.UUID,java.util.UUID>	getEmbeddedTemplateMappingFromFile(java.io.File file) Fetches the embedded template ID mappings stored in the specified file.
ExecutableInstance	getExecutableInstanceFromDocument(ExecutionFactory executionFactory, org.w3c.dom.Document document, Template template) Creates an instance using the given DOM document.
ExecutableInstance	getExecutableInstanceFromFile(ExecutionFactory executionFactory, java.io.File file) Reads a process instance from the given file and determines the file type.
ExecutableInstance	getExecutableInstanceFromFile(ExecutionFactory executionFactory, java.io.File file, Template template) Reads a process instance from the given file and determines the file type.
ExecutableInstance	getExecutableInstanceFromStream(ExecutionFactory executionFactory, java.io.InputStream stream, Template template) Reads a process instance from the designated input stream.
Instance	getInstanceFromDocument(org.w3c.dom.Document document, Template template) Creates an instance using the given DOM document.
Instance	getInstanceFromFile(java.io.File file) Reads a process instance from the given file and determines the file type.
Instance	getInstanceFromFile(java.io.File file, Template template) Reads a process instance from the given file and determines the file type.
Instance	getInstanceFromStream(java.io.InputStream inputStream) Reads a process instance from an input stream.
static java.util.Map<java.util.UUID,ProcessModelXMLHelperTools.LockDescription>	getInstanceLocksFromFile(java.io.File file) Fetches the current locks stored in the specified file.
InstanceStatus	getInstanceStatusFromInstanceDocument(org.w3c.dom.Document document) Reads a process instance status from the given.
InstanceStatus	getInstanceStatusFromInstanceFile(java.io.File file) Reads a process instance status from the given.
boolean	getIsModifiedFromInstanceDocument(org.w3c.dom.Document document) Returns the state of the isModified attribute in the given document of an instance.
ProcessModelParameter	getParameterForDocument(org.w3c.dom.Document document) Retrieves the Corresponding parameter
java.util.Set<ProcessModelParameter>	getParameterSetForDocument(org.w3c.dom.Document document) Retrieves the corresponding set of Parameter
static java.util.Set<ProcessModelXMLHelperTools.SerialisableProcessType>	getProcessTypesFromFile(java.io.File file) Fetches the process types stored in the specified file.
Template	getTemplateFromDocument(org.w3c.dom.Document document) Creates a template using the given DOM document.
Template	getTemplateFromFile(java.io.File file) Reads a process template from the given file and determines the file type.
Template	getTemplateFromStream(java.io.InputStream inputStream) Reads a process template from an input stream.
java.util.UUID	getTemplateIDFromInstanceDocument(org.w3c.dom.Document document) Returns the template ID stored in the given document
java.util.UUID	getTemplateIDFromInstanceFile(java.io.File file) Reads a process instance from the given file and determines the file type.
static java.util.Map<java.util.UUID,ProcessModelXMLHelperTools.TemplateInformation>	getTemplateInformationsFromFile(java.io.File file) Fetches the template informations stored in the specified file.
static java.util.Map<java.util.UUID,ProcessModelXMLHelperTools.LockDescription>	getTemplateLocksFromFile(java.io.File file) Fetches the current locks stored in the specified file.
TemplateStatus	getTemplateStatusFromDocument(org.w3c.dom.Document document) Returns a template status object from the given template document.
TemplateStatus	getTemplateStatusFromStream(java.io.InputStream inputStream) Reads the template status from the given template file.
TemplateStatus	getTemplateStatusFromTemplateFile(java.io.File file) Reads the template status from the given template file.
boolean	instanceStatusDatePresent(org.w3c.dom.Document doc) Gets whether the designated document contains an instance status with a migration (and execution) status date.
static void	validateInstanceFormatVersion(org.w3c.dom.Document instance) Validates the format version of the given instance document.
static void	validateTemplateFormatVersion(org.w3c.dom.Document template) Validates the format version of the given template document.
void	warning(org.xml.sax.SAXParseException spe)

Methods inherited from class java.lang.Object

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

Field Detail

logger

protected final java.util.logging.Logger logger

The logger for XML imports. It is protected for extensibility.

Constructor Detail

ProcessModelXMLImport

public ProcessModelXMLImport(ProcessModelFactory factory)

Constructor, requiring the factory to use.

Parameters:

factory - the factory, that shall be used by the importer to create the objects of the processModel

Method Detail

getTemplateFromFile

public Template getTemplateFromFile(java.io.File file)
                             throws VersionException,
                                    XMLFormatException,
                                    java.io.IOException

Reads a process template from the given file and determines the file type. This will parse the file two times: First to recognise the file type, then to actually parse and validate the file.

Parameters:

file - The file which will be parsed

Returns:

A Template

Throws:

VersionException - if the format version of the template file is not or no longer supported

XMLFormatException - if the document is not well-formed the input file does not contain a valid template

java.io.FileNotFoundException - if the file does not exist or can't be opened

java.io.IOException - if error occurs while reading from the file

getTemplateStatusFromTemplateFile

public TemplateStatus getTemplateStatusFromTemplateFile(java.io.File file)
                                                 throws VersionException,
                                                        XMLFormatException,
                                                        java.io.IOException

Reads the template status from the given template file. Note: the file must contain a template including a template status element.

Parameters:

file - The file which will be parsed

Returns:

A TemplateStatus

Throws:

VersionException - if the format version of the template file is not or no longer supported

XMLFormatException - if the document is not well-formed the input file does not contain a valid template

java.io.FileNotFoundException - if the file does not exist or can't be opened

java.io.IOException - if error occurs while reading from the file

getInstanceFromFile

public Instance getInstanceFromFile(java.io.File file)
                             throws VersionException,
                                    XMLFormatException,
                                    java.io.IOException

Reads a process instance from the given file and determines the file type. This will parse the file two times: First to recognise the file type, then to actually parse and validate the file.

Parameters:

file - The file which will be parsed

Returns:

An Instance

Throws:

VersionException - if the format version of the instance file is not or no longer supported

XMLFormatException - if the document is not well-formed the input file does not contain a valid instance

java.io.FileNotFoundException - if the file does not exist or can't be opened

java.io.IOException - if error occurs while reading from the file

getExecutableInstanceFromFile

public ExecutableInstance getExecutableInstanceFromFile(ExecutionFactory executionFactory,
                                                        java.io.File file)
                                                 throws VersionException,
                                                        XMLFormatException,
                                                        java.io.IOException

Reads a process instance from the given file and determines the file type. This will parse the file two times: First to recognise the file type, then to actually parse and validate the file.

Parameters:

executionFactory - The execution factory needed for the creation of the executable instance.

file - The file which will be parsed

Returns:

An ExecutableInstance

Throws:

VersionException - if the format version of the instance file is not or no longer supported

XMLFormatException - if the document is not well-formed the input file does not contain a valid instance

java.io.FileNotFoundException - if the file does not exist or can't be opened

java.io.IOException - if error occurs while reading from the file

getInstanceFromFile

public Instance getInstanceFromFile(java.io.File file,
                                    Template template)
                             throws VersionException,
                                    XMLFormatException,
                                    java.io.IOException

Reads a process instance from the given file and determines the file type. This will parse the file two times: First to recognise the file type, then to actually parse and validate the file.

Parameters:

file - The file which will be parsed

template - The template object to use in the instance object.

Returns:

An Instance

Throws:

VersionException - if the format version of the instance file is not or no longer supported

XMLFormatException - if the document is not well-formed the input file does not contain a valid instance

java.io.FileNotFoundException - if the file does not exist or can't be opened

java.io.IOException - if error occurs while reading from the file

getExecutableInstanceFromStream

public ExecutableInstance getExecutableInstanceFromStream(ExecutionFactory executionFactory,
                                                          java.io.InputStream stream,
                                                          Template template)
                                                   throws VersionException,
                                                          XMLFormatException,
                                                          java.io.IOException

Reads a process instance from the designated input stream.

Parameters:

executionFactory - The execution factory needed for the creation of the executable instance.

stream - The stream from which to read the XML.

template - The template object to use in the instance object.

Returns:

An ExecutableInstance

Throws:

VersionException - if the format version of the instance is not or no longer supported.

XMLFormatException - if the document is not well-formed the input stream does not contain a valid instance.

java.io.IOException - if error occurs while reading from the stream.

getExecutableInstanceFromFile

public ExecutableInstance getExecutableInstanceFromFile(ExecutionFactory executionFactory,
                                                        java.io.File file,
                                                        Template template)
                                                 throws VersionException,
                                                        XMLFormatException,
                                                        java.io.IOException

Reads a process instance from the given file and determines the file type. This will parse the file two times: First to recognise the file type, then to actually parse and validate the file.

Parameters:

executionFactory - The execution factory needed for the creation of the executable instance.

file - The file which will be parsed.

template - The template object to use in the instance object.

Returns:

An ExecutableInstance

Throws:

VersionException - if the format version of the instance file is not or no longer supported

XMLFormatException - if the document is not well-formed the input file does not contain a valid instance

java.io.FileNotFoundException - if the file does not exist or can't be opened

java.io.IOException - if error occurs while reading from the file

getTemplateIDFromInstanceFile

public java.util.UUID getTemplateIDFromInstanceFile(java.io.File file)
                                             throws VersionException,
                                                    XMLFormatException,
                                                    java.io.IOException

Reads a process instance from the given file and determines the file type. This will parse the file two times: First to recognise the file type, then to actually parse and validate the file.

Parameters:

file - The file which will be parsed

Returns:

An Instance

Throws:

VersionException - if the format version of the instance file is not or no longer supported

XMLFormatException - if the document is not well-formed the input file does not contain a valid instance

java.io.FileNotFoundException - if the file does not exist or can't be opened

java.io.IOException - if error occurs while reading from the file

getInstanceStatusFromInstanceFile

public InstanceStatus getInstanceStatusFromInstanceFile(java.io.File file)
                                                 throws VersionException,
                                                        XMLFormatException,
                                                        java.io.IOException

Reads a process instance status from the given.

Parameters:

file - The file which will be parsed

Returns:

An Instance

Throws:

VersionException - if the format version of the instance file is not or no longer supported

XMLFormatException - if the document is not well-formed the input file does not contain a valid instance

java.io.FileNotFoundException - if the file does not exist or can't be opened

java.io.IOException - if error occurs while reading from the file

getInstanceStatusFromInstanceDocument

public InstanceStatus getInstanceStatusFromInstanceDocument(org.w3c.dom.Document document)
                                                     throws VersionException,
                                                            XMLFormatException

Reads a process instance status from the given.

Parameters:

document - The (instance) document containing the instanceStatus

Returns:

An Instance

Throws:

VersionException - if the format version of the instance file is not or no longer supported

XMLFormatException - if the document is not well-formed the input file does not contain a valid instance

instanceStatusDatePresent

public boolean instanceStatusDatePresent(org.w3c.dom.Document doc)

Gets whether the designated document contains an instance status with a migration (and execution) status date.

Parameters:

doc - The document which to check for whether it contains an instance status with migration (and execution) status date.

Returns:

Whether the designated document contains an instance migration (and execution) status date.

getTemplateFromStream

public Template getTemplateFromStream(java.io.InputStream inputStream)
                               throws VersionException,
                                      XMLFormatException,
                                      java.io.IOException

Reads a process template from an input stream.

Parameters:

inputStream -

Returns:

the template

Throws:

VersionException - if the format version of the template stream is not or no longer supported

XMLFormatException - if the document is not well-formed the input stream does not contain a valid template

java.io.IOException - if error occurs while reading from the stream

getTemplateStatusFromStream

public TemplateStatus getTemplateStatusFromStream(java.io.InputStream inputStream)
                                           throws VersionException,
                                                  XMLFormatException,
                                                  java.io.IOException

Reads the template status from the given template file. Note: the file must contain a template including a template status element.

Parameters:

inputStream - The input stream that will be parsed

Returns:

A TemplateStatus

Throws:

VersionException - if the format version of the template file is not or no longer supported

XMLFormatException - if the document is not well-formed the input file does not contain a valid template

java.io.FileNotFoundException - if the file does not exist or can't be opened

java.io.IOException - if error occurs while reading from the file

java.lang.IllegalArgumentException - If the XML in the stream does not contain a template status.

getTemplateStatusFromDocument

public TemplateStatus getTemplateStatusFromDocument(org.w3c.dom.Document document)

Returns a template status object from the given template document.

Parameters:

document - An XML document.

Returns:

A template status element.

getInstanceFromStream

public Instance getInstanceFromStream(java.io.InputStream inputStream)
                               throws VersionException,
                                      XMLFormatException,
                                      java.io.IOException

Reads a process instance from an input stream.

Parameters:

inputStream -

Returns:

the process

Throws:

VersionException - if the format version of the instance stream is not or no longer supported

XMLFormatException - if the document is not well-formed the input stream does not contain a valid instance

java.io.IOException - if error occurs while reading from the stream

getTemplateFromDocument

public Template getTemplateFromDocument(org.w3c.dom.Document document)
                                 throws java.io.IOException

Creates a template using the given DOM document. This method does not verify that the passed document is really a template.

Parameters:

document -

Returns:

The parsed Template.

Throws:

java.io.IOException - If there are problems decoding an EBP component signature from Base64, an IOException will be thrown.

getInstanceFromDocument

public Instance getInstanceFromDocument(org.w3c.dom.Document document,
                                        Template template)
                                 throws java.io.IOException

Creates an instance using the given DOM document.

Parameters:

document -

template - The template to be used as structure, or null if the structure is stored inline.

Returns:

The parsed Instance.

Throws:

java.io.IOException - If there are problems decoding an EBP component signature from Base64, an IOException will be thrown.

getExecutableInstanceFromDocument

public ExecutableInstance getExecutableInstanceFromDocument(ExecutionFactory executionFactory,
                                                            org.w3c.dom.Document document,
                                                            Template template)
                                                     throws java.io.IOException

Creates an instance using the given DOM document.

Parameters:

document -

template - The template to be used as structure, or null if the structure is stored inline.

executionFactory - The execution factory needed for the creation of the executable instance.

Returns:

The parsed ExecutableInstance.

Throws:

java.io.IOException - If there are problems decoding an EBP component signature from Base64, an IOException will be thrown.

getTemplateIDFromInstanceDocument

public java.util.UUID getTemplateIDFromInstanceDocument(org.w3c.dom.Document document)

Returns the template ID stored in the given document

Parameters:

document -

Returns:

The parsed UUID of the template.

getIsModifiedFromInstanceDocument

public boolean getIsModifiedFromInstanceDocument(org.w3c.dom.Document document)

Returns the state of the isModified attribute in the given document of an instance.

Parameters:

document -

Returns:

True if the instance has already been modified.

validateTemplateFormatVersion

public static void validateTemplateFormatVersion(org.w3c.dom.Document template)
                                          throws VersionException

Validates the format version of the given template document. Throws a VersionException if the format version is not or no longer supported.

Parameters:

template - the template document to be tested

Throws:

VersionException - if the format version is not supported

validateInstanceFormatVersion

public static void validateInstanceFormatVersion(org.w3c.dom.Document instance)
                                          throws VersionException

Validates the format version of the given instance document. Throws a VersionException if the format version is not or no longer supported.

Parameters:

instance - the instance document to be tested

Throws:

VersionException - if the format version is not supported

getEBPForDocument

public ExecutableBusinessProcess getEBPForDocument(org.w3c.dom.Document document)
                                            throws java.io.IOException

Retrieves the corresponding ExecutableBusinessProcess

Parameters:

document - The document, for which the EBP is needed

Returns:

The EBP in the given document

Throws:

java.io.IOException - If there are problems decoding the component signature from Base64, an IOException will be thrown.

getParameterForDocument

public ProcessModelParameter getParameterForDocument(org.w3c.dom.Document document)

Retrieves the Corresponding parameter

Parameters:

document - The document, for which the parameter are needed

Returns:

The parameter in the given document

getParameterSetForDocument

public java.util.Set<ProcessModelParameter> getParameterSetForDocument(org.w3c.dom.Document document)

Retrieves the corresponding set of Parameter

Parameters:

document -

Returns:

The parameter in the given document

getTemplateLocksFromFile

public static java.util.Map<java.util.UUID,ProcessModelXMLHelperTools.LockDescription> getTemplateLocksFromFile(java.io.File file)
                                                                                                         throws java.io.FileNotFoundException,
                                                                                                                XMLFormatException,
                                                                                                                java.io.IOException,
                                                                                                                VersionException

Fetches the current locks stored in the specified file.

Parameters:

file - File to load

Returns:

a map from UUID of template to LockDescription object with locking agent and lockCount

Throws:

java.io.IOException

XMLFormatException

java.io.FileNotFoundException

VersionException - is thrown if the version of the file is not correct

getInstanceLocksFromFile

public static java.util.Map<java.util.UUID,ProcessModelXMLHelperTools.LockDescription> getInstanceLocksFromFile(java.io.File file)
                                                                                                         throws java.io.FileNotFoundException,
                                                                                                                XMLFormatException,
                                                                                                                java.io.IOException,
                                                                                                                VersionException

Fetches the current locks stored in the specified file.

Parameters:

file - File to load

Returns:

a map from UUID of instance to LockDescription object with locking agent and lockCount

Throws:

java.io.IOException

XMLFormatException

java.io.FileNotFoundException

VersionException - is thrown if the version of the file is not correct

getEmbeddedTemplateMappingFromFile

public static java.util.Map<java.util.UUID,java.util.UUID> getEmbeddedTemplateMappingFromFile(java.io.File file)
                                                                                       throws java.io.FileNotFoundException,
                                                                                              XMLFormatException,
                                                                                              java.io.IOException,
                                                                                              VersionException

Fetches the embedded template ID mappings stored in the specified file.

Parameters:

file - File to load

Returns:

a map from ID of the embedded to the parents ID

Throws:

java.io.IOException

XMLFormatException

java.io.FileNotFoundException

VersionException - is thrown if the version of the file is not correct

getBaseTemplateMappingFromFile

public static java.util.Map<java.util.UUID,java.util.UUID> getBaseTemplateMappingFromFile(java.io.File file)
                                                                                   throws java.io.FileNotFoundException,
                                                                                          XMLFormatException,
                                                                                          java.io.IOException,
                                                                                          VersionException

Fetches the base template ID mappings stored in the specified file.

Parameters:

file - File to load

Returns:

a map from template ID to the base template ID

Throws:

java.io.IOException

XMLFormatException

java.io.FileNotFoundException

VersionException - is thrown if the version of the file is not correct

getProcessTypesFromFile

public static java.util.Set<ProcessModelXMLHelperTools.SerialisableProcessType> getProcessTypesFromFile(java.io.File file)
                                                                                                 throws java.io.FileNotFoundException,
                                                                                                        XMLFormatException,
                                                                                                        java.io.IOException,
                                                                                                        VersionException

Fetches the process types stored in the specified file.

Parameters:

file - File to load

Returns:

a set of the process types

Throws:

java.io.IOException

XMLFormatException

java.io.FileNotFoundException

VersionException - is thrown if the version of the file is not correct

getAdhocTemplateMappingFromFile

public static java.util.Map<java.util.UUID,java.util.UUID> getAdhocTemplateMappingFromFile(java.io.File file)
                                                                                    throws java.io.FileNotFoundException,
                                                                                           XMLFormatException,
                                                                                           java.io.IOException,
                                                                                           VersionException

Fetches the adhoc template ID mappings stored in the specified file.

Parameters:

file - File to load

Returns:

a map from adhoc template ID to the instance ID

Throws:

java.io.IOException

XMLFormatException

java.io.FileNotFoundException

VersionException - is thrown if the version of the file is not correct

getTemplateInformationsFromFile

public static java.util.Map<java.util.UUID,ProcessModelXMLHelperTools.TemplateInformation> getTemplateInformationsFromFile(java.io.File file)
                                                                                                                    throws java.io.FileNotFoundException,
                                                                                                                           XMLFormatException,
                                                                                                                           java.io.IOException,
                                                                                                                           VersionException

Fetches the template informations stored in the specified file.

Parameters:

file - File to load

Returns:

a map from template id to its template information

Throws:

java.io.IOException

XMLFormatException

java.io.FileNotFoundException

VersionException - is thrown if the version of the file is not correct

error

public void error(org.xml.sax.SAXParseException spe)
           throws org.xml.sax.SAXException

Specified by:

error in interface org.xml.sax.ErrorHandler

Throws:

org.xml.sax.SAXException

fatalError

public void fatalError(org.xml.sax.SAXParseException spe)
                throws org.xml.sax.SAXException

Specified by:

fatalError in interface org.xml.sax.ErrorHandler

Throws:

org.xml.sax.SAXException

warning

public void warning(org.xml.sax.SAXParseException spe)
             throws org.xml.sax.SAXException

Specified by:

warning in interface org.xml.sax.ErrorHandler

Throws:

org.xml.sax.SAXException