org.apache.uima.tools.docanalyzer
Class DocumentAnalyzer

java.lang.Object
  extended by java.awt.Component
      extended by java.awt.Container
          extended by java.awt.Window
              extended by java.awt.Frame
                  extended by javax.swing.JFrame
                      extended by org.apache.uima.tools.docanalyzer.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/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
 
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
protected  CAS cas
           
protected  java.lang.String[] currentTaeOutputTypes
           
protected  TypeSystem currentTypeSystem
           
protected  boolean interactive
           
protected  java.lang.String interactiveTempFN
           
protected  boolean javaViewerRBisSelected
           
protected  boolean javaViewerUCRBisSelected
           
protected  java.lang.String outputFileSelected
           
protected  FileSelector outputFileSelector
           
protected  PrefsMediator prefsMed
           
protected  java.lang.String statsString
           
protected  java.io.File taeDescFile
           
protected  java.lang.String taeDescFileName
           
protected  boolean useGeneratedStyleMap
           
protected  FileSelector xmlFileSelector
           
protected  javax.swing.JRadioButton xmlRB
           
 
Fields inherited from class javax.swing.JFrame
accessibleContext, EXIT_ON_CLOSE, rootPane, rootPaneCheckingEnabled
 
Fields inherited from class java.awt.Frame
CROSSHAIR_CURSOR, DEFAULT_CURSOR, E_RESIZE_CURSOR, HAND_CURSOR, ICONIFIED, MAXIMIZED_BOTH, MAXIMIZED_HORIZ, MAXIMIZED_VERT, MOVE_CURSOR, N_RESIZE_CURSOR, NE_RESIZE_CURSOR, NORMAL, NW_RESIZE_CURSOR, S_RESIZE_CURSOR, SE_RESIZE_CURSOR, SW_RESIZE_CURSOR, TEXT_CURSOR, W_RESIZE_CURSOR, WAIT_CURSOR
 
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, HIDE_ON_CLOSE
 
Fields inherited from interface java.awt.image.ImageObserver
ABORT, ALLBITS, ERROR, FRAMEBITS, HEIGHT, PROPERTIES, SOMEBITS, WIDTH
 
Constructor Summary
DocumentAnalyzer()
          Constructor.
DocumentAnalyzer(java.lang.String outputFileSelected, boolean interactiveDA, boolean jvucrbis)
           
 
Method Summary
 void aborted()
          Called when the processing has been 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()
          Called when the processing of a batch has completed.
 void collectionProcessComplete()
          Called when the processing of an entire collection has completed.
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)
          Called when the processing of each entity has completed.
 java.awt.Dimension getPreferredSize()
           
 java.io.File getStyleMapFile()
           
 void initializationComplete()
          Called when the Collection Processing Manager's initialization has completed.
static void main(java.lang.String[] args)
          Runs the application.
 void paused()
          Called when the processing has been paused.
protected  java.lang.String readStylemapFile(java.io.File smapFile)
           
 void restorePreferences()
          Reset GUI to preferences last saved via savePreferences().
 void resumed()
          Called when the processing has been resumed (after it had been previously paused).
 void runProcessingThread(java.io.File inputDir, java.io.File outputDir, java.io.File aeSpecifierFile, java.lang.String xmlTag, java.lang.String language, java.lang.String encoding)
           
 void savePreferences()
          Save user's preferences using Java's Preference API.
 void setStyleMapFile(java.io.File styleMapFile)
           
 void showAnalysisResults(AnalysisEnginePerformanceReports aReports, java.io.File aOutputDir)
          Pops up a dialog that displays the performance stats.
 void showAnalysisResults(java.io.File aOutputDir)
           
 
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, setCursor, setExtendedState, setMaximizedBounds, setMenuBar, setResizable, setState, setTitle, setUndecorated
 
Methods inherited from class java.awt.Window
addPropertyChangeListener, addPropertyChangeListener, addWindowFocusListener, addWindowListener, addWindowStateListener, applyResourceBundle, applyResourceBundle, createBufferStrategy, createBufferStrategy, dispose, getBufferStrategy, getFocusableWindowState, getFocusCycleRootAncestor, getFocusOwner, getFocusTraversalKeys, getGraphicsConfiguration, getIconImages, getInputContext, getListeners, getLocale, getModalExclusionType, getMostRecentFocusOwner, getOwnedWindows, getOwner, getOwnerlessWindows, getToolkit, getWarningString, getWindowFocusListeners, getWindowListeners, getWindows, getWindowStateListeners, hide, isActive, isAlwaysOnTop, isAlwaysOnTopSupported, isFocusableWindow, isFocusCycleRoot, isFocused, isLocationByPlatform, isShowing, pack, postEvent, processEvent, processWindowFocusEvent, processWindowStateEvent, removeWindowFocusListener, removeWindowListener, removeWindowStateListener, reshape, setAlwaysOnTop, setBounds, setBounds, setCursor, setFocusableWindowState, setFocusCycleRoot, setIconImages, setLocationByPlatform, setLocationRelativeTo, setMinimumSize, setModalExclusionType, setSize, setSize, 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, insets, invalidate, isAncestorOf, isFocusCycleRoot, isFocusTraversalPolicyProvider, isFocusTraversalPolicySet, layout, list, list, locate, minimumSize, paint, 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, getBackground, getBaseline, getBaselineResizeBehavior, getBounds, getBounds, getColorModel, getComponentListeners, getComponentOrientation, getCursor, getDropTarget, getFocusListeners, getFocusTraversalKeysEnabled, getFont, getFontMetrics, getForeground, 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, isOpaque, 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, setBackground, setComponentOrientation, setDropTarget, setEnabled, setFocusable, setFocusTraversalKeysEnabled, setForeground, setIgnoreRepaint, setLocale, setLocation, setLocation, 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

outputFileSelector

protected FileSelector outputFileSelector

xmlFileSelector

protected FileSelector xmlFileSelector

outputFileSelected

protected java.lang.String outputFileSelected

currentTypeSystem

protected TypeSystem currentTypeSystem

currentTaeOutputTypes

protected java.lang.String[] currentTaeOutputTypes

useGeneratedStyleMap

protected boolean useGeneratedStyleMap

interactiveTempFN

protected java.lang.String interactiveTempFN

interactive

protected boolean interactive

xmlRB

protected final javax.swing.JRadioButton xmlRB

javaViewerRBisSelected

protected boolean javaViewerRBisSelected

javaViewerUCRBisSelected

protected boolean javaViewerUCRBisSelected

prefsMed

protected PrefsMediator prefsMed

statsString

protected java.lang.String statsString

taeDescFile

protected java.io.File taeDescFile

taeDescFileName

protected java.lang.String taeDescFileName

cas

protected CAS cas
Constructor Detail

DocumentAnalyzer

public DocumentAnalyzer()
Constructor. Sets up the GUI.


DocumentAnalyzer

public DocumentAnalyzer(java.lang.String outputFileSelected,
                        boolean interactiveDA,
                        boolean 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.


entityProcessComplete

public void entityProcessComplete(CAS aCas,
                                  EntityProcessStatus aStatus)
Description copied from interface: StatusCallbackListener
Called when the processing of each entity has completed.

Specified by:
entityProcessComplete in interface StatusCallbackListener
Parameters:
aCas - the CAS containing the processed entity and the analysis results
aStatus - the status of the processing. This object contains a record of any Exception that occurred, as well as timing information.
See Also:
StatusCallbackListener.entityProcessComplete(org.apache.uima.cas.CAS, org.apache.uima.collection.EntityProcessStatus)

aborted

public void aborted()
Description copied from interface: BaseStatusCallbackListener
Called when the processing has been aborted.

Specified by:
aborted in interface BaseStatusCallbackListener
See Also:
BaseStatusCallbackListener.aborted()

batchProcessComplete

public void batchProcessComplete()
Description copied from interface: BaseStatusCallbackListener
Called when the processing of a batch has completed.

Specified by:
batchProcessComplete in interface BaseStatusCallbackListener
See Also:
BaseStatusCallbackListener.batchProcessComplete()

collectionProcessComplete

public void collectionProcessComplete()
Description copied from interface: BaseStatusCallbackListener
Called when the processing of an entire collection has completed.

Specified by:
collectionProcessComplete in interface BaseStatusCallbackListener
See Also:
BaseStatusCallbackListener.collectionProcessComplete()

initializationComplete

public void initializationComplete()
Description copied from interface: BaseStatusCallbackListener
Called when the Collection Processing Manager's initialization has completed.

Specified by:
initializationComplete in interface BaseStatusCallbackListener
See Also:
BaseStatusCallbackListener.initializationComplete()

paused

public void paused()
Description copied from interface: BaseStatusCallbackListener
Called when the processing has been paused.

Specified by:
paused in interface BaseStatusCallbackListener
See Also:
BaseStatusCallbackListener.paused()

resumed

public void resumed()
Description copied from interface: BaseStatusCallbackListener
Called when the processing has been resumed (after it had been previously paused).

Specified by:
resumed in interface BaseStatusCallbackListener
See Also:
BaseStatusCallbackListener.resumed()

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)

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.

Throws:
ResourceInitializationException
InvalidXMLException
java.io.IOException

readStylemapFile

protected java.lang.String readStylemapFile(java.io.File smapFile)

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.


runProcessingThread

public void runProcessingThread(java.io.File inputDir,
                                java.io.File outputDir,
                                java.io.File aeSpecifierFile,
                                java.lang.String xmlTag,
                                java.lang.String language,
                                java.lang.String encoding)

getStyleMapFile

public java.io.File getStyleMapFile()
Returns:
Returns the styleMapFile.

setStyleMapFile

public void setStyleMapFile(java.io.File styleMapFile)
Parameters:
styleMapFile - The styleMapFile to set.

getPreferredSize

public java.awt.Dimension getPreferredSize()
Overrides:
getPreferredSize in class java.awt.Container


Copyright © 2013. All Rights Reserved.