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 
      Modifier and Type Class Description
      (package private) static class  AnnotationViewerDialog.InteractiveFilter
      Filter to not show the two interactive-mode directories in the file list.
      (package private) class  AnnotationViewerDialog.ListMouseAdapter
      The Class ListMouseAdapter.
      (package private) static class  AnnotationViewerDialog.MyListCellRenderer
      The Class MyListCellRenderer.
      • 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
      (package private) javax.swing.JList<java.lang.String> analyzedResultsList
      the list of analyzed results
      protected AnnotationViewGenerator annotationViewGenerator
      The annotation view generator.
      private CAS cas
      The cas.
      private java.lang.String defaultCasViewName
      The default cas view name.
      (package private) javax.swing.JRadioButton htmlRB
      The html RB.
      (package private) java.lang.String inputDirPath
      The input dir path.
      (package private) javax.swing.JRadioButton javaViewerRB
      The java viewer RB.
      (package private) javax.swing.JRadioButton javaViewerUCRB
      The java viewer UCRB.
      private PrefsMediator med1
      The med 1.
      private boolean processedStyleMap
      The processed style map.
      private static long serialVersionUID
      The Constant serialVersionUID.
      private StyleMapEditor styleMapEditor
      The style map editor.
      private java.io.File styleMapFile
      The style map file.
      private java.io.File tempDir
      The temp dir.
      (package private) java.lang.String[] typesToDisplay
      The types to display.
      (package private) TypeSystem typeSystem
      The type system.
      (package private) javax.swing.JRadioButton xmlRB
      The xml RB.
      • 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)
      Instantiates a new annotation viewer dialog.
      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)  
      private java.io.File createTempDir()
      Creates the temp dir.
      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)
      Launch that viewer.
      protected AnalysisEngineDescription promptForAE()
      If the current AE filename is not know ask for it.
      private void resetFiles​(java.lang.String filenameFilter)  
      void setDefaultCasViewName​(java.lang.String defaultCasViewName)
      Sets the name of the CAS View that will be displayed first in the annotation viewer.
      private static void setLF()
      set default look and feel.
      • 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

      • serialVersionUID

        private static final long serialVersionUID
        The Constant serialVersionUID.
        See Also:
        Constant Field Values
      • tempDir

        private java.io.File tempDir
        The temp dir.
      • annotationViewGenerator

        protected AnnotationViewGenerator annotationViewGenerator
        The annotation view generator.
      • styleMapEditor

        private StyleMapEditor styleMapEditor
        The style map editor.
      • styleMapFile

        private java.io.File styleMapFile
        The style map file.
      • analyzedResultsList

        javax.swing.JList<java.lang.String> analyzedResultsList
        the list of analyzed results
      • inputDirPath

        java.lang.String inputDirPath
        The input dir path.
      • typeSystem

        TypeSystem typeSystem
        The type system.
      • typesToDisplay

        java.lang.String[] typesToDisplay
        The types to display.
      • javaViewerRB

        javax.swing.JRadioButton javaViewerRB
        The java viewer RB.
      • javaViewerUCRB

        javax.swing.JRadioButton javaViewerUCRB
        The java viewer UCRB.
      • htmlRB

        javax.swing.JRadioButton htmlRB
        The html RB.
      • xmlRB

        javax.swing.JRadioButton xmlRB
        The xml RB.
      • cas

        private CAS cas
        The cas.
      • processedStyleMap

        private boolean processedStyleMap
        The processed style map.
      • defaultCasViewName

        private java.lang.String defaultCasViewName
        The default cas view name.
    • 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 - 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​(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)
        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

      • resetFiles

        private void resetFiles​(java.lang.String filenameFilter)
      • 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.
        Returns:
        the default cas view name
      • 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.
        Parameters:
        defaultCasViewName - the new default cas view name
      • 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)
        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 java.lang.String getTextValue​(org.w3c.dom.Node node)
        Assumes node has a text field and extracts its value. JMP
        Parameters:
        node - the node
        Returns:
        the text value
      • 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
        Parameters:
        node - the node
        name - the name
        Returns:
        the first child by name
      • 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.
        Parameters:
        viewer - the viewer
        aStyleMapFile - the a style map file
      • 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.
      • setLF

        private static void setLF()
        set default look and feel.
      • createTempDir

        private java.io.File createTempDir()
        Creates the temp dir.
        Returns:
        the file