You are viewing a plain text version of this content. The canonical link for it is here.
Posted to commits@uima.apache.org by sc...@apache.org on 2017/07/20 14:43:07 UTC
svn commit: r1802496 -
/uima/uv3/uimaj-v3/trunk/uimaj-core/src/main/java/org/apache/uima/cas/text/AnnotationIndex.java
Author: schor
Date: Thu Jul 20 14:43:07 2017
New Revision: 1802496
URL: http://svn.apache.org/viewvc?rev=1802496&view=rev
Log:
[UIMA-5483] update javadocs to reflect type order omitted if no type priorities
Modified:
uima/uv3/uimaj-v3/trunk/uimaj-core/src/main/java/org/apache/uima/cas/text/AnnotationIndex.java
Modified: uima/uv3/uimaj-v3/trunk/uimaj-core/src/main/java/org/apache/uima/cas/text/AnnotationIndex.java
URL: http://svn.apache.org/viewvc/uima/uv3/uimaj-v3/trunk/uimaj-core/src/main/java/org/apache/uima/cas/text/AnnotationIndex.java?rev=1802496&r1=1802495&r2=1802496&view=diff
==============================================================================
--- uima/uv3/uimaj-v3/trunk/uimaj-core/src/main/java/org/apache/uima/cas/text/AnnotationIndex.java (original)
+++ uima/uv3/uimaj-v3/trunk/uimaj-core/src/main/java/org/apache/uima/cas/text/AnnotationIndex.java Thu Jul 20 14:43:07 2017
@@ -40,8 +40,10 @@ import org.apache.uima.cas.FSIterator;
* annotations with smaller spans, which produces an iteration order similar to a preorder tree
* traversal.</li>
* <li>Annotations whose start offsets are equal and whose end offsets are equal are sorted based
- * on {@link org.apache.uima.resource.metadata.TypePriorities} (which is an element of the component
- * descriptor). That is, if <code>a.start = b.start</code>, <code>a.end = b.end</code>, and
+ * on {@link org.apache.uima.resource.metadata.TypePriorities} if type priorities are specified.
+ * Type Priorities specification is an optional element of the component
+ * descriptor). When type priorities are in use, if <code>a.start = b.start</code>,
+ * <code>a.end = b.end</code>, and
* the type of <code>a</code> is defined before the type of <code>b</code> in the type
* priorities, then <code>a < b</code>.
* <li>
@@ -76,7 +78,7 @@ public interface AnnotationIndex<T exten
* @return A annotation iterator.
*/
FSIterator<T> iterator(boolean ambiguous);
-
+
/**
* Return a subiterator whose bounds are defined by the input annotation.
*