svn commit: r1459116 - /uima/uimaj/branches/filteredCompress-uima-2498/uimaj-core/src/main/java/org/apache/uima/cas/impl/CasSeqAddrMaps.java

[schor]

Author: schor
Date: Thu Mar 21 01:17:15 2013
New Revision: 1459116

URL: http://svn.apache.org/r1459116
Log:
[UIMA-2498] add comments

Modified:
    
uima/uimaj/branches/filteredCompress-uima-2498/uimaj-core/src/main/java/org/apache/uima/cas/impl/CasSeqAddrMaps.java

Modified: 
uima/uimaj/branches/filteredCompress-uima-2498/uimaj-core/src/main/java/org/apache/uima/cas/impl/CasSeqAddrMaps.java
URL: 
http://svn.apache.org/viewvc/uima/uimaj/branches/filteredCompress-uima-2498/uimaj-core/src/main/java/org/apache/uima/cas/impl/CasSeqAddrMaps.java?rev=1459116&r1=1459115&r2=1459116&view=diff
==============================================================================
--- 
uima/uimaj/branches/filteredCompress-uima-2498/uimaj-core/src/main/java/org/apache/uima/cas/impl/CasSeqAddrMaps.java
 (original)
+++ 
uima/uimaj/branches/filteredCompress-uima-2498/uimaj-core/src/main/java/org/apache/uima/cas/impl/CasSeqAddrMaps.java
 Thu Mar 21 01:17:15 2013
@@ -152,7 +152,12 @@ public class CasSeqAddrMaps {
 //    tgtSeq2TgtAddr.add(-1);  // not used I hope - need to check TODO
     nextTgt++;
   }
-                 
+             
+  /**
+   * 
+   * @param seq
+   * @return 0 means target seq doesn't exist in source CAS
+   */
   public int getSrcAddrFromTgtSeq(int seq) {
     return tgtSeq2SrcAddr.get(seq);
   }
@@ -169,6 +174,9 @@ public class CasSeqAddrMaps {
 //    }
 //  }
   
+  /**
+   * returns -1 if src addr not in target seq
+   */
   public int getTgtSeqFromSrcAddr(int itemAddr) {
     return srcAddr2TgtSeq.get(itemAddr);      
   }