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:
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.Window
java.awt.Window.AccessibleAWTWindow, java.awt.Window.Type
-
-
Field Summary
Fields Modifier and Type Field Description private javax.swing.JDialog
aboutDialog
The about dialog.private java.io.File
aeSpecifierFile
The ae specifier file.private javax.swing.JDialog
analyzeInputDialog
The analyze input dialog.protected CAS
cas
The cas.private FileSystemCollectionReader
collectionReader
The collection reader.protected java.lang.String[]
currentTaeOutputTypes
The current tae output types.protected TypeSystem
currentTypeSystem
The current type system.private javax.swing.JComboBox
encodingComboBox
The encoding combo box.private static java.lang.String
HELP_MESSAGE
The Constant HELP_MESSAGE.private javax.swing.JRadioButton
htmlRB
The html RB.private javax.swing.JComboBox
inputFileFormatComboBox
The input file format combo box.private FileSelector
inputFileSelector
The input file selector.protected boolean
interactive
The interactive.protected java.lang.String
interactiveTempFN
The interactive temp FN.private javax.swing.JButton
interButton
The inter button.private javax.swing.JRadioButton
javaViewerRB
The java viewer RB.protected boolean
javaViewerRBisSelected
The java viewer R bis selected.private javax.swing.JRadioButton
javaViewerUCRB
The java viewer UCRB.protected boolean
javaViewerUCRBisSelected
The java viewer UCR bis selected.private javax.swing.JComboBox
languageComboBox
The language combo box.private javax.swing.JCheckBox
lenientCheckbox
The lenient checkbox.private CollectionProcessingManager
mCPM
The m CPM.private int
numDocs
The num docs.private int
numDocsProcessed
The num docs processed.private java.io.File
outputDirectory
Directory in which this program will write its output files.protected java.lang.String
outputFileSelected
The output file selected.protected FileSelector
outputFileSelector
The output file selector.protected PrefsMediator
prefsMed
The prefs med.private javax.swing.ProgressMonitor
progressMonitor
The progress monitor.private javax.swing.Timer
progressTimer
The progress timer.private javax.swing.JButton
runButton
The run button.private javax.swing.JTextField
runParametersField
The run parameters field.private static long
serialVersionUID
The Constant serialVersionUID.protected java.lang.String
statsString
The stats string.protected java.io.File
taeDescFile
The tae desc file.protected java.lang.String
taeDescFileName
The tae desc file name.protected boolean
useGeneratedStyleMap
The use generated style map.private java.io.File
userStyleMapFile
The user style map file.private boolean
usingXmlDetagger
The using xml detagger.protected FileSelector
xmlFileSelector
The xml file selector.protected javax.swing.JRadioButton
xmlRB
The xml RB.-
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
-
-
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 theRunTextAnalysis
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 viasavePreferences()
.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
-
-
-
-
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.
-
collectionReader
private FileSystemCollectionReader collectionReader
The collection reader.
-
mCPM
private CollectionProcessingManager mCPM
The m CPM.
-
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.
-
prefsMed
protected PrefsMediator prefsMed
The prefs med.
-
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 selectedinteractiveDA
- the interactive DAjvucrbis
- 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 interfacejava.awt.event.ActionListener
-
analyzeDocuments
public void analyzeDocuments(java.lang.String analysisText)
Invokes theRunTextAnalysis
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.
-
entityProcessComplete
public void entityProcessComplete(CAS aCas, EntityProcessStatus aStatus)
Entity process complete.- Specified by:
entityProcessComplete
in interfaceStatusCallbackListener
- Parameters:
aCas
- the a casaStatus
- 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 interfaceBaseStatusCallbackListener
- See Also:
BaseStatusCallbackListener.aborted()
-
batchProcessComplete
public void batchProcessComplete()
Batch process complete.- Specified by:
batchProcessComplete
in interfaceBaseStatusCallbackListener
- See Also:
BaseStatusCallbackListener.batchProcessComplete()
-
collectionProcessComplete
public void collectionProcessComplete()
Collection process complete.- Specified by:
collectionProcessComplete
in interfaceBaseStatusCallbackListener
- See Also:
BaseStatusCallbackListener.collectionProcessComplete()
-
initializationComplete
public void initializationComplete()
Initialization complete.- Specified by:
initializationComplete
in interfaceBaseStatusCallbackListener
- See Also:
BaseStatusCallbackListener.initializationComplete()
-
paused
public void paused()
Paused.- Specified by:
paused
in interfaceBaseStatusCallbackListener
- See Also:
BaseStatusCallbackListener.paused()
-
resumed
public void resumed()
Resumed.- Specified by:
resumed
in interfaceBaseStatusCallbackListener
- 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 analysisaOutputDir
- 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 viasavePreferences()
.
-
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 dirinputFileFormat
- the input file formatlenient
- the lenientoutputDir
- the output diraeSpecifierFile
- the ae specifier filexmlTag
- the xml taglanguage
- the languageencoding
- 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.
-
-