Package org.flowable.cmmn.converter.export

Class AbstractPlanItemDefinitionExport<T extends PlanItemDefinition>

java.lang.Object

org.flowable.cmmn.converter.export.AbstractPlanItemDefinitionExport<T>

All Implemented Interfaces:

CmmnXmlConstants

Direct Known Subclasses:

AbstractChildTaskExport, AbstractServiceTaskExport, CasePageTaskExport, DecisionTaskExport, ExternalWorkerServiceTaskExport, GenericEventListenerExport, HumanTaskExport, MilestoneExport, PlanFragmentExport, ReactivationEventListenerExport, SignalEventListenerExport, StageExport, TaskExport, TimerEventListenerExport, UserEventListenerExport, VariableEventListenerExport

public abstract class AbstractPlanItemDefinitionExport<T extends PlanItemDefinition>
extends Object
implements CmmnXmlConstants

Field Summary

Fields inherited from interface org.flowable.cmmn.converter.CmmnXmlConstants

ATTRIBUTE_ACTIVATE_CONDITION, ATTRIBUTE_ASSIGNEE, ATTRIBUTE_AUTHOR, ATTRIBUTE_AUTHORIZED_ROLE_REFS, ATTRIBUTE_AUTO_COMPLETE_CONDITION, ATTRIBUTE_BUSINESS_KEY, ATTRIBUTE_BUSINESS_STATUS, ATTRIBUTE_CANDIDATE_GROUPS, ATTRIBUTE_CANDIDATE_USERS, ATTRIBUTE_CASE_CANDIDATE_GROUPS, ATTRIBUTE_CASE_CANDIDATE_USERS, ATTRIBUTE_CASE_REF, ATTRIBUTE_CATEGORY, ATTRIBUTE_CLASS, ATTRIBUTE_CREATION_DATE, ATTRIBUTE_DECISION_REF, ATTRIBUTE_DEFAULT_CONDITION, ATTRIBUTE_DEFINITION_REF, ATTRIBUTE_DELEGATE_EXPRESSION, ATTRIBUTE_DI_CMMN_ELEMENT_REF, ATTRIBUTE_DI_HEIGHT, ATTRIBUTE_DI_ROTATION, ATTRIBUTE_DI_TARGET_CMMN_ELEMENT_REF, ATTRIBUTE_DI_WIDTH, ATTRIBUTE_DI_X, ATTRIBUTE_DI_Y, ATTRIBUTE_DISPLAY_ORDER, ATTRIBUTE_DUE_DATE, ATTRIBUTE_ELEMENT_NAME, ATTRIBUTE_EVENT_LISTENER_AVAILABLE_CONDITION, ATTRIBUTE_EVENT_LISTENER_SIGNAL_REF, ATTRIBUTE_EVENT_LISTENER_TYPE, ATTRIBUTE_EVENT_LISTENER_VARIABLE_CHANGE_TYPE, ATTRIBUTE_EVENT_LISTENER_VARIABLE_NAME, ATTRIBUTE_EXIT_EVENT_TYPE, ATTRIBUTE_EXIT_TYPE, ATTRIBUTE_EXPORTER, ATTRIBUTE_EXPORTER_VERSION, ATTRIBUTE_EXPRESSION, ATTRIBUTE_EXPRESSION_LANGUAGE, ATTRIBUTE_EXTERNAL_REF, ATTRIBUTE_EXTERNAL_WORKER_DO_NOT_INCLUDE_VARIABLES, ATTRIBUTE_EXTERNAL_WORKER_TOPIC, ATTRIBUTE_FALLBACK_TO_DEFAULT_TENANT, ATTRIBUTE_FIELD_EXPRESSION, ATTRIBUTE_FIELD_STRING, ATTRIBUTE_FORM_FIELD_VALIDATION, ATTRIBUTE_FORM_KEY, ATTRIBUTE_HTTP_PARALLEL_IN_SAME_TRANSACTION, ATTRIBUTE_ICON, ATTRIBUTE_ID, ATTRIBUTE_ID_VARIABLE_NAME, ATTRIBUTE_IGNORE_CONDITION, ATTRIBUTE_IGNORE_REPETITION_COUNTER_VARIABLE, ATTRIBUTE_IMPLEMENTATION_TYPE, ATTRIBUTE_INCLUDE_IN_STAGE_OVERVIEW, ATTRIBUTE_INHERIT_BUSINESS_KEY, ATTRIBUTE_INITIATOR_VARIABLE_NAME, ATTRIBUTE_IOPARAMETER_SOURCE, ATTRIBUTE_IOPARAMETER_SOURCE_EXPRESSION, ATTRIBUTE_IOPARAMETER_TARGET, ATTRIBUTE_IOPARAMETER_TARGET_EXPRESSION, ATTRIBUTE_IOPARAMETER_TRANSIENT, ATTRIBUTE_IS_ASYNCHRONOUS, ATTRIBUTE_IS_ASYNCHRONOUS_LEAVE, ATTRIBUTE_IS_ASYNCHRONOUS_LEAVE_EXCLUSIVE, ATTRIBUTE_IS_AUTO_COMPLETE, ATTRIBUTE_IS_BLOCKING, ATTRIBUTE_IS_BLOCKING_EXPRESSION, ATTRIBUTE_IS_EXCLUSIVE, ATTRIBUTE_LABEL, ATTRIBUTE_LISTENER_CLASS, ATTRIBUTE_LISTENER_DELEGATEEXPRESSION, ATTRIBUTE_LISTENER_EVENT, ATTRIBUTE_LISTENER_EXPRESSION, ATTRIBUTE_LISTENER_ON_TRANSACTION, ATTRIBUTE_LISTENER_SOURCE_STATE, ATTRIBUTE_LISTENER_TARGET_STATE, ATTRIBUTE_LISTENER_TYPE, ATTRIBUTE_MILESTONE_VARIABLE, ATTRIBUTE_NAME, ATTRIBUTE_OWNER, ATTRIBUTE_PLAN_ITEM_START_TRIGGER_SRC_REF, ATTRIBUTE_PRIORITY, ATTRIBUTE_PROCESS_REF, ATTRIBUTE_REPETITION_COLLECTION_VARIABLE_NAME, ATTRIBUTE_REPETITION_COUNTER_VARIABLE_NAME, ATTRIBUTE_REPETITION_ELEMENT_INDEX_VARIABLE_NAME, ATTRIBUTE_REPETITION_ELEMENT_VARIABLE_NAME, ATTRIBUTE_REPETITION_MAX_INSTANCE_COUNT_NAME, ATTRIBUTE_RESULT_VARIABLE_NAME, ATTRIBUTE_SAME_DEPLOYMENT, ATTRIBUTE_SCRIPT_FORMAT, ATTRIBUTE_SCRIPT_LANGUAGE, ATTRIBUTE_SCRIPT_RESULTVARIABLE, ATTRIBUTE_SENTRY_REF, ATTRIBUTE_SOURCE_REF, ATTRIBUTE_STORE_RESULT_AS_TRANSIENT, ATTRIBUTE_TARGET_NAMESPACE, ATTRIBUTE_TARGET_REF, ATTRIBUTE_TASK_COMPLETER_VARIABLE_NAME, ATTRIBUTE_TASK_ID_VARIABLE_NAME, ATTRIBUTE_TASK_SCRIPT_AUTO_STORE_VARIABLE, ATTRIBUTE_TEXT_FORMAT, ATTRIBUTE_TRIGGER_MODE, ATTRIBUTE_TYPE, ATTRIBUTE_USER_EVENT_LISTENER_REACTIVATE, ATTRIBUTE_VARIABLE_AGGREGATION_CREATE_OVERVIEW, ATTRIBUTE_VARIABLE_AGGREGATION_STORE_AS_TRANSIENT_VARIABLE, ATTRIBUTE_VARIABLE_AGGREGATION_VARIABLE, CASE_NAMESPACE, CMMN_NAMESPACE, CMMNDI_NAMESPACE, CMMNDI_PREFIX, ELEMENT_ASSOCIATION, ELEMENT_CASE, ELEMENT_CASE_LIFECYCLE_LISTENER, ELEMENT_CASE_REF_EXPRESSION, ELEMENT_CASE_TASK, ELEMENT_CHILD_TASK_IN_PARAMETERS, ELEMENT_CHILD_TASK_OUT_PARAMETERS, ELEMENT_COMPLETION_NEUTRAL_RULE, ELEMENT_CONDITION, ELEMENT_DECISION, ELEMENT_DECISION_REF_EXPRESSION, ELEMENT_DECISION_TASK, ELEMENT_DEFAULT_CONTROL, ELEMENT_DEFAULT_REACTIVATION_RULE, ELEMENT_DEFINITIONS, ELEMENT_DI_BOUNDS, ELEMENT_DI_CMMN, ELEMENT_DI_DIAGRAM, ELEMENT_DI_DOCKER, ELEMENT_DI_EDGE, ELEMENT_DI_EXTENSION, ELEMENT_DI_LABEL, ELEMENT_DI_SHAPE, ELEMENT_DI_WAYPOINT, ELEMENT_DOCUMENTATION, ELEMENT_ENTRY_CRITERION, ELEMENT_EVENT_CORRELATION_PARAMETER, ELEMENT_EVENT_IN_PARAMETER, ELEMENT_EVENT_OUT_PARAMETER, ELEMENT_EVENT_TYPE, ELEMENT_EXIT_CRITERION, ELEMENT_EXTENSION_ELEMENTS, ELEMENT_EXTERNAL_WORKER_IN_PARAMETER, ELEMENT_EXTERNAL_WORKER_OUT_PARAMETER, ELEMENT_FIELD, ELEMENT_FIELD_EXPRESSION, ELEMENT_FIELD_STRING, ELEMENT_GENERIC_EVENT_LISTENER, ELEMENT_HTTP_REQUEST_HANDLER, ELEMENT_HTTP_RESPONSE_HANDLER, ELEMENT_HUMAN_TASK, ELEMENT_IF_PART, ELEMENT_ITEM_CONTROL, ELEMENT_MANUAL_ACTIVATION_RULE, ELEMENT_MILESTONE, ELEMENT_PARAMETER_MAPPING, ELEMENT_PARENT_COMPLETION_RULE, ELEMENT_PLAN_FRAGMENT, ELEMENT_PLAN_ITEM, ELEMENT_PLAN_ITEM_LIFECYCLE_LISTENER, ELEMENT_PLAN_ITEM_ON_PART, ELEMENT_PLAN_ITEM_START_TRIGGER, ELEMENT_PLAN_MODEL, ELEMENT_PROCESS, ELEMENT_PROCESS_REF_EXPRESSION, ELEMENT_PROCESS_TASK, ELEMENT_PROCESS_TASK_IN_PARAMETERS, ELEMENT_PROCESS_TASK_OUT_PARAMETERS, ELEMENT_REACTIVATION_RULE, ELEMENT_REPETITION_RULE, ELEMENT_REQUIRED_RULE, ELEMENT_SCRIPT, ELEMENT_SENTRY, ELEMENT_STAGE, ELEMENT_STANDARD_EVENT, ELEMENT_TASK, ELEMENT_TASK_LISTENER, ELEMENT_TEXT, ELEMENT_TEXT_ANNOTATION, ELEMENT_TIMER_EVENT_LISTENER, ELEMENT_TIMER_EXPRESSION, ELEMENT_USER_EVENT_LISTENER, ELEMENT_VARIABLE_AGGREGATION, FLOWABLE_EXTENSIONS_NAMESPACE, FLOWABLE_EXTENSIONS_PREFIX, OMGDC_NAMESPACE, OMGDC_PREFIX, OMGDI_NAMESPACE, OMGDI_PREFIX, START_EVENT_CORRELATION_CONFIGURATION, START_EVENT_CORRELATION_MANUAL, START_EVENT_CORRELATION_STORE_AS_UNIQUE_REFERENCE_ID, XSI_NAMESPACE, XSI_PREFIX

Constructor Summary

Constructors

Constructor	Description
AbstractPlanItemDefinitionExport()

Method Summary

Modifier and Type	Method	Description
protected abstract Class<? extends T>	getExportablePlanItemDefinitionClass()	The class for which exporter subclasses works for
protected abstract String	getPlanItemDefinitionXmlElementValue(T planItemDefinition)	Subclasses must override this method to provide the xml element tag value of this planItemDefinition
void	writePlanItemDefinition(CmmnModel model, T planItemDefinition, XMLStreamWriter xtw, CmmnXmlConverterOptions options)	The steps followed to write a planItemDefinition
protected void	writePlanItemDefinitionBody(CmmnModel model, T planItemDefinition, XMLStreamWriter xtw, CmmnXmlConverterOptions options)	Subclasses can override this method to write the content body xml content of the plainItemDefinition
protected void	writePlanItemDefinitionCommonAttributes(T planItemDefinition, XMLStreamWriter xtw, CmmnXmlConverterOptions options)
protected boolean	writePlanItemDefinitionCommonElements(CmmnModel model, T planItemDefinition, XMLStreamWriter xtw, CmmnXmlConverterOptions options)	Writes common elements like planItem documentation.
protected void	writePlanItemDefinitionDefaultItemControl(CmmnModel model, T planItemDefinition, XMLStreamWriter xtw)
protected void	writePlanItemDefinitionEndElement(XMLStreamWriter xtw)
protected boolean	writePlanItemDefinitionExtensionElements(CmmnModel model, T planItemDefinition, boolean didWriteExtensionElement, XMLStreamWriter xtw)
protected void	writePlanItemDefinitionSpecificAttributes(T planItemDefinition, XMLStreamWriter xtw)	Subclasses can override this method to write attributes specific to the plainItemDefinition element
protected void	writePlanItemDefinitionStartElement(T planItemDefinition, XMLStreamWriter xtw)

Methods inherited from class java.lang.Object

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

Constructor Details

AbstractPlanItemDefinitionExport

public AbstractPlanItemDefinitionExport()

Method Details

getExportablePlanItemDefinitionClass

protected abstract Class<? extends T> getExportablePlanItemDefinitionClass()

The class for which exporter subclasses works for

Returns:

a Class that extends PlanItemDefinition

writePlanItemDefinition

public void writePlanItemDefinition(CmmnModel model,
 T planItemDefinition,
 XMLStreamWriter xtw,
 CmmnXmlConverterOptions options)
                             throws Exception

The steps followed to write a planItemDefinition

Parameters:

planItemDefinition - the plan item definition to write

xtw - the XML to write the definition to

Throws:

Exception - in case of write exception

writePlanItemDefinitionStartElement

protected void writePlanItemDefinitionStartElement(T planItemDefinition,
 XMLStreamWriter xtw)
                                            throws Exception

Throws:

Exception

getPlanItemDefinitionXmlElementValue

protected abstract String getPlanItemDefinitionXmlElementValue(T planItemDefinition)

Subclasses must override this method to provide the xml element tag value of this planItemDefinition

Parameters:

planItemDefinition - the plan item definition to write

Returns:

the value of the xml element tag to write

writePlanItemDefinitionCommonAttributes

protected void writePlanItemDefinitionCommonAttributes(T planItemDefinition,
 XMLStreamWriter xtw,
 CmmnXmlConverterOptions options)
                                                throws Exception

Throws:

Exception

writePlanItemDefinitionSpecificAttributes

protected void writePlanItemDefinitionSpecificAttributes(T planItemDefinition,
 XMLStreamWriter xtw)
                                                  throws Exception

Subclasses can override this method to write attributes specific to the plainItemDefinition element

Parameters:

planItemDefinition - the plan item definition to write

xtw - the XML to write the definition to

Throws:

Exception - in case of write exception

writePlanItemDefinitionCommonElements

protected boolean writePlanItemDefinitionCommonElements(CmmnModel model,
 T planItemDefinition,
 XMLStreamWriter xtw,
 CmmnXmlConverterOptions options)
                                                 throws Exception

Writes common elements like planItem documentation. Subclasses should call super.writePlanItemDefinitionCommonElements(), it is recommended to override writePlanItemDefinitionBody instead

Parameters:

planItemDefinition - the plan item definition to write

xtw - the XML to write the definition to

Throws:

Exception - in case of write exception

writePlanItemDefinitionExtensionElements

protected boolean writePlanItemDefinitionExtensionElements(CmmnModel model,
 T planItemDefinition,
 boolean didWriteExtensionElement,
 XMLStreamWriter xtw)
                                                    throws Exception

Throws:

Exception

writePlanItemDefinitionDefaultItemControl

protected void writePlanItemDefinitionDefaultItemControl(CmmnModel model,
 T planItemDefinition,
 XMLStreamWriter xtw)
                                                  throws Exception

Throws:

Exception

writePlanItemDefinitionBody

protected void writePlanItemDefinitionBody(CmmnModel model,
 T planItemDefinition,
 XMLStreamWriter xtw,
 CmmnXmlConverterOptions options)
                                    throws Exception

Subclasses can override this method to write the content body xml content of the plainItemDefinition

Parameters:

planItemDefinition - the plan item definition to write

xtw - the XML to write the definition to

Throws:

Exception - in case of write exception

writePlanItemDefinitionEndElement

protected void writePlanItemDefinitionEndElement(XMLStreamWriter xtw)
                                          throws Exception

Throws:

Exception