org.activiti.bpmn.converter

Class BaseBpmnXMLConverter

java.lang.Object

org.activiti.bpmn.converter.BaseBpmnXMLConverter

All Implemented Interfaces:

BpmnXMLConstants

Direct Known Subclasses:

AssociationXMLConverter, BoundaryEventXMLConverter, BusinessRuleTaskXMLConverter, CallActivityXMLConverter, CatchEventXMLConverter, ComplexGatewayXMLConverter, DataStoreReferenceXMLConverter, EndEventXMLConverter, EventGatewayXMLConverter, ExclusiveGatewayXMLConverter, InclusiveGatewayXMLConverter, ManualTaskXMLConverter, ParallelGatewayXMLConverter, ReceiveTaskXMLConverter, ScriptTaskXMLConverter, SendTaskXMLConverter, SequenceFlowXMLConverter, ServiceTaskXMLConverter, StartEventXMLConverter, TaskXMLConverter, TextAnnotationXMLConverter, ThrowEventXMLConverter, UserTaskXMLConverter, ValuedDataObjectXMLConverter

public abstract class BaseBpmnXMLConverter
extends Object
implements BpmnXMLConstants

Author:

Tijs Rademakers, Joram Barrez

Field Summary

Fields

Modifier and Type	Field and Description
protected static List<ExtensionAttribute>	defaultActivityAttributes
protected static List<ExtensionAttribute>	defaultElementAttributes
protected static org.slf4j.Logger	LOGGER

Fields inherited from interface org.activiti.bpmn.constants.BpmnXMLConstants

ACTIVITI_EXTENSIONS_NAMESPACE, ACTIVITI_EXTENSIONS_PREFIX, ALFRESCO_TYPE, ATTRIBUTE_ACTIVITY_ASYNCHRONOUS, ATTRIBUTE_ACTIVITY_EXCLUSIVE, ATTRIBUTE_ACTIVITY_ISFORCOMPENSATION, ATTRIBUTE_BOUNDARY_ATTACHEDTOREF, ATTRIBUTE_BOUNDARY_CANCELACTIVITY, ATTRIBUTE_CALL_ACTIVITY_CALLEDELEMENT, ATTRIBUTE_COMPENSATE_ACTIVITYREF, ATTRIBUTE_COMPENSATE_WAITFORCOMPLETION, ATTRIBUTE_DATA_ID, ATTRIBUTE_DATA_ITEM_REF, ATTRIBUTE_DATA_NAME, ATTRIBUTE_DATA_STORE_REF, ATTRIBUTE_DEFAULT, ATTRIBUTE_DI_BPMNELEMENT, ATTRIBUTE_DI_HEIGHT, ATTRIBUTE_DI_IS_EXPANDED, ATTRIBUTE_DI_WIDTH, ATTRIBUTE_DI_X, ATTRIBUTE_DI_Y, ATTRIBUTE_END_DATE, ATTRIBUTE_ERROR_CODE, ATTRIBUTE_ERROR_REF, ATTRIBUTE_EVENT_START_INITIATOR, ATTRIBUTE_FIELD_EXPRESSION, ATTRIBUTE_FIELD_NAME, ATTRIBUTE_FIELD_STRING, ATTRIBUTE_FLOW_SKIP_EXPRESSION, ATTRIBUTE_FLOW_SOURCE_REF, ATTRIBUTE_FLOW_TARGET_REF, ATTRIBUTE_FORM_DATEPATTERN, ATTRIBUTE_FORM_DEFAULT, ATTRIBUTE_FORM_EXPRESSION, ATTRIBUTE_FORM_FORMKEY, ATTRIBUTE_FORM_ID, ATTRIBUTE_FORM_NAME, ATTRIBUTE_FORM_READABLE, ATTRIBUTE_FORM_REQUIRED, ATTRIBUTE_FORM_TYPE, ATTRIBUTE_FORM_VARIABLE, ATTRIBUTE_FORM_WRITABLE, ATTRIBUTE_ID, ATTRIBUTE_IMPLEMENTATION_REF, ATTRIBUTE_IMPORT_TYPE, ATTRIBUTE_IOPARAMETER_SOURCE, ATTRIBUTE_IOPARAMETER_SOURCE_EXPRESSION, ATTRIBUTE_IOPARAMETER_TARGET, ATTRIBUTE_ITEM_KIND, ATTRIBUTE_ITEM_REF, ATTRIBUTE_ITEM_SUBJECT_REF, ATTRIBUTE_LISTENER_CLASS, ATTRIBUTE_LISTENER_DELEGATEEXPRESSION, ATTRIBUTE_LISTENER_ENTITY_TYPE, ATTRIBUTE_LISTENER_EVENT, ATTRIBUTE_LISTENER_EVENTS, ATTRIBUTE_LISTENER_EXPRESSION, ATTRIBUTE_LISTENER_THROW_ERROR_EVENT_CODE, ATTRIBUTE_LISTENER_THROW_EVENT_TYPE, ATTRIBUTE_LISTENER_THROW_EVENT_TYPE_ERROR, ATTRIBUTE_LISTENER_THROW_EVENT_TYPE_GLOBAL_SIGNAL, ATTRIBUTE_LISTENER_THROW_EVENT_TYPE_MESSAGE, ATTRIBUTE_LISTENER_THROW_EVENT_TYPE_SIGNAL, ATTRIBUTE_LISTENER_THROW_MESSAGE_EVENT_NAME, ATTRIBUTE_LISTENER_THROW_SIGNAL_EVENT_NAME, ATTRIBUTE_LOCATION, ATTRIBUTE_MESSAGE_REF, ATTRIBUTE_MULTIINSTANCE_COLLECTION, ATTRIBUTE_MULTIINSTANCE_INDEX_VARIABLE, ATTRIBUTE_MULTIINSTANCE_SEQUENTIAL, ATTRIBUTE_MULTIINSTANCE_VARIABLE, ATTRIBUTE_NAME, ATTRIBUTE_NAMESPACE, ATTRIBUTE_PROCESS_CANDIDATE_GROUPS, ATTRIBUTE_PROCESS_CANDIDATE_USERS, ATTRIBUTE_PROCESS_EXECUTABLE, ATTRIBUTE_PROCESS_REF, ATTRIBUTE_SCOPE, ATTRIBUTE_SIGNAL_REF, ATTRIBUTE_STRUCTURE_REF, ATTRIBUTE_TASK_IMPLEMENTATION, ATTRIBUTE_TASK_OPERATION_REF, ATTRIBUTE_TASK_RULE_CLASS, ATTRIBUTE_TASK_RULE_EXCLUDE, ATTRIBUTE_TASK_RULE_RESULT_VARIABLE, ATTRIBUTE_TASK_RULE_RULES, ATTRIBUTE_TASK_RULE_VARIABLES_INPUT, ATTRIBUTE_TASK_SCRIPT_AUTO_STORE_VARIABLE, ATTRIBUTE_TASK_SCRIPT_FORMAT, ATTRIBUTE_TASK_SCRIPT_RESULTVARIABLE, ATTRIBUTE_TASK_SCRIPT_TEXT, ATTRIBUTE_TASK_SERVICE_CLASS, ATTRIBUTE_TASK_SERVICE_DELEGATEEXPRESSION, ATTRIBUTE_TASK_SERVICE_EXPRESSION, ATTRIBUTE_TASK_SERVICE_EXTENSIONID, ATTRIBUTE_TASK_SERVICE_RESULTVARIABLE, ATTRIBUTE_TASK_SERVICE_SKIP_EXPRESSION, ATTRIBUTE_TASK_USER_ASSIGNEE, ATTRIBUTE_TASK_USER_CANDIDATEGROUPS, ATTRIBUTE_TASK_USER_CANDIDATEUSERS, ATTRIBUTE_TASK_USER_CATEGORY, ATTRIBUTE_TASK_USER_DUEDATE, ATTRIBUTE_TASK_USER_OWNER, ATTRIBUTE_TASK_USER_PRIORITY, ATTRIBUTE_TASK_USER_SKIP_EXPRESSION, ATTRIBUTE_TERMINATE_ALL, ATTRIBUTE_TEXTFORMAT, ATTRIBUTE_TIMER_CYCLE, ATTRIBUTE_TIMER_DATE, ATTRIBUTE_TIMER_DURATION, ATTRIBUTE_TRIGGERED_BY, ATTRIBUTE_TYPE, ATTRIBUTE_VALUE_FALSE, ATTRIBUTE_VALUE_TRUE, BPMN2_NAMESPACE, BPMNDI_NAMESPACE, BPMNDI_PREFIX, ELEMENT_ASSIGNMENT, ELEMENT_ASSOCIATION, ELEMENT_CALL_ACTIVITY, ELEMENT_CALL_ACTIVITY_IN_PARAMETERS, ELEMENT_CALL_ACTIVITY_OUT_PARAMETERS, ELEMENT_COLLABORATION, ELEMENT_CUSTOM_RESOURCE, ELEMENT_DATA_INPUT, ELEMENT_DATA_INPUT_REFS, ELEMENT_DATA_OBJECT, ELEMENT_DATA_OUTPUT, ELEMENT_DATA_OUTPUT_REFS, ELEMENT_DATA_STATE, ELEMENT_DATA_STORE, ELEMENT_DATA_STORE_REFERENCE, ELEMENT_DATA_VALUE, ELEMENT_DEFINITIONS, ELEMENT_DI_BOUNDS, ELEMENT_DI_DIAGRAM, ELEMENT_DI_EDGE, ELEMENT_DI_LABEL, ELEMENT_DI_PLANE, ELEMENT_DI_SHAPE, ELEMENT_DI_WAYPOINT, ELEMENT_DOCUMENTATION, ELEMENT_ERROR, ELEMENT_EVENT_BOUNDARY, ELEMENT_EVENT_CANCELDEFINITION, ELEMENT_EVENT_CATCH, ELEMENT_EVENT_COMPENSATEDEFINITION, ELEMENT_EVENT_END, ELEMENT_EVENT_ERRORDEFINITION, ELEMENT_EVENT_LISTENER, ELEMENT_EVENT_MESSAGEDEFINITION, ELEMENT_EVENT_SIGNALDEFINITION, ELEMENT_EVENT_START, ELEMENT_EVENT_TERMINATEDEFINITION, ELEMENT_EVENT_THROW, ELEMENT_EVENT_TIMERDEFINITION, ELEMENT_EXECUTION_LISTENER, ELEMENT_EXTENSIONS, ELEMENT_FIELD, ELEMENT_FIELD_STRING, ELEMENT_FLOW_CONDITION, ELEMENT_FLOWNODE_REF, ELEMENT_FORMAL_EXPRESSION, ELEMENT_FORMPROPERTY, ELEMENT_FROM, ELEMENT_GATEWAY_COMPLEX, ELEMENT_GATEWAY_EVENT, ELEMENT_GATEWAY_EXCLUSIVE, ELEMENT_GATEWAY_INCLUSIVE, ELEMENT_GATEWAY_PARALLEL, ELEMENT_IMPORT, ELEMENT_IN_MESSAGE, ELEMENT_INPUT_ASSOCIATION, ELEMENT_INTERFACE, ELEMENT_IOSPECIFICATION, ELEMENT_ITEM_DEFINITION, ELEMENT_LANE, ELEMENT_LANESET, ELEMENT_MESSAGE, ELEMENT_MESSAGE_FLOW, ELEMENT_MULTIINSTANCE, ELEMENT_MULTIINSTANCE_CARDINALITY, ELEMENT_MULTIINSTANCE_CONDITION, ELEMENT_MULTIINSTANCE_DATAINPUT, ELEMENT_MULTIINSTANCE_DATAITEM, ELEMENT_OPERATION, ELEMENT_OUT_MESSAGE, ELEMENT_OUTPUT_ASSOCIATION, ELEMENT_PARTICIPANT, ELEMENT_POTENTIAL_STARTER, ELEMENT_PROCESS, ELEMENT_RESOURCE, ELEMENT_RESOURCE_ASSIGNMENT, ELEMENT_RESOURCE_REF, ELEMENT_SEQUENCE_FLOW, ELEMENT_SIGNAL, ELEMENT_SOURCE_REF, ELEMENT_SUBPROCESS, ELEMENT_TARGET_REF, ELEMENT_TASK, ELEMENT_TASK_BUSINESSRULE, ELEMENT_TASK_LISTENER, ELEMENT_TASK_MAIL, ELEMENT_TASK_MANUAL, ELEMENT_TASK_RECEIVE, ELEMENT_TASK_SCRIPT, ELEMENT_TASK_SEND, ELEMENT_TASK_SERVICE, ELEMENT_TASK_USER, ELEMENT_TEXT_ANNOTATION, ELEMENT_TEXT_ANNOTATION_TEXT, ELEMENT_TO, ELEMENT_TRANSACTION, ELEMENT_TRANSFORMATION, ELEMENT_VALUE, EXPRESSION_LANGUAGE_ATTRIBUTE, FAILED_JOB_RETRY_TIME_CYCLE, MAP_EXCEPTION, MAP_EXCEPTION_ANDCHILDREN, MAP_EXCEPTION_ERRORCODE, OMGDC_NAMESPACE, OMGDC_PREFIX, OMGDI_NAMESPACE, OMGDI_PREFIX, PROCESS_NAMESPACE, SCHEMA_NAMESPACE, TARGET_NAMESPACE_ATTRIBUTE, TYPE_LANGUAGE_ATTRIBUTE, XPATH_NAMESPACE, XSD_PREFIX, XSI_NAMESPACE, XSI_PREFIX

Constructor Summary

Constructors

Constructor and Description
BaseBpmnXMLConverter()

Method Summary

Methods

Modifier and Type	Method and Description
void	convertToBpmnModel(XMLStreamReader xtr, BpmnModel model, Process activeProcess, List<SubProcess> activeSubProcessList)
protected String	convertToDelimitedString(List<String> stringList)
void	convertToXML(XMLStreamWriter xtw, BaseElement baseElement, BpmnModel model)
protected abstract BaseElement	convertXMLToElement(XMLStreamReader xtr, BpmnModel model)
protected abstract Class<? extends BaseElement>	getBpmnElementType()
protected abstract String	getXMLElementName()
protected boolean	parseAsync(XMLStreamReader xtr)
protected void	parseChildElements(String elementName, BaseElement parentElement, BpmnModel model, XMLStreamReader xtr)
protected void	parseChildElements(String elementName, BaseElement parentElement, Map<String,BaseChildElementParser> additionalParsers, BpmnModel model, XMLStreamReader xtr)
protected List<String>	parseDelimitedList(String expression)
protected ExtensionElement	parseExtensionElement(XMLStreamReader xtr)
protected boolean	parseForCompensation(XMLStreamReader xtr)
protected boolean	parseNotExclusive(XMLStreamReader xtr)
protected abstract void	writeAdditionalAttributes(BaseElement element, BpmnModel model, XMLStreamWriter xtw)
protected abstract void	writeAdditionalChildElements(BaseElement element, BpmnModel model, XMLStreamWriter xtw)
protected void	writeCancelDefinition(Event parentEvent, CancelEventDefinition cancelEventDefinition, XMLStreamWriter xtw)
protected void	writeCompensateDefinition(Event parentEvent, CompensateEventDefinition compensateEventDefinition, XMLStreamWriter xtw)
protected void	writeDefaultAttribute(String attributeName, String value, XMLStreamWriter xtw)
protected void	writeErrorDefinition(Event parentEvent, ErrorEventDefinition errorDefinition, XMLStreamWriter xtw)
protected void	writeEventDefinitions(Event parentEvent, List<EventDefinition> eventDefinitions, BpmnModel model, XMLStreamWriter xtw)
protected boolean	writeExtensionChildElements(BaseElement element, boolean didWriteExtensionStartElement, XMLStreamWriter xtw)
protected boolean	writeFormProperties(FlowElement flowElement, boolean didWriteExtensionStartElement, XMLStreamWriter xtw)
protected boolean	writeListeners(BaseElement element, boolean didWriteExtensionStartElement, XMLStreamWriter xtw)
protected void	writeMessageDefinition(Event parentEvent, MessageEventDefinition messageDefinition, BpmnModel model, XMLStreamWriter xtw)
protected void	writeQualifiedAttribute(String attributeName, String value, XMLStreamWriter xtw)
protected void	writeSignalDefinition(Event parentEvent, SignalEventDefinition signalDefinition, XMLStreamWriter xtw)
protected void	writeTerminateDefinition(Event parentEvent, TerminateEventDefinition terminateDefinition, XMLStreamWriter xtw)
protected void	writeTimerDefinition(Event parentEvent, TimerEventDefinition timerDefinition, XMLStreamWriter xtw)

Methods inherited from class java.lang.Object

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

Field Detail

LOGGER

protected static final org.slf4j.Logger LOGGER

defaultElementAttributes

protected static final List<ExtensionAttribute> defaultElementAttributes

defaultActivityAttributes

protected static final List<ExtensionAttribute> defaultActivityAttributes

Constructor Detail

BaseBpmnXMLConverter

public BaseBpmnXMLConverter()

Method Detail

convertToBpmnModel

public void convertToBpmnModel(XMLStreamReader xtr,
                      BpmnModel model,
                      Process activeProcess,
                      List<SubProcess> activeSubProcessList)
                        throws Exception

Throws:

Exception

convertToXML

public void convertToXML(XMLStreamWriter xtw,
                BaseElement baseElement,
                BpmnModel model)
                  throws Exception

Throws:

Exception

getBpmnElementType

protected abstract Class<? extends BaseElement> getBpmnElementType()

convertXMLToElement

protected abstract BaseElement convertXMLToElement(XMLStreamReader xtr,
                              BpmnModel model)
                                            throws Exception

Throws:

Exception

getXMLElementName

protected abstract String getXMLElementName()

writeAdditionalAttributes

protected abstract void writeAdditionalAttributes(BaseElement element,
                             BpmnModel model,
                             XMLStreamWriter xtw)
                                           throws Exception

Throws:

Exception

writeExtensionChildElements

protected boolean writeExtensionChildElements(BaseElement element,
                                  boolean didWriteExtensionStartElement,
                                  XMLStreamWriter xtw)
                                       throws Exception

Throws:

Exception

writeAdditionalChildElements

protected abstract void writeAdditionalChildElements(BaseElement element,
                                BpmnModel model,
                                XMLStreamWriter xtw)
                                              throws Exception

Throws:

Exception

parseChildElements

protected void parseChildElements(String elementName,
                      BaseElement parentElement,
                      BpmnModel model,
                      XMLStreamReader xtr)
                           throws Exception

Throws:

Exception

parseChildElements

protected void parseChildElements(String elementName,
                      BaseElement parentElement,
                      Map<String,BaseChildElementParser> additionalParsers,
                      BpmnModel model,
                      XMLStreamReader xtr)
                           throws Exception

Throws:

Exception

parseExtensionElement

protected ExtensionElement parseExtensionElement(XMLStreamReader xtr)
                                          throws Exception

Throws:

Exception

parseAsync

protected boolean parseAsync(XMLStreamReader xtr)

parseNotExclusive

protected boolean parseNotExclusive(XMLStreamReader xtr)

parseForCompensation

protected boolean parseForCompensation(XMLStreamReader xtr)

parseDelimitedList

protected List<String> parseDelimitedList(String expression)

convertToDelimitedString

protected String convertToDelimitedString(List<String> stringList)

writeFormProperties

protected boolean writeFormProperties(FlowElement flowElement,
                          boolean didWriteExtensionStartElement,
                          XMLStreamWriter xtw)
                               throws Exception

Throws:

Exception

writeListeners

protected boolean writeListeners(BaseElement element,
                     boolean didWriteExtensionStartElement,
                     XMLStreamWriter xtw)
                          throws Exception

Throws:

Exception

writeEventDefinitions

protected void writeEventDefinitions(Event parentEvent,
                         List<EventDefinition> eventDefinitions,
                         BpmnModel model,
                         XMLStreamWriter xtw)
                              throws Exception

Throws:

Exception

writeTimerDefinition

protected void writeTimerDefinition(Event parentEvent,
                        TimerEventDefinition timerDefinition,
                        XMLStreamWriter xtw)
                             throws Exception

Throws:

Exception

writeSignalDefinition

protected void writeSignalDefinition(Event parentEvent,
                         SignalEventDefinition signalDefinition,
                         XMLStreamWriter xtw)
                              throws Exception

Throws:

Exception

writeCancelDefinition

protected void writeCancelDefinition(Event parentEvent,
                         CancelEventDefinition cancelEventDefinition,
                         XMLStreamWriter xtw)
                              throws Exception

Throws:

Exception

writeCompensateDefinition

protected void writeCompensateDefinition(Event parentEvent,
                             CompensateEventDefinition compensateEventDefinition,
                             XMLStreamWriter xtw)
                                  throws Exception

Throws:

Exception

writeMessageDefinition

protected void writeMessageDefinition(Event parentEvent,
                          MessageEventDefinition messageDefinition,
                          BpmnModel model,
                          XMLStreamWriter xtw)
                               throws Exception

Throws:

Exception

writeErrorDefinition

protected void writeErrorDefinition(Event parentEvent,
                        ErrorEventDefinition errorDefinition,
                        XMLStreamWriter xtw)
                             throws Exception

Throws:

Exception

writeTerminateDefinition

protected void writeTerminateDefinition(Event parentEvent,
                            TerminateEventDefinition terminateDefinition,
                            XMLStreamWriter xtw)
                                 throws Exception

Throws:

Exception

writeDefaultAttribute

protected void writeDefaultAttribute(String attributeName,
                         String value,
                         XMLStreamWriter xtw)
                              throws Exception

Throws:

Exception

writeQualifiedAttribute

protected void writeQualifiedAttribute(String attributeName,
                           String value,
                           XMLStreamWriter xtw)
                                throws Exception

Throws:

Exception