Package de.mid.innovator.m2msdk.ui

Class OptionFrame

java.lang.Object

java.awt.Component

java.awt.Container

java.awt.Window

java.awt.Frame

javax.swing.JFrame

de.mid.innovator.m2msdk.ui.WizardHorizontalFrame

de.mid.innovator.m2msdk.ui.OptionFrame

All Implemented Interfaces:

ConfigurableItemIF, FrameInterface, IdentifierAble, MouseMotionListener, WindowListener, ImageObserver, MenuContainer, Serializable, EventListener, Accessible, RootPaneContainer, WindowConstants

public class OptionFrame
extends WizardHorizontalFrame

Frame to display options and to ask user for new values in options.

Version:

11.3.2

Author:

jmback

See Also:

• Serialized Form

Nested Class Summary

Nested classes/interfaces inherited from class java.awt.Window

Window.Type

Nested classes/interfaces inherited from class java.awt.Component

Component.BaselineResizeBehavior

Field Summary

Fields inherited from class java.awt.Frame

ICONIFIED, MAXIMIZED_BOTH, MAXIMIZED_HORIZ, MAXIMIZED_VERT, NORMAL

Fields inherited from class java.awt.Component

BOTTOM_ALIGNMENT, CENTER_ALIGNMENT, LEFT_ALIGNMENT, RIGHT_ALIGNMENT, TOP_ALIGNMENT

Fields inherited from interface java.awt.image.ImageObserver

ABORT, ALLBITS, ERROR, FRAMEBITS, HEIGHT, PROPERTIES, SOMEBITS, WIDTH

Fields inherited from interface javax.swing.WindowConstants

DISPOSE_ON_CLOSE, DO_NOTHING_ON_CLOSE, EXIT_ON_CLOSE, HIDE_ON_CLOSE

Constructor Summary

Constructors

Constructor	Description
OptionFrame()

Method Summary

Modifier and Type	Method	Description
boolean	checkConstraints(MappingElementIF sourceElement, MappingElementList targetElement, MappingElementList passedElements, MappingElementList bypassedElements)
boolean	checkConstraints(MappingElementIF el, ExpressionContext context)	Check if all constraints evaluate to true.
void	close()	Close the frame.
void	frameActionPerformed(ActionEvent evt)	Handling user action events.
void	frameKeyPerformed(KeyEvent evt)	Handling user key events.
ConfigurationItemIF	getBaseItem()	Configuration item which is the base of this configured item.
List<ConfigurableItemIF>	getConfigurableItems(ConfigurationTag searchTag, ConfigurationItemSearchMode mode)
ConfigurationTag	getConfigurationTag()	Get the type of the configurable item.
Identifier	getId()	Get the identifier of the owning model transformation step.
ConfigurableItemIF	getItem(Identifier id)	Get owned item with this identifier.
ParameterTemplates	getKnownParameters(MappingElementIF me, ConfigurationItemIF iItem)	Get the list of all acceptable parameter names.
String	getName()	Get the name.
ConfigurableItemIF	getParentItem()	Get the parent of this item.
<T extends ConfigurableItemIF> T	getParentItem(Class<T> parentClassType)
void	initialize(LookNFeel iLookNFeel)	Initialize the frame (do not make it visible yet).
boolean	isBackable()	Is the frame a valid target for the "Back" button.
boolean	isWaiting()	Is the frame waiting for the user?
void	mouseDragged(MouseEvent e)
void	mouseMoved(MouseEvent e)
void	setBaseItem(ConfigurationItemIF iItem)
void	setConfigurationContext(SessionInterface iSession, MetaModel sourceMM, MetaModel targetMM, ConfigurationItemIF iItem)	Set the configuration context of this configurable item.
void	setConfigurationTag(ConfigurationTag iTag)	Set the type of the item.
void	setFirst()	This is the first frame in the workflow.
void	setId(Identifier iID)	Set the identifier.
void	setLast()	This is the last frame in the workflow.
void	setParameter(String iName, String iParam)	Set the parameter of the application.
void	setParent(ConfigurableItemIF iParent)	Set the parent of this item.
void	setPreEngine()	This is the frame before an engine call.
void	setVisible(boolean bVisible)	Make the frame visible or invisible.
String	toString()
void	windowActivated(WindowEvent e)
void	windowClosed(WindowEvent e)
void	windowClosing(WindowEvent e)
void	windowDeactivated(WindowEvent e)
void	windowDeiconified(WindowEvent e)
void	windowIconified(WindowEvent e)
void	windowOpened(WindowEvent evt)

Methods inherited from class javax.swing.JFrame

getAccessibleContext, getContentPane, getDefaultCloseOperation, getGlassPane, getGraphics, getJMenuBar, getLayeredPane, getRootPane, getTransferHandler, isDefaultLookAndFeelDecorated, remove, repaint, setContentPane, setDefaultCloseOperation, setDefaultLookAndFeelDecorated, setGlassPane, setIconImage, setJMenuBar, setLayeredPane, setLayout, setTransferHandler, update

Methods inherited from class java.awt.Frame

addNotify, getExtendedState, getFrames, getIconImage, getMaximizedBounds, getMenuBar, getState, getTitle, isResizable, isUndecorated, remove, removeNotify, setBackground, setExtendedState, setMaximizedBounds, setMenuBar, setOpacity, setResizable, setShape, setState, setTitle, setUndecorated

Methods inherited from class java.awt.Window

addPropertyChangeListener, addPropertyChangeListener, addWindowFocusListener, addWindowListener, addWindowStateListener, createBufferStrategy, createBufferStrategy, dispose, getBackground, getBufferStrategy, getFocusableWindowState, getFocusCycleRootAncestor, getFocusOwner, getFocusTraversalKeys, getIconImages, getInputContext, getListeners, getLocale, getModalExclusionType, getMostRecentFocusOwner, getOpacity, getOwnedWindows, getOwner, getOwnerlessWindows, getShape, getToolkit, getType, getWarningString, getWindowFocusListeners, getWindowListeners, getWindows, getWindowStateListeners, isActive, isAlwaysOnTop, isAlwaysOnTopSupported, isAutoRequestFocus, isFocusableWindow, isFocusCycleRoot, isFocused, isLocationByPlatform, isOpaque, isShowing, isValidateRoot, pack, paint, removeWindowFocusListener, removeWindowListener, removeWindowStateListener, setAlwaysOnTop, setAutoRequestFocus, setBounds, setBounds, setCursor, setFocusableWindowState, setFocusCycleRoot, setIconImages, setLocation, setLocation, setLocationByPlatform, setLocationRelativeTo, setMinimumSize, setModalExclusionType, setSize, setSize, setType, toBack, toFront

Methods inherited from class java.awt.Container

add, add, add, add, add, addContainerListener, applyComponentOrientation, areFocusTraversalKeysSet, doLayout, findComponentAt, findComponentAt, getAlignmentX, getAlignmentY, getComponent, getComponentAt, getComponentAt, getComponentCount, getComponents, getComponentZOrder, getContainerListeners, getFocusTraversalPolicy, getInsets, getLayout, getMaximumSize, getMinimumSize, getMousePosition, getPreferredSize, invalidate, isAncestorOf, isFocusCycleRoot, isFocusTraversalPolicyProvider, isFocusTraversalPolicySet, list, list, paintComponents, print, printComponents, remove, removeAll, removeContainerListener, setComponentZOrder, setFocusTraversalKeys, setFocusTraversalPolicy, setFocusTraversalPolicyProvider, setFont, transferFocusDownCycle, validate

Methods inherited from class java.awt.Component

add, addComponentListener, addFocusListener, addHierarchyBoundsListener, addHierarchyListener, addInputMethodListener, addKeyListener, addMouseListener, addMouseMotionListener, addMouseWheelListener, checkImage, checkImage, contains, contains, createImage, createImage, createVolatileImage, createVolatileImage, dispatchEvent, enableInputMethods, firePropertyChange, firePropertyChange, firePropertyChange, firePropertyChange, firePropertyChange, firePropertyChange, getBaseline, getBaselineResizeBehavior, getBounds, getBounds, getColorModel, getComponentListeners, getComponentOrientation, getCursor, getDropTarget, getFocusListeners, getFocusTraversalKeysEnabled, getFont, getFontMetrics, getForeground, getGraphicsConfiguration, getHeight, getHierarchyBoundsListeners, getHierarchyListeners, getIgnoreRepaint, getInputMethodListeners, getInputMethodRequests, getKeyListeners, getLocation, getLocation, getLocationOnScreen, getMouseListeners, getMouseMotionListeners, getMousePosition, getMouseWheelListeners, getParent, getPropertyChangeListeners, getPropertyChangeListeners, getSize, getSize, getTreeLock, getWidth, getX, getY, hasFocus, imageUpdate, isBackgroundSet, isCursorSet, isDisplayable, isDoubleBuffered, isEnabled, isFocusable, isFocusOwner, isFontSet, isForegroundSet, isLightweight, isMaximumSizeSet, isMinimumSizeSet, isPreferredSizeSet, isValid, isVisible, list, list, list, paintAll, prepareImage, prepareImage, printAll, removeComponentListener, removeFocusListener, removeHierarchyBoundsListener, removeHierarchyListener, removeInputMethodListener, removeKeyListener, removeMouseListener, removeMouseMotionListener, removeMouseWheelListener, removePropertyChangeListener, removePropertyChangeListener, repaint, repaint, repaint, requestFocus, requestFocus, requestFocusInWindow, requestFocusInWindow, revalidate, setComponentOrientation, setDropTarget, setEnabled, setFocusable, setFocusTraversalKeysEnabled, setForeground, setIgnoreRepaint, setLocale, setMaximumSize, setMixingCutoutShape, setName, setPreferredSize, transferFocus, transferFocusBackward, transferFocusUpCycle

Methods inherited from class java.lang.Object

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

Methods inherited from interface java.awt.MenuContainer

getFont

Constructor Details

OptionFrame

public OptionFrame()

Method Details

frameActionPerformed

public void frameActionPerformed(ActionEvent evt)

Handling user action events.

Parameters:

evt - event

getKnownParameters

public ParameterTemplates getKnownParameters(MappingElementIF me,
 ConfigurationItemIF iItem)
                                      throws M2MException,
RemoteException

Description copied from interface: ConfigurableItemIF

Get the list of all acceptable parameter names.

Specified by:

getKnownParameters in interface ConfigurableItemIF

Parameters:

me - mapping element, maybe null

iItem - configuration item, maybe null

Returns:

list of parameter names

Throws:

M2MException - generic exception

RemoteException - error in communication

RemoteException - exception from remote execution

setConfigurationContext

public void setConfigurationContext(SessionInterface iSession,
 MetaModel sourceMM,
 MetaModel targetMM,
 ConfigurationItemIF iItem)
                             throws M2MException,
RemoteException

Description copied from interface: ConfigurableItemIF

Set the configuration context of this configurable item. The configurable item is configured according the context.

Specified by:

setConfigurationContext in interface ConfigurableItemIF

Parameters:

iSession - session

sourceMM - source meta model

targetMM - target meta model

iItem - Configuration item

Throws:

M2MException - generic exception

RemoteException - exception from remote execution

initialize

public void initialize(LookNFeel iLookNFeel)
                throws AbortException

Description copied from interface: FrameInterface

Initialize the frame (do not make it visible yet).

Specified by:

initialize in interface FrameInterface

Parameters:

iLookNFeel - look and feel of the frame

Throws:

AbortException

setParameter

public void setParameter(String iName,
 String iParam)

Description copied from interface: FrameInterface

Set the parameter of the application. The value maybe interpreted by the application during the run.

Specified by:

setParameter in interface FrameInterface

Parameters:

iParam -

isWaiting

public boolean isWaiting()

Description copied from interface: FrameInterface

Is the frame waiting for the user?

Specified by:

isWaiting in interface FrameInterface

Returns:

true, if the user has to do an action before the frame can be closed

isBackable

public boolean isBackable()

Description copied from interface: FrameInterface

Is the frame a valid target for the "Back" button.

Specified by:

isBackable in interface FrameInterface

Returns:

true, if the frame can be called again

setFirst

public void setFirst()

Description copied from interface: FrameInterface

This is the first frame in the workflow.

Specified by:

setFirst in interface FrameInterface

setLast

public void setLast()

Description copied from interface: FrameInterface

This is the last frame in the workflow.

Specified by:

setLast in interface FrameInterface

setPreEngine

public void setPreEngine()

Description copied from interface: FrameInterface

This is the frame before an engine call.

Specified by:

setPreEngine in interface FrameInterface

frameKeyPerformed

public void frameKeyPerformed(KeyEvent evt)

Handling user key events.

Parameters:

evt - event

windowOpened

public void windowOpened(WindowEvent evt)

Specified by:

windowOpened in interface WindowListener

windowActivated

public void windowActivated(WindowEvent e)

Specified by:

windowActivated in interface WindowListener

windowClosed

public void windowClosed(WindowEvent e)

Specified by:

windowClosed in interface WindowListener

windowClosing

public void windowClosing(WindowEvent e)

Specified by:

windowClosing in interface WindowListener

windowDeactivated

public void windowDeactivated(WindowEvent e)

Specified by:

windowDeactivated in interface WindowListener

windowDeiconified

public void windowDeiconified(WindowEvent e)

Specified by:

windowDeiconified in interface WindowListener

windowIconified

public void windowIconified(WindowEvent e)

Specified by:

windowIconified in interface WindowListener

setVisible

public void setVisible(boolean bVisible)

Description copied from interface: FrameInterface

Make the frame visible or invisible.

Specified by:

setVisible in interface FrameInterface

Overrides:

setVisible in class Window

Parameters:

bVisible - true for visible

mouseDragged

public void mouseDragged(MouseEvent e)

Specified by:

mouseDragged in interface MouseMotionListener

mouseMoved

public void mouseMoved(MouseEvent e)

Specified by:

mouseMoved in interface MouseMotionListener

getParentItem

public ConfigurableItemIF getParentItem()
                                 throws M2MException

Description copied from interface: ConfigurableItemIF

Get the parent of this item.

Specified by:

getParentItem in interface ConfigurableItemIF

Returns:

parent item, if found, else null

Throws:

M2MException - error in communication

getParentItem

public <T extends ConfigurableItemIF> T getParentItem(Class<T> parentClassType)
                                               throws M2MException

Specified by:

getParentItem in interface ConfigurableItemIF

Throws:

M2MException

setParent

public void setParent(ConfigurableItemIF iParent)
               throws M2MException

Description copied from interface: ConfigurableItemIF

Set the parent of this item.

Specified by:

setParent in interface ConfigurableItemIF

Parameters:

iParent - parent item

Throws:

M2MException - error in communication

getId

public Identifier getId()

Description copied from interface: IdentifierAble

Get the identifier of the owning model transformation step.

Specified by:

getId in interface IdentifierAble

Returns:

id

setId

public void setId(Identifier iID)

Description copied from interface: IdentifierAble

Set the identifier.

Specified by:

setId in interface IdentifierAble

Parameters:

iID - id

getName

public String getName()

Description copied from interface: ConfigurableItemIF

Get the name.

Specified by:

getName in interface ConfigurableItemIF

Overrides:

getName in class Component

Returns:

name as given by user in model transformation configuration

toString

public String toString()

Overrides:

toString in class Component

getConfigurationTag

public ConfigurationTag getConfigurationTag()

Description copied from interface: ConfigurableItemIF

Get the type of the configurable item. The type defines the role that the item plays in the execution.

Specified by:

getConfigurationTag in interface ConfigurableItemIF

Returns:

type of the item

setConfigurationTag

public void setConfigurationTag(ConfigurationTag iTag)

Description copied from interface: ConfigurableItemIF

Set the type of the item.

Specified by:

setConfigurationTag in interface ConfigurableItemIF

Parameters:

iTag - type of the item

getBaseItem

public ConfigurationItemIF getBaseItem()

Description copied from interface: ConfigurableItemIF

Configuration item which is the base of this configured item.

Specified by:

getBaseItem in interface ConfigurableItemIF

Returns:

configuration item

setBaseItem

public void setBaseItem(ConfigurationItemIF iItem)

Specified by:

setBaseItem in interface ConfigurableItemIF

getConfigurableItems

public List<ConfigurableItemIF> getConfigurableItems(ConfigurationTag searchTag,
 ConfigurationItemSearchMode mode)
                                              throws M2MException

Specified by:

getConfigurableItems in interface ConfigurableItemIF

Throws:

M2MException

checkConstraints

public boolean checkConstraints(MappingElementIF el,
 ExpressionContext context)
                         throws RemoteException,
M2MException

Description copied from interface: ConfigurableItemIF

Check if all constraints evaluate to true.

Specified by:

checkConstraints in interface ConfigurableItemIF

Parameters:

context - context of evaluation with source and target

Returns:

true, if there are no constraints or all constraints evaluate to true

Throws:

RemoteException - exception from remote execution

M2MException - generic exception

checkConstraints

public boolean checkConstraints(MappingElementIF sourceElement,
 MappingElementList targetElement,
 MappingElementList passedElements,
 MappingElementList bypassedElements)
                         throws RemoteException,
M2MException

Specified by:

checkConstraints in interface ConfigurableItemIF

Throws:

RemoteException

M2MException

getItem

public ConfigurableItemIF getItem(Identifier id)

Description copied from interface: ConfigurableItemIF

Get owned item with this identifier.

Specified by:

getItem in interface ConfigurableItemIF

Parameters:

id - identifier of the item, maybe the identifier of an owned element

Returns:

item if found, else null

close

public void close()

Description copied from interface: FrameInterface

Close the frame.

Specified by:

close in interface FrameInterface