org.apache.uima.tools.stylemap

Class StyleMapEditor

java.lang.Object

java.awt.Component

java.awt.Container

java.awt.Window

java.awt.Dialog

javax.swing.JDialog

org.apache.uima.tools.stylemap.StyleMapEditor

All Implemented Interfaces:

ActionListener, ImageObserver, MenuContainer, Serializable, EventListener, Accessible, RootPaneContainer, WindowConstants

public class StyleMapEditor
extends JDialog
implements ActionListener

A GUI for editing style maps for the annotation viewer.

A style map is an XML document that describes how each kind of output from a Text Analysis Engine is to be displayed in the annotation viewer. Each output type that the user wants to be displayed will have an entry in the style map. Each entry in the style map contains:

• The CSS style used to display annotations of that type (for example "background:blue; color:white;" to display white text on a blue background.
• A label used to identify the annotations in the annotation viewer

To invoke the editor, call the launchEditor(AnalysisEngineMetaData, String, CAS) method.

See Also:

Serialized Form

Nested Class Summary

Nested classes/interfaces inherited from class javax.swing.JDialog

JDialog.AccessibleJDialog

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

Dialog.AccessibleAWTDialog, Dialog.ModalExclusionType, Dialog.ModalityType

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

Window.AccessibleAWTWindow, Window.Type

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

Container.AccessibleAWTContainer

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

Component.AccessibleAWTComponent, Component.BaselineResizeBehavior, Component.BltBufferStrategy, Component.FlipBufferStrategy

Field Summary

Fields inherited from class javax.swing.JDialog

accessibleContext, rootPane, rootPaneCheckingEnabled

Fields inherited from class java.awt.Dialog

DEFAULT_MODALITY_TYPE

Fields inherited from class java.awt.Component

BOTTOM_ALIGNMENT, CENTER_ALIGNMENT, LEFT_ALIGNMENT, RIGHT_ALIGNMENT, TOP_ALIGNMENT

Fields inherited from interface javax.swing.WindowConstants

DISPOSE_ON_CLOSE, DO_NOTHING_ON_CLOSE, EXIT_ON_CLOSE, HIDE_ON_CLOSE

Fields inherited from interface java.awt.image.ImageObserver

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

Constructor Summary

Constructors

Constructor and Description
StyleMapEditor(JFrame aOwner, org.apache.uima.cas.CAS cas) Creates a new `Editor.

Method Summary

Modifier and Type	Method and Description
void	actionPerformed(ActionEvent evt)
void	addRow(String typeName) Adds the row.
ArrayList	createStyleList(org.apache.uima.analysis_engine.metadata.AnalysisEngineMetaData aAnalysisEngineMetaData, String aStyleMapXml) Creates a List of StyleMapEntry objects from the given AnalysisEngineMetaData and style map XML.
protected StyleMapTable	getAnnotationsTable() Gets the annotations table.
Dimension	getPreferredSize()
String	launchEditor(org.apache.uima.analysis_engine.metadata.AnalysisEngineMetaData aAnalysisEngineMetaData, String aStyleMapXml, org.apache.uima.cas.CAS cas) Displays the StyleMapEditor GUI and allows the user to edit a style map.
ArrayList	parseStyleList(String aStyleMapXml) Parses the style list.
void	setAnalysisEngine(org.apache.uima.analysis_engine.AnalysisEngineDescription ae) Sets the analysis engine.
void	setTextAnalysisEngine(org.apache.uima.analysis_engine.TaeDescription tae) Deprecated. use setAnalysisEngine(AnalysisEngineDescription) instead.

Methods inherited from class javax.swing.JDialog

addImpl, createRootPane, dialogInit, getAccessibleContext, getContentPane, getDefaultCloseOperation, getGlassPane, getGraphics, getJMenuBar, getLayeredPane, getRootPane, getTransferHandler, isDefaultLookAndFeelDecorated, isRootPaneCheckingEnabled, paramString, processWindowEvent, remove, repaint, setContentPane, setDefaultCloseOperation, setDefaultLookAndFeelDecorated, setGlassPane, setJMenuBar, setLayeredPane, setLayout, setRootPane, setRootPaneCheckingEnabled, setTransferHandler, update

Methods inherited from class java.awt.Dialog

addNotify, getModalityType, getTitle, hide, isModal, isResizable, isUndecorated, setBackground, setModal, setModalityType, setOpacity, setResizable, setShape, setTitle, setUndecorated, setVisible, show, toBack

Methods inherited from class java.awt.Window

addPropertyChangeListener, addPropertyChangeListener, addWindowFocusListener, addWindowListener, addWindowStateListener, applyResourceBundle, applyResourceBundle, 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, postEvent, processEvent, processWindowFocusEvent, processWindowStateEvent, removeNotify, removeWindowFocusListener, removeWindowListener, removeWindowStateListener, reshape, setAlwaysOnTop, setAutoRequestFocus, setBounds, setBounds, setCursor, setFocusableWindowState, setFocusCycleRoot, setIconImage, setIconImages, setLocation, setLocation, setLocationByPlatform, setLocationRelativeTo, setMinimumSize, setModalExclusionType, setSize, setSize, setType, toFront

Methods inherited from class java.awt.Container

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

Methods inherited from class java.awt.Component

action, add, addComponentListener, addFocusListener, addHierarchyBoundsListener, addHierarchyListener, addInputMethodListener, addKeyListener, addMouseListener, addMouseMotionListener, addMouseWheelListener, bounds, checkImage, checkImage, coalesceEvents, contains, contains, createImage, createImage, createVolatileImage, createVolatileImage, disable, disableEvents, dispatchEvent, enable, enable, enableEvents, enableInputMethods, firePropertyChange, firePropertyChange, firePropertyChange, 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, getName, getParent, getPeer, getPropertyChangeListeners, getPropertyChangeListeners, getSize, getSize, getTreeLock, getWidth, getX, getY, gotFocus, handleEvent, hasFocus, imageUpdate, inside, isBackgroundSet, isCursorSet, isDisplayable, isDoubleBuffered, isEnabled, isFocusable, isFocusOwner, isFocusTraversable, isFontSet, isForegroundSet, isLightweight, isMaximumSizeSet, isMinimumSizeSet, isPreferredSizeSet, isValid, isVisible, keyDown, keyUp, list, list, list, location, lostFocus, mouseDown, mouseDrag, mouseEnter, mouseExit, mouseMove, mouseUp, move, nextFocus, paintAll, prepareImage, prepareImage, printAll, processComponentEvent, processFocusEvent, processHierarchyBoundsEvent, processHierarchyEvent, processInputMethodEvent, processKeyEvent, processMouseEvent, processMouseMotionEvent, processMouseWheelEvent, remove, removeComponentListener, removeFocusListener, removeHierarchyBoundsListener, removeHierarchyListener, removeInputMethodListener, removeKeyListener, removeMouseListener, removeMouseMotionListener, removeMouseWheelListener, removePropertyChangeListener, removePropertyChangeListener, repaint, repaint, repaint, requestFocus, requestFocus, requestFocusInWindow, requestFocusInWindow, resize, resize, revalidate, setComponentOrientation, setDropTarget, setEnabled, setFocusable, setFocusTraversalKeysEnabled, setForeground, setIgnoreRepaint, setLocale, setMaximumSize, setName, setPreferredSize, show, size, toString, transferFocus, transferFocusBackward, transferFocusUpCycle

Methods inherited from class java.lang.Object

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

Constructor Detail

StyleMapEditor

public StyleMapEditor(JFrame aOwner,
                      org.apache.uima.cas.CAS cas)

Creates a new `Editor.

Parameters:

aOwner - the a owner

cas - the cas

Method Detail

getPreferredSize

public Dimension getPreferredSize()

Overrides:

getPreferredSize in class Container

setTextAnalysisEngine

@Deprecated
public void setTextAnalysisEngine(org.apache.uima.analysis_engine.TaeDescription tae)

Deprecated. use setAnalysisEngine(AnalysisEngineDescription) instead.

Sets the text analysis engine.

Parameters:

tae - the new text analysis engine

setAnalysisEngine

public void setAnalysisEngine(org.apache.uima.analysis_engine.AnalysisEngineDescription ae)

Sets the analysis engine.

Parameters:

ae - the new analysis engine

launchEditor

public String launchEditor(org.apache.uima.analysis_engine.metadata.AnalysisEngineMetaData aAnalysisEngineMetaData,
                           String aStyleMapXml,
                           org.apache.uima.cas.CAS cas)

Displays the StyleMapEditor GUI and allows the user to edit a style map. When the user has finished, the new style map is returned.

Parameters:

aAnalysisEngineMetaData - Metadata for the AnalysisEngine whose style map is to be edited. This contains the AE's capabilities and type system definition, which are needed by the editor.

aStyleMapXml - An existing style map XML document that will be loaded into the editor. This is optional, if null is passed in, a default style map will be automatically generated from the AE metadata.

cas - the cas

Returns:

a new style map XML document. If the user cancels, null is returned.

createStyleList

public ArrayList createStyleList(org.apache.uima.analysis_engine.metadata.AnalysisEngineMetaData aAnalysisEngineMetaData,
                                 String aStyleMapXml)

Creates a List of StyleMapEntry objects from the given AnalysisEngineMetaData and style map XML.

Parameters:

aAnalysisEngineMetaData - Metadata for the AnalysisEngine whose style map is being edited.

aStyleMapXml - An existing style map XML document. This is optional, if null is passed in, a default style map will be automatically generated.

Returns:

an ArrayList containing one StyleMapEntry object for each output type declared in aTaeMetaData.

parseStyleList

public ArrayList parseStyleList(String aStyleMapXml)

Parses the style list.

Parameters:

aStyleMapXml - the a style map xml

Returns:

the array list

actionPerformed

public void actionPerformed(ActionEvent evt)

Specified by:

actionPerformed in interface ActionListener

getAnnotationsTable

protected StyleMapTable getAnnotationsTable()

Gets the annotations table.

Returns:

the annotations table

addRow

public void addRow(String typeName)

Adds the row.

Parameters:

typeName - the type name