svn commit: r1666198 - /uima/uimaj/trunk/uimaj-core/src/main/java/org/apache/uima/cas/impl/FSIndexRepositoryImpl.java

[sc...@apache.org]

Author: schor
Date: Thu Mar 12 14:05:03 2015
New Revision: 1666198

URL: http://svn.apache.org/r1666198
Log:
no Jira - comment changes only

Modified:
    uima/uimaj/trunk/uimaj-core/src/main/java/org/apache/uima/cas/impl/FSIndexRepositoryImpl.java

Modified: uima/uimaj/trunk/uimaj-core/src/main/java/org/apache/uima/cas/impl/FSIndexRepositoryImpl.java
URL: http://svn.apache.org/viewvc/uima/uimaj/trunk/uimaj-core/src/main/java/org/apache/uima/cas/impl/FSIndexRepositoryImpl.java?rev=1666198&r1=1666197&r2=1666198&view=diff
==============================================================================
--- uima/uimaj/trunk/uimaj-core/src/main/java/org/apache/uima/cas/impl/FSIndexRepositoryImpl.java (original)
+++ uima/uimaj/trunk/uimaj-core/src/main/java/org/apache/uima/cas/impl/FSIndexRepositoryImpl.java Thu Mar 12 14:05:03 2015
@@ -198,8 +198,13 @@ public class FSIndexRepositoryImpl imple
       }  // end of synchronized block
     }
 
-
+    
     /**
+     * Maybe not used 3/2015
+     * 
+     * Compares first using the type code of the main types
+     *   If those are equal,
+     *   Compares using the comparator objects
      * @see java.lang.Comparable#compareTo(Object)
      */
     public int compareTo(IndexIteratorCachePair o) {
@@ -215,6 +220,10 @@ public class FSIndexRepositoryImpl imple
       }
     }
 
+    /**
+     * 
+     * @return the sum of the sizes of the indexes of the type + all subtypes
+     */
     int size() {
       int size = 0;
       createIndexIteratorCache();  // does nothing if already created
@@ -228,10 +237,21 @@ public class FSIndexRepositoryImpl imple
 
   }  // end of class definition for IndexIteratorCachePair
 
+  /**
+   * Create an "ordered" (e.g. one that maintains iicp sort order for sorted index) pointer iterator over an iicp
+   * @param iicp - the index plus its subtype list of indexes
+   * @return an int iterator
+   */
   IntPointerIterator createPointerIterator(IndexIteratorCachePair iicp) {
     return createPointerIterator(iicp, false);
   }
 
+  /**
+   * Create an ordered or iicp-unordered pointer iterator over an iicp 
+   * @param iicp - the index plus its subtype list of indexes
+   * @param is_unordered true if ordering among subtypes not needed
+   * @return an int iterator
+   */
   IntPointerIterator createPointerIterator(IndexIteratorCachePair iicp, boolean is_unordered) {
     iicp.createIndexIteratorCache();
     if (iicp.iteratorCache.size() > 1) {