Package org.apache.uima.tools.docanalyzer

Class DocumentAnalyzer

  • 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, BaseStatusCallbackListener, StatusCallbackListener
    public class DocumentAnalyzer
extends javax.swing.JFrame
implements StatusCallbackListener, java.awt.event.ActionListener
    A simple GUI for the RunTextAnalysis application library. Note that currently this will only run under Windows since it relies on Windows-specific commands for invoking a web browser to view the annotated documents.
    See Also:
    Serialized Form

    • Nested Class Summary

      Nested Classes 
      Modifier and Type Class Description
      (package private) class  DocumentAnalyzer.ProcessingThread
      The Class ProcessingThread.
      (package private) class  DocumentAnalyzer.TextAreaViewer
      Class for dialog in which user types in text to be analyzed, and sets browser parameters.

      • Nested classes/interfaces inherited from class javax.swing.JFrame

        javax.swing.JFrame.AccessibleJFrame

      • Nested classes/interfaces inherited from class java.awt.Frame

        java.awt.Frame.AccessibleAWTFrame

      • 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

    • Constructor Summary

      Constructors 
      Constructor Description
      DocumentAnalyzer()
      Constructor.
      DocumentAnalyzer​(java.lang.String outputFileSelected, boolean interactiveDA, boolean jvucrbis)
      Instantiates a new document analyzer.

    • Method Summary

      All Methods Static Methods Instance Methods Concrete Methods 
      Modifier and Type Method Description
      void aborted()
      Aborted.
      void actionPerformed​(java.awt.event.ActionEvent e)  
      void analyzeDocuments​(java.lang.String analysisText)
      Invokes the RunTextAnalysis application library that actually analyzes the documents and generates the output.
      void analyzeInputarea()
      JMP addition Opens a dialog for the user to enter text, which will be saved to a file and then processed as by analyzeDocumenbts below.
      void batchProcessComplete()
      Batch process complete.
      private void checkProgressMonitor()
      Check progress monitor.
      void collectionProcessComplete()
      Collection process complete.
      protected CAS createCasFromDescriptor​(java.lang.String aDescriptorFile)
      Creates a CAS from an descriptor.
      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 entityProcessComplete​(CAS aCas, EntityProcessStatus aStatus)
      Entity process complete.
      java.io.File getStyleMapFile()
      Gets the style map file.
      void initializationComplete()
      Initialization complete.
      static void main​(java.lang.String[] args)
      Runs the application.
      void paused()
      Paused.
      protected java.lang.String readStylemapFile​(java.io.File smapFile)
      Read stylemap file.
      void restorePreferences()
      Reset GUI to preferences last saved via savePreferences().
      void resumed()
      Resumed.
      void runProcessingThread​(java.io.File inputDir, java.lang.String inputFileFormat, java.lang.Boolean lenient, java.io.File outputDir, java.io.File aeSpecifierFile, java.lang.String xmlTag, java.lang.String language, java.lang.String encoding)
      Run processing thread.
      void savePreferences()
      Save user's preferences using Java's Preference API.
      void setStyleMapFile​(java.io.File styleMapFile)
      Sets the style map file.
      private void show_analysis​(java.io.File outputDir)
      Show analysis.
      void showAnalysisResults​(java.io.File aOutputDir)
      Show analysis results.
      void showAnalysisResults​(AnalysisEnginePerformanceReports aReports, java.io.File aOutputDir)
      Pops up a dialog that displays the performance stats.

      • Methods inherited from class javax.swing.JFrame

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

      • Methods inherited from class java.awt.Frame

        addNotify, getCursorType, getExtendedState, getFrames, getIconImage, getMaximizedBounds, getMenuBar, getState, getTitle, isResizable, isUndecorated, remove, removeNotify, setBackground, setCursor, setExtendedState, setMaximizedBounds, setMenuBar, setOpacity, setResizable, setShape, setState, setTitle, setUndecorated

      • 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, hide, isActive, isAlwaysOnTop, isAlwaysOnTopSupported, isAutoRequestFocus, isFocusableWindow, isFocusCycleRoot, isFocused, isLocationByPlatform, isOpaque, isShowing, isValidateRoot, pack, paint, postEvent, processEvent, processWindowFocusEvent, processWindowStateEvent, removeWindowFocusListener, removeWindowListener, removeWindowStateListener, reshape, setAlwaysOnTop, setAutoRequestFocus, setBounds, setBounds, setCursor, setFocusableWindowState, setFocusCycleRoot, setIconImages, setLocation, setLocation, setLocationByPlatform, setLocationRelativeTo, setMinimumSize, setModalExclusionType, setSize, setSize, setType, setVisible, show, toBack, 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, 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

      • Methods inherited from interface java.awt.MenuContainer

        getFont, postEvent

    • Field Detail

      • serialVersionUID

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

      • HELP_MESSAGE

        private static final java.lang.String HELP_MESSAGE
        The Constant HELP_MESSAGE.
        See Also:
        Constant Field Values

      • inputFileSelector

        private FileSelector inputFileSelector
        The input file selector.

      • inputFileFormatComboBox

        private javax.swing.JComboBox inputFileFormatComboBox
        The input file format combo box.

      • lenientCheckbox

        private javax.swing.JCheckBox lenientCheckbox
        The lenient checkbox.

      • outputFileSelector

        protected FileSelector outputFileSelector
        The output file selector.

      • xmlFileSelector

        protected FileSelector xmlFileSelector
        The xml file selector.

      • outputFileSelected

        protected java.lang.String outputFileSelected
        The output file selected.

      • runParametersField

        private javax.swing.JTextField runParametersField
        The run parameters field.

      • languageComboBox

        private javax.swing.JComboBox languageComboBox
        The language combo box.

      • encodingComboBox

        private javax.swing.JComboBox encodingComboBox
        The encoding combo box.

      • progressMonitor

        private javax.swing.ProgressMonitor progressMonitor
        The progress monitor.

      • currentTypeSystem

        protected TypeSystem currentTypeSystem
        The current type system.

      • currentTaeOutputTypes

        protected java.lang.String[] currentTaeOutputTypes
        The current tae output types.

      • userStyleMapFile

        private java.io.File userStyleMapFile
        The user style map file.

      • useGeneratedStyleMap

        protected boolean useGeneratedStyleMap
        The use generated style map.

      • interactiveTempFN

        protected java.lang.String interactiveTempFN
        The interactive temp FN.

      • aboutDialog

        private javax.swing.JDialog aboutDialog
        The about dialog.

      • numDocs

        private int numDocs
        The num docs.

      • numDocsProcessed

        private int numDocsProcessed
        The num docs processed.

      • outputDirectory

        private java.io.File outputDirectory
        Directory in which this program will write its output files.

      • runButton

        private javax.swing.JButton runButton
        The run button.

      • interButton

        private javax.swing.JButton interButton
        The inter button.

      • interactive

        protected boolean interactive
        The interactive.

      • javaViewerRB

        private final javax.swing.JRadioButton javaViewerRB
        The java viewer RB.

      • javaViewerUCRB

        private final javax.swing.JRadioButton javaViewerUCRB
        The java viewer UCRB.

      • htmlRB

        private final javax.swing.JRadioButton htmlRB
        The html RB.

      • xmlRB

        protected final javax.swing.JRadioButton xmlRB
        The xml RB.

      • analyzeInputDialog

        private javax.swing.JDialog analyzeInputDialog
        The analyze input dialog.

      • javaViewerRBisSelected

        protected boolean javaViewerRBisSelected
        The java viewer R bis selected.

      • javaViewerUCRBisSelected

        protected boolean javaViewerUCRBisSelected
        The java viewer UCR bis selected.

      • statsString

        protected java.lang.String statsString
        The stats string.

      • taeDescFile

        protected java.io.File taeDescFile
        The tae desc file.

      • taeDescFileName

        protected java.lang.String taeDescFileName
        The tae desc file name.

      • aeSpecifierFile

        private java.io.File aeSpecifierFile
        The ae specifier file.

      • cas

        protected CAS cas
        The cas.

      • progressTimer

        private javax.swing.Timer progressTimer
        The progress timer.

      • usingXmlDetagger

        private boolean usingXmlDetagger
        The using xml detagger.

    • Constructor Detail

      • DocumentAnalyzer

        public DocumentAnalyzer()
        Constructor. Sets up the GUI.

      • DocumentAnalyzer

        public DocumentAnalyzer​(java.lang.String outputFileSelected,
                        boolean interactiveDA,
                        boolean jvucrbis)
        Instantiates a new document analyzer.
        Parameters:
        outputFileSelected - the output file selected
        interactiveDA - the interactive DA
        jvucrbis - the jvucrbis

    • Method Detail

      • analyzeInputarea

        public void analyzeInputarea()
        JMP addition Opens a dialog for the user to enter text, which will be saved to a file and then processed as by analyzeDocumenbts below.

      • actionPerformed

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

      • analyzeDocuments

        public void analyzeDocuments​(java.lang.String analysisText)
        Invokes the RunTextAnalysis application library that actually analyzes the documents and generates the output. Displays a progress bar while processing is occuring. When processing is complete, allows the user to view the results. JMP added arg for input text to analyze.
        Parameters:
        analysisText - the analysis text

      • checkProgressMonitor

        private void checkProgressMonitor()
        Check progress monitor.

      • showAnalysisResults

        public void showAnalysisResults​(AnalysisEnginePerformanceReports aReports,
                                java.io.File aOutputDir)
        Pops up a dialog that displays the performance stats. This dialog will have a "Show Annotated Documents" button that takes the user to a list of the Annotated Docuemnts produced by this analysis.
        Parameters:
        aReports - performance stats for the analysis
        aOutputDir - directory containing annotated files

      • showAnalysisResults

        public void showAnalysisResults​(java.io.File aOutputDir)
        Show analysis results.
        Parameters:
        aOutputDir - the a output dir

      • createCasFromDescriptor

        protected CAS createCasFromDescriptor​(java.lang.String aDescriptorFile)
                               throws ResourceInitializationException,
                                      InvalidXMLException,
                                      java.io.IOException
        Creates a CAS from an descriptor. Supports both local AE descriptors and remote service specifiers. In the latter case the service is contacted to obtain its type system.
        Parameters:
        aDescriptorFile - the a descriptor file
        Returns:
        the cas
        Throws:
        ResourceInitializationException - -
        InvalidXMLException - -
        java.io.IOException - -

      • readStylemapFile

        protected java.lang.String readStylemapFile​(java.io.File smapFile)
        Read stylemap file.
        Parameters:
        smapFile - the smap file
        Returns:
        the string

      • show_analysis

        private void show_analysis​(java.io.File outputDir)
        Show analysis.
        Parameters:
        outputDir - the output dir

      • savePreferences

        public void savePreferences()
        Save user's preferences using Java's Preference API.

      • restorePreferences

        public void restorePreferences()
        Reset GUI to preferences last saved via savePreferences().

      • 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.

      • main

        public static void main​(java.lang.String[] args)
        Runs the application.
        Parameters:
        args - the arguments

      • runProcessingThread

        public void runProcessingThread​(java.io.File inputDir,
                                java.lang.String inputFileFormat,
                                java.lang.Boolean lenient,
                                java.io.File outputDir,
                                java.io.File aeSpecifierFile,
                                java.lang.String xmlTag,
                                java.lang.String language,
                                java.lang.String encoding)
        Run processing thread.
        Parameters:
        inputDir - the input dir
        inputFileFormat - the input file format
        lenient - the lenient
        outputDir - the output dir
        aeSpecifierFile - the ae specifier file
        xmlTag - the xml tag
        language - the language
        encoding - the encoding

      • getStyleMapFile

        public java.io.File getStyleMapFile()
        Gets the style map file.
        Returns:
        Returns the styleMapFile.

      • setStyleMapFile

        public void setStyleMapFile​(java.io.File styleMapFile)
        Sets the style map file.
        Parameters:
        styleMapFile - The styleMapFile to set.