Author: schor
Date: Mon Apr 14 20:59:42 2014
New Revision: 1587318
URL: http://svn.apache.org/r1587318
Log:
[UIMA-2383] comment change only - fix Javadoc description of AnnotationBase
Modified:
uima/uimaj/trunk/uimaj-core/src/main/java/org/apache/uima/jcas/cas/AnnotationBase.java
Modified:
uima/uimaj/trunk/uimaj-core/src/main/java/org/apache/uima/jcas/cas/AnnotationBase.java
URL:
http://svn.apache.org/viewvc/uima/uimaj/trunk/uimaj-core/src/main/java/org/apache/uima/jcas/cas/AnnotationBase.java?rev=1587318&r1=1587317&r2=1587318&view=diff
==============================================================================
---
uima/uimaj/trunk/uimaj-core/src/main/java/org/apache/uima/jcas/cas/AnnotationBase.java
(original)
+++
uima/uimaj/trunk/uimaj-core/src/main/java/org/apache/uima/jcas/cas/AnnotationBase.java
Mon Apr 14 20:59:42 2014
@@ -26,9 +26,22 @@ import org.apache.uima.jcas.JCas;
import org.apache.uima.jcas.JCasRegistry;
/**
- * the JCas class model for the CAS type uima.cas.Annotation. It defines two
integer valued features
- * indicating the begin and end of the span being annotated. There is also a
method to retrieve the
- * spanned text as a string.
+ * the JCas class model for the CAS type uima.cas.AnnotationBase.
+ * The AnnotationBase type defines one system-used feature which
+ * specifies for an annotation the subject of analysis (Sofa) to which it
refers.
+ * Various annotation types (including the built-in uima.tcas.Annotation)
+ * may be defined as subtypes of this type.
+ *
+ * uima.tcas.Annotation is a subtype of this type, appropriate for
+ * Subjects of Analysis which are text strings. Other (not-built-in)
+ * subtypes may be defined for other kinds of Subjects of Analysis. For
instance
+ * an audio sample Subject of Analysis might define a start and end position
as time points
+ * in the stream. An image Subject of Analysis might define rectangular
coordiantes
+ * describing a sub-area of the image.
+ *
+ * If you are defining a type which needs a reference to the Subject of
Analysis
+ * (which is view-specific),
+ * it should be a subtype of this base type.
*/
public class AnnotationBase extends org.apache.uima.jcas.cas.TOP implements
AnnotationBaseFS {
