org.eclipse.stardust.engine.api.runtime

Class DataCopyOptions

java.lang.Object

org.eclipse.stardust.engine.api.runtime.DataCopyOptions

All Implemented Interfaces:

Serializable

public class DataCopyOptions
extends Object
implements Serializable

Options class that specifies how the data should be copied between two process instances.

Author:

Florin.Herinean

See Also:

Serialized Form

Field Summary

Fields

Modifier and Type	Field and Description
static DataCopyOptions	DEFAULT The default data copy options used when no options are specified.

Constructor Summary

Constructors

Constructor and Description
DataCopyOptions(boolean copyAllData, Map<String,String> dataTranslationTable, Map<String,? extends Serializable> replacementTable, boolean useHeuristics) Creates a new DataCopyOptions object with the specified parameters.
DataCopyOptions(boolean copyAllData, Map<String,String> dataTranslationTable, Map<String,? extends Serializable> replacementTable, boolean useHeuristics, List<String> converters) Creates a new DataCopyOptions object with the specified parameters.
DataCopyOptions(List<String> converters) Creates a new DataCopyOptions object with a list of custom data value converters.

Method Summary

Methods

Modifier and Type	Method and Description
boolean	copyAllData() Checks if the engine should attempt to copy all compatible data.
Map<String,String>	getDataTranslationTable() Gets the Map that specifies from where the data values should be retrieved.
List<String>	getDataValueConverters() Retrieves the list of data value converter class names.
Map<String,? extends Serializable>	getReplacementTable() Gets the Map with concrete data values.
boolean	useHeuristics() Checks if heuristics should be applied to determine which data should be copied.

Methods inherited from class java.lang.Object

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

Field Detail

DEFAULT

public static final DataCopyOptions DEFAULT

The default data copy options used when no options are specified.

Constructor Detail

DataCopyOptions

public DataCopyOptions(boolean copyAllData,
               Map<String,String> dataTranslationTable,
               Map<String,? extends Serializable> replacementTable,
               boolean useHeuristics)

Creates a new DataCopyOptions object with the specified parameters.

Parameters:

copyAllData - if true, it will attempt to copy all data from the source process instance to the target process instance.

dataTranslationTable - a Map that indicates that the values for the specified data should be taken from another data object. The keys are the IDs of the target data and the values are the IDs of the source data objects.

replacementTable - a Map that specifies concrete values for target data. The keys are the IDs of the target data.

useHeuristics - if true then the engine will attempt to auto determine which data must be copied by investigating the data mappings and data paths of the target process instance.

DataCopyOptions

public DataCopyOptions(List<String> converters)

Creates a new DataCopyOptions object with a list of custom data value converters.

Parameters:

converters - a list of data value converter class names. The classes must be accessible to the engine and must have a public default constructor.

DataCopyOptions

public DataCopyOptions(boolean copyAllData,
               Map<String,String> dataTranslationTable,
               Map<String,? extends Serializable> replacementTable,
               boolean useHeuristics,
               List<String> converters)

Creates a new DataCopyOptions object with the specified parameters.

Parameters:

copyAllData - if true, it will attempt to copy all data from the source process instance to the target process instance.

dataTranslationTable - a Map that indicates that the values for the specified data should be taken from another data object. The keys are the IDs of the target data and the values are the IDs of the source data objects.

replacementTable - a Map that specifies concrete values for target data. The keys are the IDs of the target data.

useHeuristics - if true then the engine will attempt to auto determine which data must be copied by investigating the data mappings and data paths of the target process instance.

converters - a list of data value converter class names. The classes must be accessible to the engine and must have a public default constructor.

Method Detail

copyAllData

public boolean copyAllData()

Checks if the engine should attempt to copy all compatible data.

getDataTranslationTable

public Map<String,String> getDataTranslationTable()

Gets the Map that specifies from where the data values should be retrieved.

Returns:

a Map with data IDs. The keys are representing the IDs of the data in the target process instance while the values are representing the IDs of the data in the source process instance.

getReplacementTable

public Map<String,? extends Serializable> getReplacementTable()

Gets the Map with concrete data values.

Returns:

a Map with ID/value pairs.

useHeuristics

public boolean useHeuristics()

Checks if heuristics should be applied to determine which data should be copied.

getDataValueConverters

public List<String> getDataValueConverters()

Retrieves the list of data value converter class names.

Returns:

a list of class names.