com.ibm.xtools.comparemerge.emf.fuse

Class FuseFacade

java.lang.Object

com.ibm.xtools.comparemerge.emf.fuse.FuseFacade

public final class FuseFacade
extends java.lang.Object

The "Facade" static class that provides interface to the Aurora Fuse infrastructure.
It may be used to "fuse" the content of one (source) model into another (target) model.

The class may not be instantiated directly, only its static functions are to be used.

Method Summary

Modifier and Type	Method and Description
static MergeStatusType	startSilentFuse(java.lang.String fileType, IInputOutputDescriptor source, IInputOutputDescriptor target, IInputOutputDescriptor output, MergeModeType mode, com.ibm.xtools.comparemerge.emf.fuse.configure.IFuseConfiguration configuration, com.ibm.xtools.comparemerge.emf.fuse.silent.ISilentFuseStrategy strategy, com.ibm.xtools.comparemerge.emf.fuse.silent.ISilentFusePrompt prompt) Perform a silent fuse (no UI).
static MergeStatusType	startSilentFuse(java.lang.String fileType, IInputOutputDescriptor source, IInputOutputDescriptor target, IInputOutputDescriptor output, MergeModeType mode, com.ibm.xtools.comparemerge.emf.fuse.silent.ISilentFuseStrategy strategy, com.ibm.xtools.comparemerge.emf.fuse.silent.ISilentFusePrompt prompt) Deprecated.
static void	startVisualCompareDialog()
static MergeStatusType	startVisualFuseDialog(java.lang.String dialogTitle, java.lang.String titleLabel, java.lang.String titleMessage, java.lang.String fileType, IInputOutputDescriptor source, IInputOutputDescriptor target, IInputOutputDescriptor output, MergeModeType mode, com.ibm.xtools.comparemerge.emf.fuse.configure.IFuseConfiguration configuration) Starts a fuse session in a model dialog.

Methods inherited from class java.lang.Object

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

Method Detail

startVisualCompareDialog

public static void startVisualCompareDialog()

startVisualFuseDialog

public static MergeStatusType startVisualFuseDialog(java.lang.String dialogTitle,
                                                    java.lang.String titleLabel,
                                                    java.lang.String titleMessage,
                                                    java.lang.String fileType,
                                                    IInputOutputDescriptor source,
                                                    IInputOutputDescriptor target,
                                                    IInputOutputDescriptor output,
                                                    MergeModeType mode,
                                                    com.ibm.xtools.comparemerge.emf.fuse.configure.IFuseConfiguration configuration)

Starts a fuse session in a model dialog.

Parameters:

dialogTitle - to be shown in the dialog's window title

titleLabel - to be shown in the "instruction title" - the white pane just below the dialog title

titleMessage - the descriptive/instructional text shown in the "instruction title" pane below the titleLabel

fileType - to be fuse in format filename.ext

source - descriptor for the Source model. Can be one of:
TYPE_FILE_PATH,
TYPE_INPUT_STREAM_CONTENT_ACCESSOR or
TYPE_INPUT_DATA_IN_MEMORY (an already loaded EMF Resource)

target - descriptor for the Target model. Can be one of:
TYPE_FILE_PATH,
TYPE_INPUT_STREAM_CONTENT_ACCESSOR or
TYPE_INPUT_DATA_IN_MEMORY (an already loaded EMF Resource)

output - descriptor for where to save the result of the fuse. Can be one of:
TYPE_FILE_PATH,
TYPE_OUTPUT_EDITABLE_CONTENT,
TYPE_OUTPUT_STREAM or
TYPE_OUTPUT_CONTRIBUTOR (meaning to modify the specified input model of type TYPE_INPUT_DATA_IN_MEMORY in-place)

mode - either FUSE_BY_NAME or MERGE_BY_ID

configuration - the optional configuration parameters that can be suplied to tune the Fuse UI

Returns:

status of the fuse operation such as COMPLETED, FAILED or CANCELED

startSilentFuse

public static MergeStatusType startSilentFuse(java.lang.String fileType,
                                              IInputOutputDescriptor source,
                                              IInputOutputDescriptor target,
                                              IInputOutputDescriptor output,
                                              MergeModeType mode,
                                              com.ibm.xtools.comparemerge.emf.fuse.silent.ISilentFuseStrategy strategy,
                                              com.ibm.xtools.comparemerge.emf.fuse.silent.ISilentFusePrompt prompt)

Deprecated.

Perform a silent fuse (no UI). It is done with the help of the ISilentFuseStrategy which is responsible for detecting if the silent operation is possible and then completing it.

After it was discovered the silent operation can be done, user can be prompted if he wants to do it silently (without user input) or visually. If the ISilentFusePrompt returns true, the silent fuse will be completed. If it returns false, the silent fuse will be canceled. In this case the Visual Fuse must be invoked via startVisualFuseDialog().

Parameters:

fileType - of the models to be fused in format filename.ext

source - descriptor for the Source model. Can be one of:
TYPE_FILE_PATH,
TYPE_INPUT_STREAM_CONTENT_ACCESSOR or
TYPE_INPUT_DATA_IN_MEMORY (an already loaded EMF Resource)

target - descriptor for the Target model. Can be one of:
TYPE_FILE_PATH,
TYPE_INPUT_STREAM_CONTENT_ACCESSOR or
TYPE_INPUT_DATA_IN_MEMORY (an already loaded EMF Resource)

output - descriptor for where to save the result of the fuse. Can be one of:
TYPE_FILE_PATH,
TYPE_OUTPUT_EDITABLE_CONTENT,
TYPE_OUTPUT_STREAM or
TYPE_OUTPUT_CONTRIBUTOR (meaning to modify the specified input model of type TYPE_INPUT_DATA_IN_MEMORY in-place)

mode - either FUSE_BY_NAME or MERGE_BY_ID

strategy - to perform the silent fuse on the loaded models

prompt - is a callback used to prompt the user if he wants to complete the silent fuse when it was discovered it can be done. If it is null, the silent fuse will be completed automatically.

Returns:

status of the fuse operation such as COMPLETED, FAILED or CANCELED

startSilentFuse

public static MergeStatusType startSilentFuse(java.lang.String fileType,
                                              IInputOutputDescriptor source,
                                              IInputOutputDescriptor target,
                                              IInputOutputDescriptor output,
                                              MergeModeType mode,
                                              com.ibm.xtools.comparemerge.emf.fuse.configure.IFuseConfiguration configuration,
                                              com.ibm.xtools.comparemerge.emf.fuse.silent.ISilentFuseStrategy strategy,
                                              com.ibm.xtools.comparemerge.emf.fuse.silent.ISilentFusePrompt prompt)

Perform a silent fuse (no UI). It is done with the help of the ISilentFuseStrategy which is responsible for detecting if the silent operation is possible and then completing it.

After it was discovered the silent operation can be done, user can be prompted if he wants to do it silently (without user input) or visually. If the ISilentFusePrompt returns true, the silent fuse will be completed. If it returns false, the silent fuse will be canceled. In this case the Visual Fuse must be invoked via startVisualFuseDialog().

Parameters:

fileType - of the models to be fused in format filename.ext

source - descriptor for the Source model. Can be one of:
TYPE_FILE_PATH,
TYPE_INPUT_STREAM_CONTENT_ACCESSOR or
TYPE_INPUT_DATA_IN_MEMORY (an already loaded EMF Resource)

target - descriptor for the Target model. Can be one of:
TYPE_FILE_PATH,
TYPE_INPUT_STREAM_CONTENT_ACCESSOR or
TYPE_INPUT_DATA_IN_MEMORY (an already loaded EMF Resource)

output - descriptor for where to save the result of the fuse. Can be one of:
TYPE_FILE_PATH,
TYPE_OUTPUT_EDITABLE_CONTENT,
TYPE_OUTPUT_STREAM or
TYPE_OUTPUT_CONTRIBUTOR (meaning to modify the specified input model of type TYPE_INPUT_DATA_IN_MEMORY in-place)

mode - either FUSE_BY_NAME or MERGE_BY_ID

configuration - the optional configuration parameters that can be suplied for overriding the default merge manager.

strategy - to perform the silent fuse on the loaded models

prompt - is a callback used to prompt the user if he wants to complete the silent fuse when it was discovered it can be done. If it is null, the silent fuse will be completed automatically.

Returns:

status of the fuse operation such as COMPLETED, FAILED or CANCELED