svn commit: r1633403 - in /uima/uimaj/trunk/uimaj-core/src/main/java/org/apache/uima: cas/impl/FSBagIndex.java cas/impl/FSIndexRepositoryImpl.java cas/impl/FSIntArrayIndex.java cas/impl/FSRBTSetIndex.java internal/util/rb_trees/CompIntArrayRBT.java

[sc...@apache.org]

Author: schor
Date: Tue Oct 21 15:47:04 2014
New Revision: 1633403

URL: http://svn.apache.org/r1633403
Log:
no Jira, comments improvement only

Modified:
    uima/uimaj/trunk/uimaj-core/src/main/java/org/apache/uima/cas/impl/FSBagIndex.java
    uima/uimaj/trunk/uimaj-core/src/main/java/org/apache/uima/cas/impl/FSIndexRepositoryImpl.java
    uima/uimaj/trunk/uimaj-core/src/main/java/org/apache/uima/cas/impl/FSIntArrayIndex.java
    uima/uimaj/trunk/uimaj-core/src/main/java/org/apache/uima/cas/impl/FSRBTSetIndex.java
    uima/uimaj/trunk/uimaj-core/src/main/java/org/apache/uima/internal/util/rb_trees/CompIntArrayRBT.java

Modified: uima/uimaj/trunk/uimaj-core/src/main/java/org/apache/uima/cas/impl/FSBagIndex.java
URL: http://svn.apache.org/viewvc/uima/uimaj/trunk/uimaj-core/src/main/java/org/apache/uima/cas/impl/FSBagIndex.java?rev=1633403&r1=1633402&r2=1633403&view=diff
==============================================================================
--- uima/uimaj/trunk/uimaj-core/src/main/java/org/apache/uima/cas/impl/FSBagIndex.java (original)
+++ uima/uimaj/trunk/uimaj-core/src/main/java/org/apache/uima/cas/impl/FSBagIndex.java Tue Oct 21 15:47:04 2014
@@ -29,6 +29,10 @@ import org.apache.uima.internal.util.Int
 import org.apache.uima.internal.util.IntPointerIterator;
 import org.apache.uima.internal.util.IntVector;
 
+/**
+ * Used for UIMA FS Bag Indexes
+ * Uses IntVector to hold values of FSs
+ */
 public class FSBagIndex extends FSLeafIndexImpl {
 
   private class IntVectorIterator implements ComparableIntPointerIterator, LowLevelIterator {

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=1633403&r1=1633402&r2=1633403&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 Tue Oct 21 15:47:04 2014
@@ -187,7 +187,7 @@ public class FSIndexRepositoryImpl imple
       return size;
     }
 
-  }
+  }  // end of class definition for IndexIteratorCachePair
 
   IntPointerIterator createPointerIterator(IndexIteratorCachePair iicp) {
     iicp.createIndexIteratorCache();
@@ -677,7 +677,7 @@ public class FSIndexRepositoryImpl imple
       return this.iicp.index;
     }
 
-  }
+  }  // end of class PointerIterator
 
   /**
    * The iterator implementation for indexes. Tricky because the iterator needs to be able to move
@@ -809,7 +809,7 @@ public class FSIndexRepositoryImpl imple
       return this.iicp.index;
     }
 
-  }
+  }  // end of LeafPointerIterator
 
   private class IndexImpl<T extends FeatureStructure> implements FSIndex<T>, FSIndexImpl {
 
@@ -1219,7 +1219,7 @@ public class FSIndexRepositoryImpl imple
   private IndexIteratorCachePair addNewIndexRec(FSIndexComparator comparator, int indexType) {
     final IndexIteratorCachePair iicp = this.addNewIndex(comparator, indexType);
     if (indexType == FSIndex.DEFAULT_BAG_INDEX) {
-      // In this special case, we do not add indeces for subtypes.
+      // In this special case, we do not add indices for subtypes.
       return iicp;
     }
     final Type superType = comparator.getType();

Modified: uima/uimaj/trunk/uimaj-core/src/main/java/org/apache/uima/cas/impl/FSIntArrayIndex.java
URL: http://svn.apache.org/viewvc/uima/uimaj/trunk/uimaj-core/src/main/java/org/apache/uima/cas/impl/FSIntArrayIndex.java?rev=1633403&r1=1633402&r2=1633403&view=diff
==============================================================================
--- uima/uimaj/trunk/uimaj-core/src/main/java/org/apache/uima/cas/impl/FSIntArrayIndex.java (original)
+++ uima/uimaj/trunk/uimaj-core/src/main/java/org/apache/uima/cas/impl/FSIntArrayIndex.java Tue Oct 21 15:47:04 2014
@@ -31,6 +31,7 @@ import org.apache.uima.internal.util.Int
 
 /**
  * Used for sorted indexes only
+ * Uses IntVector (sorted) as the index (of FSs)
  * @param <T> -
  */
 public class FSIntArrayIndex<T extends FeatureStructure> extends FSLeafIndexImpl<T> {

Modified: uima/uimaj/trunk/uimaj-core/src/main/java/org/apache/uima/cas/impl/FSRBTSetIndex.java
URL: http://svn.apache.org/viewvc/uima/uimaj/trunk/uimaj-core/src/main/java/org/apache/uima/cas/impl/FSRBTSetIndex.java?rev=1633403&r1=1633402&r2=1633403&view=diff
==============================================================================
--- uima/uimaj/trunk/uimaj-core/src/main/java/org/apache/uima/cas/impl/FSRBTSetIndex.java (original)
+++ uima/uimaj/trunk/uimaj-core/src/main/java/org/apache/uima/cas/impl/FSRBTSetIndex.java Tue Oct 21 15:47:04 2014
@@ -29,9 +29,11 @@ import org.apache.uima.internal.util.Int
 import org.apache.uima.internal.util.rb_trees.CompIntArrayRBT;
 
 /**
- * Same as FSRBTIndex, but duplicates are not inserted.
+ * Used for UIMA FS Set Indexes 
  * 
+ * Uses CompIntArrayRBT red black tree to hold items
  * 
+ * Same as FSRBTIndex, but duplicates are not inserted.
  */
 class FSRBTSetIndex<T extends FeatureStructure> extends FSLeafIndexImpl<T> {
 

Modified: uima/uimaj/trunk/uimaj-core/src/main/java/org/apache/uima/internal/util/rb_trees/CompIntArrayRBT.java
URL: http://svn.apache.org/viewvc/uima/uimaj/trunk/uimaj-core/src/main/java/org/apache/uima/internal/util/rb_trees/CompIntArrayRBT.java?rev=1633403&r1=1633402&r2=1633403&view=diff
==============================================================================
--- uima/uimaj/trunk/uimaj-core/src/main/java/org/apache/uima/internal/util/rb_trees/CompIntArrayRBT.java (original)
+++ uima/uimaj/trunk/uimaj-core/src/main/java/org/apache/uima/internal/util/rb_trees/CompIntArrayRBT.java Tue Oct 21 15:47:04 2014
@@ -22,7 +22,7 @@ package org.apache.uima.internal.util.rb
 import org.apache.uima.internal.util.IntComparator;
 
 /**
- * Class comment for CompIntArrayRBT.java goes here.
+ * Used for UIMA Set indexes
  * 
  * 
  */