de.aristaflow.adept2.model.processmodel.xml (AristaFlow Business Process Platform API)

Class Summary
Class	Description
CodeDescriptorComparator	This comparator can be used to compare code descriptors.
ProcessModelXMLConstants	Constants concerning XML, e.g. tag-names, namespaces.
ProcessModelXMLExport	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).
ProcessModelXMLExportTools	Helper methods for the XML export of process model classes, i.e. methods to create single xml element objects.
ProcessModelXMLHelperTools	Contains important functions for both, XML import and export.
ProcessModelXMLHelperTools.LockDescription	This class describes a lock, e.g. a lock on a template.
ProcessModelXMLHelperTools.SerialisableProcessType	A lightweight data container for serialising process types without a template proxy.
ProcessModelXMLHelperTools.TemplateInformation	A lightweight data container for serialising process types without a template proxy.
ProcessModelXMLImport	Import templates and instances from XML.
ProcessModelXMLImportTools	All helper methods for the XML import of process model classes, i.e. mainly parsing elements into objects.

Enum Summary
Enum Description

ProcessModelXMLConstants.SchemaType
This enum is used for the different schema types.

Enum Summary
Enum	Description
ProcessModelXMLConstants.SchemaType	This enum is used for the different schema types.

Package de.aristaflow.adept2.model.processmodel.xml Description

The xml packages provides a generic import and export functionality for all components implementing the common ADEPT2 processmodel interfaces and just requires an implementation of the ProcessModelFactory.

Additional Notes

File names

Import and export do not care about file names and file extensions. However, some other components (e.g. an editor) may expect the following naming conventions:

Templates have an .template extension
Instances have an .instance extension

Additional information

The exported document, e.g. for a template, may hold more information than just for the template. E.g. it is possible to store the TemplateStatus information within the same template file, but Template itself does not hold a reference to this information!

For these cases, import and export offer several methods to either store all this information in one file (requires e.g. a Template and a TemplateStatus object as parameter), or load specific information from the same document (e.g. one method to load a Template object from an XML file, another method to load a TemplateStatus object from the same file).

Import

The XML import requires an implementation of the process model factory.

Export

XML and XML Schema files

The XSD files are within the same package like the classes for importing and exporting from / to XML. Namespaces
The data model and the histories use different namespaces:

Data model: http://www.aristaflow.de/adept2/processmodel
Histories: http://www.aristaflow.de/adept2/processmodel.histories

Examples

Example files are included in the doc-files directory of the API documentation: