Class CasTreeViewer

  • All Implemented Interfaces:
    java.awt.image.ImageObserver, java.awt.MenuContainer, java.io.Serializable, javax.accessibility.Accessible

    public class CasTreeViewer
    extends javax.swing.JPanel
    A GUI that displays annotation results in a Swing tree viewer. This class extends JPanel and so can be reused within any Swing application.
    See Also:
    Serialized Form
    • Nested Class Summary

      Nested Classes 
      Modifier and Type Class Description
      (package private) static class  CasTreeViewer.AnnotationTreeNodeObject
      Inner class containing data for a node in the tree.
      • Nested classes/interfaces inherited from class javax.swing.JPanel

        javax.swing.JPanel.AccessibleJPanel
      • Nested classes/interfaces inherited from class javax.swing.JComponent

        javax.swing.JComponent.AccessibleJComponent
      • 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
      private javax.swing.JTextPane annotationTextPane
      The annotation text pane.
      private javax.swing.JLabel annotationTypeLabel
      The annotation type label.
      private javax.swing.JTable featureTable
      The feature table.
      private javax.swing.JPanel rightPanel
      The right panel.
      private static long serialVersionUID
      The Constant serialVersionUID.
      private javax.swing.JSplitPane splitPane
      The split pane.
      private javax.swing.JTree tree
      The tree.
      • Fields inherited from class javax.swing.JComponent

        listenerList, TOOL_TIP_TEXT_KEY, ui, UNDEFINED_CONDITION, WHEN_ANCESTOR_OF_FOCUSED_COMPONENT, WHEN_FOCUSED, WHEN_IN_FOCUSED_WINDOW
      • Fields inherited from class java.awt.Component

        accessibleContext, 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
    • Constructor Summary

      Constructors 
      Constructor Description
      CasTreeViewer​(CAS aCAS)
      Creates a CAS Tree Viewer.
    • Method Summary

      All Methods Static Methods Instance Methods Concrete Methods 
      Modifier and Type Method Description
      private void _buildTree​(javax.swing.tree.DefaultMutableTreeNode aParentNode, FSIterator aIterator, int aStartPos, int aEndPos)
      Recursive method called by buildTree(DefaultMutableTreeNode,FSIterator).
      private javax.swing.tree.TreeNode buildTree​(CAS aCAS)
      Builds a tree from a CAS.
      private static java.lang.String getText​(java.lang.String text)
      Gets text to be processed by the TAE.
      static void main​(java.lang.String[] args)
      Main program.
      private static void printUsageMessage()
      Prints usage message.
      private void refreshAnnotationData​(AnnotationFS aAnnotation)
      Called when the user selects a new node in the JTree.
      void setSize​(java.awt.Dimension d)
      Sets the size.
      • Methods inherited from class javax.swing.JPanel

        getAccessibleContext, getUI, getUIClassID, paramString, setUI, updateUI
      • Methods inherited from class javax.swing.JComponent

        addAncestorListener, addNotify, addVetoableChangeListener, computeVisibleRect, contains, createToolTip, disable, enable, firePropertyChange, firePropertyChange, firePropertyChange, fireVetoableChange, getActionForKeyStroke, getActionMap, getAlignmentX, getAlignmentY, getAncestorListeners, getAutoscrolls, getBaseline, getBaselineResizeBehavior, getBorder, getBounds, getClientProperty, getComponentGraphics, getComponentPopupMenu, getConditionForKeyStroke, getDebugGraphicsOptions, getDefaultLocale, getFontMetrics, getGraphics, getHeight, getInheritsPopupMenu, getInputMap, getInputMap, getInputVerifier, getInsets, getInsets, getListeners, getLocation, getMaximumSize, getMinimumSize, getNextFocusableComponent, getPopupLocation, getPreferredSize, getRegisteredKeyStrokes, getRootPane, getSize, getToolTipLocation, getToolTipText, getToolTipText, getTopLevelAncestor, getTransferHandler, getVerifyInputWhenFocusTarget, getVetoableChangeListeners, getVisibleRect, getWidth, getX, getY, grabFocus, hide, isDoubleBuffered, isLightweightComponent, isManagingFocus, isOpaque, isOptimizedDrawingEnabled, isPaintingForPrint, isPaintingOrigin, isPaintingTile, isRequestFocusEnabled, isValidateRoot, paint, paintBorder, paintChildren, paintComponent, paintImmediately, paintImmediately, print, printAll, printBorder, printChildren, printComponent, processComponentKeyEvent, processKeyBinding, processKeyEvent, processMouseEvent, processMouseMotionEvent, putClientProperty, registerKeyboardAction, registerKeyboardAction, removeAncestorListener, removeNotify, removeVetoableChangeListener, repaint, repaint, requestDefaultFocus, requestFocus, requestFocus, requestFocusInWindow, requestFocusInWindow, resetKeyboardActions, reshape, revalidate, scrollRectToVisible, setActionMap, setAlignmentX, setAlignmentY, setAutoscrolls, setBackground, setBorder, setComponentPopupMenu, setDebugGraphicsOptions, setDefaultLocale, setDoubleBuffered, setEnabled, setFocusTraversalKeys, setFont, setForeground, setInheritsPopupMenu, setInputMap, setInputVerifier, setMaximumSize, setMinimumSize, setNextFocusableComponent, setOpaque, setPreferredSize, setRequestFocusEnabled, setToolTipText, setTransferHandler, setUI, setVerifyInputWhenFocusTarget, setVisible, unregisterKeyboardAction, update
      • Methods inherited from class java.awt.Container

        add, add, add, add, add, addContainerListener, addImpl, addPropertyChangeListener, addPropertyChangeListener, applyComponentOrientation, areFocusTraversalKeysSet, countComponents, deliverEvent, doLayout, findComponentAt, findComponentAt, getComponent, getComponentAt, getComponentAt, getComponentCount, getComponents, getComponentZOrder, getContainerListeners, getFocusTraversalKeys, getFocusTraversalPolicy, getLayout, getMousePosition, insets, invalidate, isAncestorOf, isFocusCycleRoot, isFocusCycleRoot, isFocusTraversalPolicyProvider, isFocusTraversalPolicySet, layout, list, list, locate, minimumSize, paintComponents, preferredSize, printComponents, processContainerEvent, processEvent, remove, remove, removeAll, removeContainerListener, setComponentZOrder, setFocusCycleRoot, setFocusTraversalPolicy, setFocusTraversalPolicyProvider, setLayout, 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, createImage, createImage, createVolatileImage, createVolatileImage, disableEvents, dispatchEvent, enable, enableEvents, enableInputMethods, firePropertyChange, firePropertyChange, firePropertyChange, firePropertyChange, firePropertyChange, firePropertyChange, getBackground, getBounds, getColorModel, getComponentListeners, getComponentOrientation, getCursor, getDropTarget, getFocusCycleRootAncestor, getFocusListeners, getFocusTraversalKeysEnabled, getFont, getForeground, getGraphicsConfiguration, getHierarchyBoundsListeners, getHierarchyListeners, getIgnoreRepaint, getInputContext, getInputMethodListeners, getInputMethodRequests, getKeyListeners, getLocale, getLocation, getLocationOnScreen, getMouseListeners, getMouseMotionListeners, getMousePosition, getMouseWheelListeners, getName, getParent, getPeer, getPropertyChangeListeners, getPropertyChangeListeners, getSize, getToolkit, getTreeLock, gotFocus, handleEvent, hasFocus, imageUpdate, inside, isBackgroundSet, isCursorSet, isDisplayable, isEnabled, isFocusable, isFocusOwner, isFocusTraversable, isFontSet, isForegroundSet, isLightweight, isMaximumSizeSet, isMinimumSizeSet, isPreferredSizeSet, isShowing, isValid, isVisible, keyDown, keyUp, list, list, list, location, lostFocus, mouseDown, mouseDrag, mouseEnter, mouseExit, mouseMove, mouseUp, move, nextFocus, paintAll, postEvent, prepareImage, prepareImage, processComponentEvent, processFocusEvent, processHierarchyBoundsEvent, processHierarchyEvent, processInputMethodEvent, processMouseWheelEvent, remove, removeComponentListener, removeFocusListener, removeHierarchyBoundsListener, removeHierarchyListener, removeInputMethodListener, removeKeyListener, removeMouseListener, removeMouseMotionListener, removeMouseWheelListener, removePropertyChangeListener, removePropertyChangeListener, repaint, repaint, repaint, resize, resize, setBounds, setBounds, setComponentOrientation, setCursor, setDropTarget, setFocusable, setFocusTraversalKeysEnabled, setIgnoreRepaint, setLocale, setLocation, setLocation, setName, setSize, show, 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
      • splitPane

        private javax.swing.JSplitPane splitPane
        The split pane.
      • tree

        private javax.swing.JTree tree
        The tree.
      • rightPanel

        private javax.swing.JPanel rightPanel
        The right panel.
      • annotationTypeLabel

        private javax.swing.JLabel annotationTypeLabel
        The annotation type label.
      • annotationTextPane

        private javax.swing.JTextPane annotationTextPane
        The annotation text pane.
      • featureTable

        private javax.swing.JTable featureTable
        The feature table.
    • Constructor Detail

      • CasTreeViewer

        public CasTreeViewer​(CAS aCAS)
                      throws CASException
        Creates a CAS Tree Viewer.
        Parameters:
        aCAS - the CAS containing the annotations to be displayed in the tree viewer GUI
        Throws:
        CASException - the CAS exception
    • Method Detail

      • refreshAnnotationData

        private void refreshAnnotationData​(AnnotationFS aAnnotation)
        Called when the user selects a new node in the JTree. Refreshes the right pane to display information about the selected annotation.
        Parameters:
        aAnnotation - the annotation that was selected in the JTree
      • buildTree

        private javax.swing.tree.TreeNode buildTree​(CAS aCAS)
                                             throws CASException
        Builds a tree from a CAS.
        Parameters:
        aCAS - CAS from which annotations will be extracted
        Returns:
        the tree node
        Throws:
        CASException - the CAS exception
      • _buildTree

        private void _buildTree​(javax.swing.tree.DefaultMutableTreeNode aParentNode,
                                FSIterator aIterator,
                                int aStartPos,
                                int aEndPos)
        Recursive method called by buildTree(DefaultMutableTreeNode,FSIterator).
        Parameters:
        aParentNode - root node of tree to be built
        aIterator - iterator over all annotation in CAS
        aStartPos - text position at which to begin processing
        aEndPos - text position at which to end processing
      • main

        public static void main​(java.lang.String[] args)
        Main program. Runs a TAE and displays the resulting annotations in the tree viewer.
        Parameters:
        args - Command-line arguments - two are reguired: the path to the TAE descriptor and a file to be analyzed.
      • getText

        private static java.lang.String getText​(java.lang.String text)
        Gets text to be processed by the TAE. If the document contains XML tags named TEXT like this: <TEXT%gt;Process this text.</TEXT%gt;, then only the text within those tags is returned. Otherwise the whole document is returned.
        Parameters:
        text - the text
        Returns:
        the text
      • printUsageMessage

        private static void printUsageMessage()
        Prints usage message.
      • setSize

        public void setSize​(java.awt.Dimension d)
        Sets the size.
        Overrides:
        setSize in class java.awt.Component
        Parameters:
        d - the new size
        See Also:
        Component.setSize(Dimension)