Package org.apache.uima.tools.docanalyzer

Class DocumentAnalyzer

java.lang.Object

java.awt.Component

java.awt.Container

java.awt.Window

java.awt.Frame

javax.swing.JFrame

org.apache.uima.tools.docanalyzer.DocumentAnalyzer

All Implemented Interfaces:

ActionListener, ImageObserver, MenuContainer, Serializable, EventListener, Accessible, RootPaneContainer, WindowConstants, BaseStatusCallbackListener, StatusCallbackListener

public class DocumentAnalyzer
extends JFrame
implements StatusCallbackListener, 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

JFrame.AccessibleJFrame

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

Frame.AccessibleAWTFrame

Nested classes/interfaces inherited from class java.awt.Window

Window.AccessibleAWTWindow, Window.Type

Nested classes/interfaces inherited from class java.awt.Container

Container.AccessibleAWTContainer

Nested classes/interfaces inherited from class java.awt.Component

Component.AccessibleAWTComponent, Component.BaselineResizeBehavior, Component.BltBufferStrategy, Component.FlipBufferStrategy

Field Summary

Fields

Modifier and Type	Field	Description
protected CAS	cas	The cas.
protected String[]	currentTaeOutputTypes	The current tae output types.
protected TypeSystem	currentTypeSystem	The current type system.
protected boolean	interactive	The interactive.
protected String	interactiveTempFN	The interactive temp FN.
protected boolean	javaViewerRBisSelected	The java viewer R bis selected.
protected boolean	javaViewerUCRBisSelected	The java viewer UCR bis selected.
protected String	outputFileSelected	The output file selected.
protected FileSelector	outputFileSelector	The output file selector.
protected PrefsMediator	prefsMed	The prefs med.
protected String	statsString	The stats string.
protected File	taeDescFile	The tae desc file.
protected String	taeDescFileName	The tae desc file name.
protected boolean	useGeneratedStyleMap	The use generated style map.
protected FileSelector	xmlFileSelector	The xml file selector.
protected final JRadioButton	xmlRB	The xml RB.

Fields inherited from class javax.swing.JFrame

accessibleContext, 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 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
DocumentAnalyzer()	Constructor.
DocumentAnalyzer(String outputFileSelected, boolean interactiveDA, boolean jvucrbis)	Instantiates a new document analyzer.

Method Summary

Modifier and Type	Method	Description
void	aborted()	Aborted.
void	actionPerformed(ActionEvent e)
void	analyzeDocuments(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.
void	collectionProcessComplete()	Collection process complete.
protected CAS	createCasFromDescriptor(String aDescriptorFile)	Creates a CAS from an descriptor.
void	displayError(String aErrorString)	Displays an error message to the user.
void	displayError(Throwable aThrowable)	Displays an error message to the user.
void	entityProcessComplete(CAS aCas, EntityProcessStatus aStatus)	Entity process complete.
File	getStyleMapFile()	Gets the style map file.
void	initializationComplete()	Initialization complete.
static void	main(String[] args)	Runs the application.
void	paused()	Paused.
protected String	readStylemapFile(File smapFile)	Read stylemap file.
void	restorePreferences()	Reset GUI to preferences last saved via savePreferences().
void	resumed()	Resumed.
void	runProcessingThread(File inputDir, String inputFileFormat, Boolean lenient, File outputDir, File aeSpecifierFile, String xmlTag, String language, String encoding)	Run processing thread.
void	savePreferences()	Save user's preferences using Java's Preference API.
void	setStyleMapFile(File styleMapFile)	Sets the style map file.
void	showAnalysisResults(File aOutputDir)	Show analysis results.
void	showAnalysisResults(AnalysisEnginePerformanceReports aReports, 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, 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, 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

Methods inherited from interface java.awt.MenuContainer

getFont, postEvent

Field Details

outputFileSelector

protected FileSelector outputFileSelector

The output file selector.

xmlFileSelector

protected FileSelector xmlFileSelector

The xml file selector.

outputFileSelected

protected String outputFileSelected

The output file selected.

currentTypeSystem

protected TypeSystem currentTypeSystem

The current type system.

currentTaeOutputTypes

protected String[] currentTaeOutputTypes

The current tae output types.

useGeneratedStyleMap

protected boolean useGeneratedStyleMap

The use generated style map.

interactiveTempFN

protected String interactiveTempFN

The interactive temp FN.

interactive

protected boolean interactive

The interactive.

xmlRB

protected final JRadioButton xmlRB

The xml RB.

javaViewerRBisSelected

protected boolean javaViewerRBisSelected

The java viewer R bis selected.

javaViewerUCRBisSelected

protected boolean javaViewerUCRBisSelected

The java viewer UCR bis selected.

prefsMed

protected PrefsMediator prefsMed

The prefs med.

statsString

protected String statsString

The stats string.

taeDescFile

protected File taeDescFile

The tae desc file.

taeDescFileName

protected String taeDescFileName

The tae desc file name.

cas

protected CAS cas

The cas.

Constructor Details

DocumentAnalyzer

public DocumentAnalyzer()

Constructor. Sets up the GUI.

DocumentAnalyzer

public DocumentAnalyzer(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 Details

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(ActionEvent e)

Specified by:

actionPerformed in interface ActionListener

analyzeDocuments

public void analyzeDocuments(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

entityProcessComplete

public void entityProcessComplete(CAS aCas,
 EntityProcessStatus aStatus)

Entity process complete.

Specified by:

entityProcessComplete in interface StatusCallbackListener

Parameters:

aCas - the a cas

aStatus - the a status

See Also:

• StatusCallbackListener.entityProcessComplete(org.apache.uima.cas.CAS, org.apache.uima.collection.EntityProcessStatus)

aborted

public void aborted()

Aborted.

Specified by:

aborted in interface BaseStatusCallbackListener

See Also:

• BaseStatusCallbackListener.aborted()

batchProcessComplete

public void batchProcessComplete()

Batch process complete.

Specified by:

batchProcessComplete in interface BaseStatusCallbackListener

See Also:

• BaseStatusCallbackListener.batchProcessComplete()

collectionProcessComplete

public void collectionProcessComplete()

Collection process complete.

Specified by:

collectionProcessComplete in interface BaseStatusCallbackListener

See Also:

• BaseStatusCallbackListener.collectionProcessComplete()

initializationComplete

public void initializationComplete()

Initialization complete.

Specified by:

initializationComplete in interface BaseStatusCallbackListener

See Also:

• BaseStatusCallbackListener.initializationComplete()

paused

public void paused()

Paused.

Specified by:

paused in interface BaseStatusCallbackListener

See Also:

• BaseStatusCallbackListener.paused()

resumed

public void resumed()

Resumed.

Specified by:

resumed in interface BaseStatusCallbackListener

See Also:

• BaseStatusCallbackListener.resumed()

showAnalysisResults

public void showAnalysisResults(AnalysisEnginePerformanceReports aReports,
 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(File aOutputDir)

Show analysis results.

Parameters:

aOutputDir - the a output dir

createCasFromDescriptor

protected CAS createCasFromDescriptor(String aDescriptorFile)
                               throws ResourceInitializationException,
InvalidXMLException,
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 - -

IOException - -

readStylemapFile

protected String readStylemapFile(File smapFile)

Read stylemap file.

Parameters:

smapFile - the smap file

Returns:

the string

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(String aErrorString)

Displays an error message to the user.

Parameters:

aErrorString - error message to display

displayError

public void displayError(Throwable aThrowable)

Displays an error message to the user.

Parameters:

aThrowable - Throwable whose message is to be displayed.

main

public static void main(String[] args)

Runs the application.

Parameters:

args - the arguments

runProcessingThread

public void runProcessingThread(File inputDir,
 String inputFileFormat,
 Boolean lenient,
 File outputDir,
 File aeSpecifierFile,
 String xmlTag,
 String language,
 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 File getStyleMapFile()

Gets the style map file.

Returns:

Returns the styleMapFile.

setStyleMapFile

public void setStyleMapFile(File styleMapFile)

Sets the style map file.

Parameters:

styleMapFile - The styleMapFile to set.