Class AnnotationViewerDialog

  • All Implemented Interfaces:
    java.awt.event.ActionListener, java.awt.image.ImageObserver, java.awt.MenuContainer, java.io.Serializable, java.util.EventListener, javax.accessibility.Accessible, javax.swing.RootPaneContainer, javax.swing.WindowConstants

    public class AnnotationViewerDialog
    extends javax.swing.JDialog
    implements java.awt.event.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

        javax.swing.JDialog.AccessibleJDialog
      • Nested classes/interfaces inherited from class java.awt.Dialog

        java.awt.Dialog.AccessibleAWTDialog, java.awt.Dialog.ModalExclusionType, java.awt.Dialog.ModalityType
      • Nested classes/interfaces inherited from class java.awt.Window

        java.awt.Window.AccessibleAWTWindow, java.awt.Window.Type
      • Nested classes/interfaces inherited from class java.awt.Container

        java.awt.Container.AccessibleAWTContainer
      • Nested classes/interfaces inherited from class java.awt.Component

        java.awt.Component.AccessibleAWTComponent, java.awt.Component.BaselineResizeBehavior, java.awt.Component.BltBufferStrategy, java.awt.Component.FlipBufferStrategy
    • Field Summary

      Fields 
      Modifier and Type Field Description
      protected AnnotationViewGenerator annotationViewGenerator  
      • 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 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
      AnnotationViewerDialog​(javax.swing.JFrame aParentFrame, java.lang.String aDialogTitle, PrefsMediator med, java.io.File aStyleMapFile, java.lang.String aPerformanceStats, TypeSystem aTypeSystem, java.lang.String[] aTypesToDisplay, boolean generatedStyleMap, CAS cas)  
      AnnotationViewerDialog​(javax.swing.JFrame aParentFrame, java.lang.String aDialogTitle, PrefsMediator med, java.io.File aStyleMapFile, java.lang.String aPerformanceStats, TypeSystem aTypeSystem, java.lang.String[] aTypesToDisplay, java.lang.String interactiveTempFN, boolean javaViewerRBisSelected, boolean javaViewerUCRBisSelected, boolean xmlRBisSelected, CAS cas)
      Create an AnnotationViewer Dialog
    • Method Summary

      All Methods Static Methods Instance Methods Concrete Methods 
      Modifier and Type Method Description
      void actionPerformed​(java.awt.event.ActionEvent arg0)  
      void displayError​(java.lang.String aErrorString)
      Displays an error message to the user.
      void displayError​(java.lang.Throwable aThrowable)
      Displays an error message to the user.
      void getColorsForTypesFromFile​(CasAnnotationViewer viewer, java.io.File aStyleMapFile)
      Reads in annotation-color associations from stylemap file.
      java.lang.String getDefaultCasViewName()
      Gets the name of the CAS View that will be displayed first in the annotation viewer.
      static org.w3c.dom.Node getFirstChildByName​(org.w3c.dom.Node node, java.lang.String name)
      Gets the first child with a given name.
      static java.lang.String getTextValue​(org.w3c.dom.Node node)
      Assumes node has a text field and extracts its value.
      void launchThatViewer​(java.lang.String inputDirPath, java.lang.String fileName, TypeSystem typeSystem, java.lang.String[] aTypesToDisplay, boolean javaViewerRBisSelected, boolean javaViewerUCRBisSelected, boolean xmlRBisSelected, java.io.File styleMapFile, java.io.File viewerDirectory)  
      protected AnalysisEngineDescription promptForAE()
      If the current AE filename is not know ask for it.
      void setDefaultCasViewName​(java.lang.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, 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, requestFocus, requestFocus, requestFocusInWindow, requestFocusInWindow, requestFocusInWindow, resize, resize, revalidate, setComponentOrientation, setDropTarget, setEnabled, setFocusable, setFocusTraversalKeysEnabled, setForeground, setIgnoreRepaint, setLocale, setMaximumSize, setMixingCutoutShape, 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

      • AnnotationViewerDialog

        public AnnotationViewerDialog​(javax.swing.JFrame aParentFrame,
                                      java.lang.String aDialogTitle,
                                      PrefsMediator med,
                                      java.io.File aStyleMapFile,
                                      java.lang.String aPerformanceStats,
                                      TypeSystem aTypeSystem,
                                      java.lang.String[] aTypesToDisplay,
                                      java.lang.String interactiveTempFN,
                                      boolean javaViewerRBisSelected,
                                      boolean javaViewerUCRBisSelected,
                                      boolean xmlRBisSelected,
                                      CAS cas)
        Create an AnnotationViewer Dialog
        Parameters:
        aParentFrame - frame containing this panel
        aDialogTitle - title to display for the dialog
        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 -
        javaViewerRBisSelected -
        javaViewerUCRBisSelected -
        xmlRBisSelected -
        cas -
      • AnnotationViewerDialog

        public AnnotationViewerDialog​(javax.swing.JFrame aParentFrame,
                                      java.lang.String aDialogTitle,
                                      PrefsMediator med,
                                      java.io.File aStyleMapFile,
                                      java.lang.String aPerformanceStats,
                                      TypeSystem aTypeSystem,
                                      java.lang.String[] aTypesToDisplay,
                                      boolean generatedStyleMap,
                                      CAS cas)
    • Method Detail

      • actionPerformed

        public void actionPerformed​(java.awt.event.ActionEvent arg0)
        Specified by:
        actionPerformed in interface java.awt.event.ActionListener
      • getDefaultCasViewName

        public java.lang.String getDefaultCasViewName()
        Gets the name of the CAS View that will be displayed first in the annotation viewer.
      • setDefaultCasViewName

        public void setDefaultCasViewName​(java.lang.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.
      • launchThatViewer

        public void launchThatViewer​(java.lang.String inputDirPath,
                                     java.lang.String fileName,
                                     TypeSystem typeSystem,
                                     java.lang.String[] aTypesToDisplay,
                                     boolean javaViewerRBisSelected,
                                     boolean javaViewerUCRBisSelected,
                                     boolean xmlRBisSelected,
                                     java.io.File styleMapFile,
                                     java.io.File viewerDirectory)
      • getTextValue

        public static java.lang.String getTextValue​(org.w3c.dom.Node node)
        Assumes node has a text field and extracts its value. JMP
      • getFirstChildByName

        public static org.w3c.dom.Node getFirstChildByName​(org.w3c.dom.Node node,
                                                           java.lang.String name)
        Gets the first child with a given name. JMP
      • getColorsForTypesFromFile

        public void getColorsForTypesFromFile​(CasAnnotationViewer viewer,
                                              java.io.File aStyleMapFile)
        Reads in annotation-color associations from stylemap file. JMP Also reads checked value if present.
      • displayError

        public void displayError​(java.lang.String aErrorString)
        Displays an error message to the user.
        Parameters:
        aErrorString - error message to display
      • displayError

        public void displayError​(java.lang.Throwable aThrowable)
        Displays an error message to the user.
        Parameters:
        aThrowable - Throwable whose message is to be displayed.