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
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:
-
Nested Class Summary
Nested ClassesModifier and TypeClassDescription(package private) class
The Class ProcessingThread.(package private) class
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
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
FieldsModifier and TypeFieldDescriptionprivate JDialog
The about dialog.private File
The ae specifier file.private JDialog
The analyze input dialog.protected CAS
The cas.private FileSystemCollectionReader
The collection reader.protected String[]
The current tae output types.protected TypeSystem
The current type system.private JComboBox
The encoding combo box.private static final String
The Constant HELP_MESSAGE.private final JRadioButton
The html RB.private JComboBox
The input file format combo box.private FileSelector
The input file selector.protected boolean
The interactive.protected String
The interactive temp FN.private JButton
The inter button.private final JRadioButton
The java viewer RB.protected boolean
The java viewer R bis selected.private final JRadioButton
The java viewer UCRB.protected boolean
The java viewer UCR bis selected.private JComboBox
The language combo box.private JCheckBox
The lenient checkbox.private CollectionProcessingManager
The m CPM.private int
The num docs.private int
The num docs processed.private File
Directory in which this program will write its output files.protected String
The output file selected.protected FileSelector
The output file selector.protected PrefsMediator
The prefs med.private ProgressMonitor
The progress monitor.private Timer
The progress timer.private JButton
The run button.private JTextField
The run parameters field.private static final long
The Constant serialVersionUID.protected String
The stats string.protected File
The tae desc file.protected String
The tae desc file name.protected boolean
The use generated style map.private File
The user style map file.private boolean
The using xml detagger.protected FileSelector
The xml file selector.protected final JRadioButton
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
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, HIDE_ON_CLOSE
-
Constructor Summary
ConstructorsConstructorDescriptionConstructor.DocumentAnalyzer
(String outputFileSelected, boolean interactiveDA, boolean jvucrbis) Instantiates a new document analyzer. -
Method Summary
Modifier and TypeMethodDescriptionvoid
aborted()
Aborted.void
void
analyzeDocuments
(String analysisText) Invokes theRunTextAnalysis
application library that actually analyzes the documents and generates the output.void
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
Batch process complete.private void
Check progress monitor.void
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.Gets the style map file.void
Initialization complete.static void
Runs the application.void
paused()
Paused.protected String
readStylemapFile
(File smapFile) Read stylemap file.void
Reset GUI to preferences last saved viasavePreferences()
.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
Save user's preferences using Java's Preference API.void
setStyleMapFile
(File styleMapFile) Sets the style map file.private void
show_analysis
(File outputDir) Show analysis.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, 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 Details
-
serialVersionUID
private static final long serialVersionUIDThe Constant serialVersionUID.- See Also:
-
HELP_MESSAGE
The Constant HELP_MESSAGE.- See Also:
-
inputFileSelector
The input file selector. -
inputFileFormatComboBox
The input file format combo box. -
lenientCheckbox
The lenient checkbox. -
outputFileSelector
The output file selector. -
xmlFileSelector
The xml file selector. -
outputFileSelected
The output file selected. -
runParametersField
The run parameters field. -
languageComboBox
The language combo box. -
encodingComboBox
The encoding combo box. -
progressMonitor
The progress monitor. -
currentTypeSystem
The current type system. -
currentTaeOutputTypes
The current tae output types. -
userStyleMapFile
The user style map file. -
useGeneratedStyleMap
protected boolean useGeneratedStyleMapThe use generated style map. -
collectionReader
The collection reader. -
mCPM
The m CPM. -
interactiveTempFN
The interactive temp FN. -
aboutDialog
The about dialog. -
numDocs
private int numDocsThe num docs. -
numDocsProcessed
private int numDocsProcessedThe num docs processed. -
outputDirectory
Directory in which this program will write its output files. -
runButton
The run button. -
interButton
The inter button. -
interactive
protected boolean interactiveThe interactive. -
javaViewerRB
The java viewer RB. -
javaViewerUCRB
The java viewer UCRB. -
htmlRB
The html RB. -
xmlRB
The xml RB. -
analyzeInputDialog
The analyze input dialog. -
javaViewerRBisSelected
protected boolean javaViewerRBisSelectedThe java viewer R bis selected. -
javaViewerUCRBisSelected
protected boolean javaViewerUCRBisSelectedThe java viewer UCR bis selected. -
prefsMed
The prefs med. -
statsString
The stats string. -
taeDescFile
The tae desc file. -
taeDescFileName
The tae desc file name. -
aeSpecifierFile
The ae specifier file. -
cas
The cas. -
progressTimer
The progress timer. -
usingXmlDetagger
private boolean usingXmlDetaggerThe using xml detagger.
-
-
Constructor Details
-
DocumentAnalyzer
public DocumentAnalyzer()Constructor. Sets up the GUI. -
DocumentAnalyzer
Instantiates a new document analyzer.- Parameters:
outputFileSelected
- the output file selectedinteractiveDA
- the interactive DAjvucrbis
- 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
- Specified by:
actionPerformed
in interfaceActionListener
-
analyzeDocuments
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
Entity process complete.- Specified by:
entityProcessComplete
in interfaceStatusCallbackListener
- Parameters:
aCas
- the a casaStatus
- the a status- See Also:
-
aborted
public void aborted()Aborted.- Specified by:
aborted
in interfaceBaseStatusCallbackListener
- See Also:
-
batchProcessComplete
public void batchProcessComplete()Batch process complete.- Specified by:
batchProcessComplete
in interfaceBaseStatusCallbackListener
- See Also:
-
collectionProcessComplete
public void collectionProcessComplete()Collection process complete.- Specified by:
collectionProcessComplete
in interfaceBaseStatusCallbackListener
- See Also:
-
initializationComplete
public void initializationComplete()Initialization complete.- Specified by:
initializationComplete
in interfaceBaseStatusCallbackListener
- See Also:
-
paused
public void paused()Paused.- Specified by:
paused
in interfaceBaseStatusCallbackListener
- See Also:
-
resumed
public void resumed()Resumed.- Specified by:
resumed
in interfaceBaseStatusCallbackListener
- See Also:
-
showAnalysisResults
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
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
Read stylemap file.- Parameters:
smapFile
- the smap file- Returns:
- the string
-
show_analysis
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
Displays an error message to the user.- Parameters:
aErrorString
- error message to display
-
displayError
Displays an error message to the user.- Parameters:
aThrowable
- Throwable whose message is to be displayed.
-
main
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 dirinputFileFormat
- the input file formatlenient
- the lenientoutputDir
- the output diraeSpecifierFile
- the ae specifier filexmlTag
- the xml taglanguage
- the languageencoding
- the encoding
-
getStyleMapFile
Gets the style map file.- Returns:
- Returns the styleMapFile.
-
setStyleMapFile
Sets the style map file.- Parameters:
styleMapFile
- The styleMapFile to set.
-