Author: schor
Date: Mon Jul 15 15:28:51 2013
New Revision: 1503296
URL: http://svn.apache.org/r1503296
Log:
[UIMA-2305] updated documentation, new picture, slight cleanup to UI
Added:
uima/uimaj/trunk/uima-docbook-tools/src/docbook/images/tools/tools.doc_analyzer/DocAnalyzerScr1.png
(with props)
Modified:
uima/uimaj/trunk/uima-docbook-tools/src/docbook/tools.doc_analyzer.xml
uima/uimaj/trunk/uimaj-tools/src/main/java/org/apache/uima/tools/docanalyzer/DocumentAnalyzer.java
Added:
uima/uimaj/trunk/uima-docbook-tools/src/docbook/images/tools/tools.doc_analyzer/DocAnalyzerScr1.png
URL:
http://svn.apache.org/viewvc/uima/uimaj/trunk/uima-docbook-tools/src/docbook/images/tools/tools.doc_analyzer/DocAnalyzerScr1.png?rev=1503296&view=auto
==============================================================================
Binary file - no diff available.
Propchange:
uima/uimaj/trunk/uima-docbook-tools/src/docbook/images/tools/tools.doc_analyzer/DocAnalyzerScr1.png
------------------------------------------------------------------------------
svn:mime-type = image/png
Modified: uima/uimaj/trunk/uima-docbook-tools/src/docbook/tools.doc_analyzer.xml
URL:
http://svn.apache.org/viewvc/uima/uimaj/trunk/uima-docbook-tools/src/docbook/tools.doc_analyzer.xml?rev=1503296&r1=1503295&r2=1503296&view=diff
==============================================================================
--- uima/uimaj/trunk/uima-docbook-tools/src/docbook/tools.doc_analyzer.xml
(original)
+++ uima/uimaj/trunk/uima-docbook-tools/src/docbook/tools.doc_analyzer.xml Mon
Jul 15 15:28:51 2013
@@ -57,7 +57,7 @@ screen that looks like this:
<screenshot>
<mediaobject>
<imageobject>
- <imagedata width="5.8in" format="JPG" fileref="&imgroot;image002.jpg"/>
+ <imagedata width="5.8in" format="PNG"
fileref="&imgroot;DocAnalyzerScr1.png"/>
</imageobject>
<textobject><phrase>Document Analyzer GUI</phrase>
</textobject>
@@ -81,6 +81,18 @@ want to analyze. Some sample documents
are provided in the UIMA SDK under the <literal>examples/data</literal>
directory.</para>
+<para><emphasis role="bold">Input File Format:</emphasis> Set this to "text".
It can, alternatively,
+be set to one of the two serialized forms for CASes, if you have previously
generated and saved these.
+For the CAS formats only, you can also specify "Lenient deserialization"; if
checked, then extra
+types and features in the CAS being deserialized and loaded (that are not
defined by the Annotator-to-be-run's
+type system) will not cause a deserialization error, but will instead be
ignored.</para>
+
+<para><emphasis role="bold">Character Encoding:</emphasis>
+ The character encoding of the input files. The default, UTF-8, also works
fine for ASCII
+text files. If you have a different
+encoding, select it here. For more information on character sets and their
names, see the Javadocs for
+ <literal>java.nio.charset.Charset</literal>.</para>
+
<para><emphasis role="bold">Output Directory:</emphasis> Browse to or type the
path of a directory where you want
output to be written. (As we'll see later, you won't normally need
to look directly at these files, but the
Document Analyzer needs to know where to write them.) The files written to
this directory will be an XML
@@ -110,12 +122,6 @@ here must be an ISO language identifier,
<ulink url="http://www.ics.uci.edu/pub/ietf/http/related/iso639.txt"/>.
</para>
-<para><emphasis role="bold">Character Encoding:</emphasis>
- The character encoding of the input files. The default, UTF-8, also works
fine for ASCII
-text files. If you have a different
-encoding, enter it here. For more
-information on character sets and their names, see the Javadocs for
- <literal>java.nio.charset.Charset</literal>.</para>
<para>Once you've filled in the appropriate values, press the
<quote>Run</quote> button.</para>
Modified:
uima/uimaj/trunk/uimaj-tools/src/main/java/org/apache/uima/tools/docanalyzer/DocumentAnalyzer.java
URL:
http://svn.apache.org/viewvc/uima/uimaj/trunk/uimaj-tools/src/main/java/org/apache/uima/tools/docanalyzer/DocumentAnalyzer.java?rev=1503296&r1=1503295&r2=1503296&view=diff
==============================================================================
---
uima/uimaj/trunk/uimaj-tools/src/main/java/org/apache/uima/tools/docanalyzer/DocumentAnalyzer.java
(original)
+++
uima/uimaj/trunk/uimaj-tools/src/main/java/org/apache/uima/tools/docanalyzer/DocumentAnalyzer.java
Mon Jul 15 15:28:51 2013
@@ -114,11 +114,9 @@ public class DocumentAnalyzer extends JF
+ "* In the \"Input Directory\" field, either type or use the
browse\n"
+ "button to select a directory containing the documents that you
want\n"
+ "to analyze.\n\n"
- + "* In the \"Input File Format\" field, type or use the browse]n"
- + "button to select \"xcas\" or \"xmi\", as well as \"true\"\n"
- + "(which for historical reasons means the same as \"xcas\").\n"
- + "Any other value will cause the input file to be treated as a text
document.\n\n"
- + "* If using XMI or XCAS, check the \"Lenient\" box to indicate
that if it's OK if the annotator's type system doesn't define all the types or
features in the input CAS.\n\n"
+ + "* In the \"Input File Format\" field, type or use the browse\n"
+ + "button to select \"text\", \"xcas\", or \"xmi\".\n"
+ + "* If using \"xmi\" or \"xcas\", check the \"Lenient\" box to
indicate if it's OK if the annotator's type system doesn't define all the types
or features in the input CAS.\n\n"
+ "* In the \"Output Directory\" field, either type or use the
browse\n"
+ "button to select a directory where you would like the analyzed\n"
+ "documents to be placed.\n\n"
@@ -341,8 +339,8 @@ public class DocumentAnalyzer extends JF
inputFileFormatPanel.setLayout(new FlowLayout(FlowLayout.LEFT));
- inputFileFormatComboBox = new JComboBox(new Object[] { "textDocument",
"xmi", "xcas" });
- inputFileFormatComboBox.setEditable(true);
+ inputFileFormatComboBox = new JComboBox(new Object[] { "text", "xmi",
"xcas" });
+ inputFileFormatComboBox.setEditable(false);
inputFileFormatComboBox.setSelectedItem(prefsMed.getInputFileFormat());
inputFileFormatComboBox.addActionListener(new ActionListener() {
public void actionPerformed(ActionEvent e) {
