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 2015/06/25 21:50:54 UTC
svn commit: r1687621 - in
/uima/uimaj/trunk/uimaj-core/src/main/java/org/apache/uima: cas/impl/ util/
Author: schor
Date: Thu Jun 25 19:50:54 2015
New Revision: 1687621
URL: http://svn.apache.org/r1687621
Log:
no Jira - javadoc comment corrections
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/FSIndexFlat.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/FSIntIteratorImplBase.java
uima/uimaj/trunk/uimaj-core/src/main/java/org/apache/uima/cas/impl/FSLeafIndexImpl.java
uima/uimaj/trunk/uimaj-core/src/main/java/org/apache/uima/util/CasCopier.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=1687621&r1=1687620&r2=1687621&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 Thu Jun 25 19:50:54 2015
@@ -111,7 +111,7 @@ public class FSBagIndex<T extends Featur
* because that's the only time there are multiple instances of the same
* (meaning having the same heap address) item
* @param ele
- * @return
+ * @return -1 if the item is not found, or a position value that can be used with iterators to start at that item.
*/
int findLeftmost(int ele) {
if (USE_POSITIVE_INT_SET) {
Modified: uima/uimaj/trunk/uimaj-core/src/main/java/org/apache/uima/cas/impl/FSIndexFlat.java
URL: http://svn.apache.org/viewvc/uima/uimaj/trunk/uimaj-core/src/main/java/org/apache/uima/cas/impl/FSIndexFlat.java?rev=1687621&r1=1687620&r2=1687621&view=diff
==============================================================================
--- uima/uimaj/trunk/uimaj-core/src/main/java/org/apache/uima/cas/impl/FSIndexFlat.java (original)
+++ uima/uimaj/trunk/uimaj-core/src/main/java/org/apache/uima/cas/impl/FSIndexFlat.java Thu Jun 25 19:50:54 2015
@@ -384,7 +384,7 @@ public class FSIndexFlat<T extends Featu
/**
* Constructor
*
- * @param indexarg the sorted index for a type being cached
+ * @param iicp the sorted index for a type being cached
*/
public FSIndexFlat(IndexIteratorCachePair<T> iicp) {
this.iicp = iicp;
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=1687621&r1=1687620&r2=1687621&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 Jun 25 19:50:54 2015
@@ -2141,10 +2141,10 @@ public class FSIndexRepositoryImpl imple
// }
/**
- * Top level call to add the indexs for a particular index definition
+ * Top level call to add the indexes for a particular index definition
* @param comparator
* @param indexType
- * @return
+ * @return the iicp for the top new index
*/
private IndexIteratorCachePair<? extends FeatureStructure> addNewIndexRecursive(FSIndexComparator comparator, int indexType) {
final FSIndexComparatorImpl compCopy = ((FSIndexComparatorImpl) comparator).copy();
@@ -2194,7 +2194,7 @@ public class FSIndexRepositoryImpl imple
* DEFAULT_BAG_INDEX), call yourself recursively to add the indexes for all the directly subsumed subtypes.
* @param comparator
* @param indexType
- * @return
+ * @return the new iicp for the new index
*/
private IndexIteratorCachePair<? extends FeatureStructure> addNewIndexRec(FSIndexComparator comparator, int indexType) {
final IndexIteratorCachePair<? extends FeatureStructure> iicp = this.addNewIndex(comparator, indexType);
Modified: uima/uimaj/trunk/uimaj-core/src/main/java/org/apache/uima/cas/impl/FSIntIteratorImplBase.java
URL: http://svn.apache.org/viewvc/uima/uimaj/trunk/uimaj-core/src/main/java/org/apache/uima/cas/impl/FSIntIteratorImplBase.java?rev=1687621&r1=1687620&r2=1687621&view=diff
==============================================================================
--- uima/uimaj/trunk/uimaj-core/src/main/java/org/apache/uima/cas/impl/FSIntIteratorImplBase.java (original)
+++ uima/uimaj/trunk/uimaj-core/src/main/java/org/apache/uima/cas/impl/FSIntIteratorImplBase.java Thu Jun 25 19:50:54 2015
@@ -74,7 +74,7 @@ public abstract class FSIntIteratorImplB
/**
*
- * @param index
+ * @param fsLeafIndexImpl the leaf index this iterator is over
* @param detectIllegalIndexUpdates may be null
*/
public FSIntIteratorImplBase(FSLeafIndexImpl<T> fsLeafIndexImpl, int[] detectIllegalIndexUpdates) {
Modified: uima/uimaj/trunk/uimaj-core/src/main/java/org/apache/uima/cas/impl/FSLeafIndexImpl.java
URL: http://svn.apache.org/viewvc/uima/uimaj/trunk/uimaj-core/src/main/java/org/apache/uima/cas/impl/FSLeafIndexImpl.java?rev=1687621&r1=1687620&r2=1687621&view=diff
==============================================================================
--- uima/uimaj/trunk/uimaj-core/src/main/java/org/apache/uima/cas/impl/FSLeafIndexImpl.java (original)
+++ uima/uimaj/trunk/uimaj-core/src/main/java/org/apache/uima/cas/impl/FSLeafIndexImpl.java Thu Jun 25 19:50:54 2015
@@ -254,8 +254,8 @@ public abstract class FSLeafIndexImpl<T
* @param fs2 -
* @return 0 if equal, < 0 if fs1 < fs2, > 0 if fs1 > fs2
*/
- public int ll_compare(int ref1, int ref2) {
- return this.compare(ref1, ref2);
+ public int ll_compare(int fs1, int fs2) {
+ return this.compare(fs1, fs2);
}
/**
Modified: uima/uimaj/trunk/uimaj-core/src/main/java/org/apache/uima/util/CasCopier.java
URL: http://svn.apache.org/viewvc/uima/uimaj/trunk/uimaj-core/src/main/java/org/apache/uima/util/CasCopier.java?rev=1687621&r1=1687620&r2=1687621&view=diff
==============================================================================
--- uima/uimaj/trunk/uimaj-core/src/main/java/org/apache/uima/util/CasCopier.java (original)
+++ uima/uimaj/trunk/uimaj-core/src/main/java/org/apache/uima/util/CasCopier.java Thu Jun 25 19:50:54 2015
@@ -801,10 +801,17 @@ public class CasCopier {
* @param aFS a feature structure
* @return true if the given FS has already been copied using this CasCopier.
*/
- public boolean alreadyCopied(FeatureStructure aFs) {
- return alreadyCopied(((FeatureStructureImpl)aFs).getAddress());
+ public boolean alreadyCopied(FeatureStructure aFS) {
+ return alreadyCopied(((FeatureStructureImpl)aFS).getAddress());
}
+ /**
+ * Note: if lenient is in effect, this method will return false for
+ * FSs which are not copied because the target doesn't have that type.
+ * It also returns false for sofa FSs and the documentAnnotation FS.
+ * @param aFS a feature structure
+ * @return true if the given FS has already been copied using this CasCopier.
+ */
public boolean alreadyCopied(int aFS) {
return mFsMap.get(aFS) != 0;
}