uima-commits mailing list archives

Site index · List index
Message view « Date » · « Thread »
Top « Date » · « Thread »
From sc...@apache.org
Subject svn commit: r996549 - /uima/uimaj/trunk/uimaj-core/src/main/java/org/apache/uima/util/CasToInlineXml.java
Date Mon, 13 Sep 2010 14:15:51 GMT
Author: schor
Date: Mon Sep 13 14:15:51 2010
New Revision: 996549

URL: http://svn.apache.org/viewvc?rev=996549&view=rev
Log:
[UIMA-1771] update javadocs (only) to reflect the CasToInlineXml does only an approximate
representation.

Modified:
    uima/uimaj/trunk/uimaj-core/src/main/java/org/apache/uima/util/CasToInlineXml.java

Modified: uima/uimaj/trunk/uimaj-core/src/main/java/org/apache/uima/util/CasToInlineXml.java
URL: http://svn.apache.org/viewvc/uima/uimaj/trunk/uimaj-core/src/main/java/org/apache/uima/util/CasToInlineXml.java?rev=996549&r1=996548&r2=996549&view=diff
==============================================================================
--- uima/uimaj/trunk/uimaj-core/src/main/java/org/apache/uima/util/CasToInlineXml.java (original)
+++ uima/uimaj/trunk/uimaj-core/src/main/java/org/apache/uima/util/CasToInlineXml.java Mon
Sep 13 14:15:51 2010
@@ -45,10 +45,21 @@ import org.xml.sax.SAXException;
 import org.xml.sax.helpers.AttributesImpl;
 
 /**
- * Generates an inline XML representation of a CAS. Annotation types are represented as XML
tags,
- * features are represented as attributes. Note that features whose values are FeatureStructures
are
- * not represented.
+ * Generates an *approximate* inline XML representation of a CAS. 
+ * Annotation types are represented as XML tags, features are represented as attributes.
+ *  
+ * Features whose values are FeatureStructures are not represented.
+ * Feature values which are strings longer than 64 characters are truncated.
+ * Feature values which are arrays of primitives are represented by 
+ * strings that look like [ xxx, xxx ]
  * 
+ * The Subject of analysis is presumed to be a text string.
+ * 
+ * Some characters in the document's Subject-of-analysis
+ * are replaced by blanks, because the characters aren't valid in xml documents.
+ * 
+ * It doesn't work for annotations which are overlapping, because these cannot 
+ * be properly represented as properly - nested XML.
  * 
  */
 public class CasToInlineXml {



Mime
View raw message