TIBCO ActiveMatrix Mediation Implementation Type v3.3.1

com.tibco.amsb.core.task.ui
Class MediationTaskUIFactory

java.lang.Object
  extended by com.tibco.amsb.core.task.ui.MediationTaskUIFactory
All Implemented Interfaces:
org.eclipse.core.runtime.IExecutableExtension

public abstract class MediationTaskUIFactory
extends java.lang.Object
implements org.eclipse.core.runtime.IExecutableExtension

Mediation Task User Interface extensions extend this abstract base class to provide the information needed to configure a mediation task in the user interface.


Field Summary
protected static java.lang.String ACTION_GROUP
          Standard group name for a mediation task that performs actions.
protected static java.lang.String CONTROL_GROUP
          Standard group name for a mediation task that affects the mediation execution path.
protected static java.lang.String DATA_GROUP
          Standard group name for a mediation task that modifies data.
protected static java.lang.String MEDIATION_TASK_TYPE_ATTRIBUTE
          The extension point defines an attribute to correlate the model extension with this user interface extension.
protected  MediationTaskTypeExtension mediationExtension
          This extension provides model behavior such as creating an instance.
protected  java.lang.String mediationTaskType
          Type id to correlate the mediation task model extension with this user interface extension.
 
Constructor Summary
MediationTaskUIFactory()
           
 
Method Summary
abstract  TaskEditPart createTaskEditPart(FlowDataProvider fdp, MediationTask taskModel)
          Create an edit part delegate object.
 java.util.List<HoverTipProperty> getHoverTipProperties(MediationTask task)
          Return a list of strings to be displayed in a hover tool tip
 java.lang.String getHoverTipTitle()
          Mechanism to provide a different name for the hovertip title
abstract  org.eclipse.jface.resource.ImageDescriptor getLargeIcon()
          Return an icon suitable to show on the mediation flow (e.g.32x32).
 java.lang.String getMediationTaskType()
          Return the type id used to correlate the model with the user interface extension.
 MediationTaskTypeExtension getMediationTaskTypeExtension()
          Get the extension associated with the MediationTask model object to access methods to manipulate the model.
abstract  java.lang.String getName()
          Access method to get the type name of the mediation task, e.g.
 java.lang.String getPaletteGroup()
          Return a display string used to group tasks in the palette
 int getPriority()
          Return a number that will be used to order tasks in the user interface.
abstract  java.lang.String getShortDescription()
          Return a short description of this type of mediation task.
abstract  org.eclipse.jface.resource.ImageDescriptor getSmallIcon()
          Return an icon suitable for a palette or menu (e.g.
 void setInitializationData(org.eclipse.core.runtime.IConfigurationElement config, java.lang.String propertyName, java.lang.Object data)
          This method is called by the Eclipse registry infrastructure to provide the required information to correlate this extension with the model extension.
 boolean showInPalette()
          Controls when a mediation task is shown in the palette or not.
 
Methods inherited from class java.lang.Object
clone, equals, finalize, getClass, hashCode, notify, notifyAll, toString, wait, wait, wait
 

Field Detail

ACTION_GROUP

protected static final java.lang.String ACTION_GROUP
Standard group name for a mediation task that performs actions.


DATA_GROUP

protected static final java.lang.String DATA_GROUP
Standard group name for a mediation task that modifies data.


CONTROL_GROUP

protected static final java.lang.String CONTROL_GROUP
Standard group name for a mediation task that affects the mediation execution path.


MEDIATION_TASK_TYPE_ATTRIBUTE

protected static final java.lang.String MEDIATION_TASK_TYPE_ATTRIBUTE
The extension point defines an attribute to correlate the model extension with this user interface extension. This attribute contains that correlation value.

See Also:
Constant Field Values

mediationTaskType

protected java.lang.String mediationTaskType
Type id to correlate the mediation task model extension with this user interface extension.


mediationExtension

protected MediationTaskTypeExtension mediationExtension
This extension provides model behavior such as creating an instance.

Constructor Detail

MediationTaskUIFactory

public MediationTaskUIFactory()
Method Detail

setInitializationData

public void setInitializationData(org.eclipse.core.runtime.IConfigurationElement config,
                                  java.lang.String propertyName,
                                  java.lang.Object data)
                           throws org.eclipse.core.runtime.CoreException
This method is called by the Eclipse registry infrastructure to provide the required information to correlate this extension with the model extension.

Specified by:
setInitializationData in interface org.eclipse.core.runtime.IExecutableExtension
Parameters:
mediationTaskType - - the id string from the mediation extension
Throws:
org.eclipse.core.runtime.CoreException

getName

public abstract java.lang.String getName()
Access method to get the type name of the mediation task, e.g. Log

Returns:
name string

getShortDescription

public abstract java.lang.String getShortDescription()
Return a short description of this type of mediation task.

Returns:
short description string

getPriority

public int getPriority()
Return a number that will be used to order tasks in the user interface. The order is lowest to highest.

Returns:
lower numbers show up first, higher numbers last

showInPalette

public boolean showInPalette()
Controls when a mediation task is shown in the palette or not.

Returns:
true (default) to show in the palette

getPaletteGroup

public java.lang.String getPaletteGroup()
Return a display string used to group tasks in the palette

Returns:

getSmallIcon

public abstract org.eclipse.jface.resource.ImageDescriptor getSmallIcon()
Return an icon suitable for a palette or menu (e.g. 16x16).

Returns:
image descriptor

getLargeIcon

public abstract org.eclipse.jface.resource.ImageDescriptor getLargeIcon()
Return an icon suitable to show on the mediation flow (e.g.32x32).

Returns:
image descriptor

getMediationTaskType

public java.lang.String getMediationTaskType()
Return the type id used to correlate the model with the user interface extension.

Returns:
mediation task type id

getMediationTaskTypeExtension

public MediationTaskTypeExtension getMediationTaskTypeExtension()
Get the extension associated with the MediationTask model object to access methods to manipulate the model.

Returns:

getHoverTipTitle

public java.lang.String getHoverTipTitle()
Mechanism to provide a different name for the hovertip title

Returns:

getHoverTipProperties

public java.util.List<HoverTipProperty> getHoverTipProperties(MediationTask task)
Return a list of strings to be displayed in a hover tool tip

Parameters:
task - - current task mouse is hovering over
Returns:
list of display strings

createTaskEditPart

public abstract TaskEditPart createTaskEditPart(FlowDataProvider fdp,
                                                MediationTask taskModel)
Create an edit part delegate object. This delegate is used to extend the base mediation diagram task edit part, and is the object that is actually selected when a mediation task is selected on the diagram.

Parameters:
fdp - - use the flow data provider to obtain context information
taskModel - - the task model is provided in case information is needed from it
Returns:
a new task edit part object

TIBCO ActiveMatrix Mediation Implementation Type v3.3.1

Copyright © 2010 TIBCO Software Inc. All Rights Reserved.