org.apache.uima.tools.docanalyzer

Class AnnotationViewerDialog

java.lang.Object

java.awt.Component

java.awt.Container

java.awt.Window

java.awt.Dialog

javax.swing.JDialog

org.apache.uima.tools.docanalyzer.AnnotationViewerDialog

All Implemented Interfaces:

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

public class AnnotationViewerDialog
extends JDialog
implements ActionListener

Dialog that loads analyzed documents stored in XMI or XCAS format and allows them to be viewed using the Java-based CAS viewer or a web browser, in either an HTML/Javascript format or in the inline XML format.

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

Modifier and Type	Field and Description
protected AnnotationViewGenerator	annotationViewGenerator The annotation view generator.

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
AnnotationViewerDialog(JFrame aParentFrame, String aDialogTitle, PrefsMediator med, File aStyleMapFile, String aPerformanceStats, org.apache.uima.cas.TypeSystem aTypeSystem, String[] aTypesToDisplay, boolean generatedStyleMap, org.apache.uima.cas.CAS cas) Instantiates a new annotation viewer dialog.
AnnotationViewerDialog(JFrame aParentFrame, String aDialogTitle, PrefsMediator med, File aStyleMapFile, String aPerformanceStats, org.apache.uima.cas.TypeSystem aTypeSystem, String[] aTypesToDisplay, String interactiveTempFN, boolean javaViewerRBisSelected, boolean javaViewerUCRBisSelected, boolean xmlRBisSelected, org.apache.uima.cas.CAS cas) Create an AnnotationViewer Dialog.

Method Summary

Modifier and Type	Method and Description
void	actionPerformed(ActionEvent arg0)
void	displayError(String aErrorString) Displays an error message to the user.
void	displayError(Throwable aThrowable) Displays an error message to the user.
void	getColorsForTypesFromFile(CasAnnotationViewer viewer, File aStyleMapFile) Reads in annotation-color associations from stylemap file.
String	getDefaultCasViewName() Gets the name of the CAS View that will be displayed first in the annotation viewer.
static Node	getFirstChildByName(Node node, String name) Gets the first child with a given name.
static String	getTextValue(Node node) Assumes node has a text field and extracts its value.
void	launchThatViewer(String inputDirPath, String fileName, org.apache.uima.cas.TypeSystem typeSystem, String[] aTypesToDisplay, boolean javaViewerRBisSelected, boolean javaViewerUCRBisSelected, boolean xmlRBisSelected, File styleMapFile, File viewerDirectory) Launch that viewer.
protected org.apache.uima.analysis_engine.AnalysisEngineDescription	promptForAE() If the current AE filename is not know ask for it.
void	setDefaultCasViewName(String defaultCasViewName) Sets the name of the CAS View that will be displayed first in the annotation viewer.

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, getPreferredSize, 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

Field Detail

annotationViewGenerator

protected AnnotationViewGenerator annotationViewGenerator

The annotation view generator.

Constructor Detail

AnnotationViewerDialog

public AnnotationViewerDialog(JFrame aParentFrame,
                              String aDialogTitle,
                              PrefsMediator med,
                              File aStyleMapFile,
                              String aPerformanceStats,
                              org.apache.uima.cas.TypeSystem aTypeSystem,
                              String[] aTypesToDisplay,
                              String interactiveTempFN,
                              boolean javaViewerRBisSelected,
                              boolean javaViewerUCRBisSelected,
                              boolean xmlRBisSelected,
                              org.apache.uima.cas.CAS cas)

Create an AnnotationViewer Dialog.

Parameters:

aParentFrame - frame containing this panel

aDialogTitle - title to display for the dialog

med - the med

aStyleMapFile - filename of style map to be used to view files in HTML

aPerformanceStats - string representaiton of performance statistics, optional.

aTypeSystem - the CAS Type System to which the XCAS files must conform.

aTypesToDisplay - array of types that should be highlighted in the viewer. This can be set to the output types of the Analysis Engine. A value of null means to display all types.

interactiveTempFN - the interactive temp FN

javaViewerRBisSelected - the java viewer R bis selected

javaViewerUCRBisSelected - the java viewer UCR bis selected

xmlRBisSelected - the xml R bis selected

cas - the cas

AnnotationViewerDialog

public AnnotationViewerDialog(JFrame aParentFrame,
                              String aDialogTitle,
                              PrefsMediator med,
                              File aStyleMapFile,
                              String aPerformanceStats,
                              org.apache.uima.cas.TypeSystem aTypeSystem,
                              String[] aTypesToDisplay,
                              boolean generatedStyleMap,
                              org.apache.uima.cas.CAS cas)

Instantiates a new annotation viewer dialog.

Parameters:

aParentFrame - the a parent frame

aDialogTitle - the a dialog title

med - the med

aStyleMapFile - the a style map file

aPerformanceStats - the a performance stats

aTypeSystem - the a type system

aTypesToDisplay - the a types to display

generatedStyleMap - the generated style map

cas - the cas

Method Detail

actionPerformed

public void actionPerformed(ActionEvent arg0)

Specified by:

actionPerformed in interface ActionListener

getDefaultCasViewName

public String getDefaultCasViewName()

Gets the name of the CAS View that will be displayed first in the annotation viewer.

Returns:

the default cas view name

setDefaultCasViewName

public void setDefaultCasViewName(String defaultCasViewName)

Sets the name of the CAS View that will be displayed first in the annotation viewer. It not set, defaults to CAS.NAME_DEFAULT_SOFA.

Parameters:

defaultCasViewName - the new default cas view name

launchThatViewer

public void launchThatViewer(String inputDirPath,
                             String fileName,
                             org.apache.uima.cas.TypeSystem typeSystem,
                             String[] aTypesToDisplay,
                             boolean javaViewerRBisSelected,
                             boolean javaViewerUCRBisSelected,
                             boolean xmlRBisSelected,
                             File styleMapFile,
                             File viewerDirectory)

Launch that viewer.

Parameters:

inputDirPath - the input dir path

fileName - the file name

typeSystem - the type system

aTypesToDisplay - the a types to display

javaViewerRBisSelected - the java viewer R bis selected

javaViewerUCRBisSelected - the java viewer UCR bis selected

xmlRBisSelected - the xml R bis selected

styleMapFile - the style map file

viewerDirectory - the viewer directory

getTextValue

public static String getTextValue(Node node)

Assumes node has a text field and extracts its value. JMP

Parameters:

node - the node

Returns:

the text value

getFirstChildByName

public static Node getFirstChildByName(Node node,
                                       String name)

Gets the first child with a given name. JMP

Parameters:

node - the node

name - the name

Returns:

the first child by name

getColorsForTypesFromFile

public void getColorsForTypesFromFile(CasAnnotationViewer viewer,
                                      File aStyleMapFile)

Reads in annotation-color associations from stylemap file. JMP Also reads checked value if present.

Parameters:

viewer - the viewer

aStyleMapFile - the a style map file

displayError

public void displayError(String aErrorString)

Displays an error message to the user.

Parameters:

aErrorString - error message to display

displayError

public void displayError(Throwable aThrowable)

Displays an error message to the user.

Parameters:

aThrowable - Throwable whose message is to be displayed.

promptForAE

protected org.apache.uima.analysis_engine.AnalysisEngineDescription promptForAE()
                                                                         throws IOException,
                                                                                org.apache.uima.util.InvalidXMLException,
                                                                                org.apache.uima.resource.ResourceInitializationException

If the current AE filename is not know ask for it. Then parse the selected file and return the AnalysisEngineDescription object.

Returns:

the selected AnalysisEngineDescription, null if the user cancelled

Throws:

IOException - Signals that an I/O exception has occurred.

org.apache.uima.util.InvalidXMLException - the invalid XML exception

org.apache.uima.resource.ResourceInitializationException - the resource initialization exception