Package org.apache.uima.cas.impl
Class FSLeafIndexImpl<T extends FeatureStructure>
- java.lang.Object
-
- org.apache.uima.cas.impl.FSLeafIndexImpl<T>
-
- Type Parameters:
T
- the Java cover class type for this index, passed along to (wrapped) iterators producing Java cover classes
- All Implemented Interfaces:
java.util.Comparator<T>
,FSIndexImpl
,LowLevelIndex
,IntComparator
- Direct Known Subclasses:
FSBagIndex
,FSIntArrayIndex
,FSRBTSetIndex
public abstract class FSLeafIndexImpl<T extends FeatureStructure> extends java.lang.Object implements java.util.Comparator<T>, IntComparator, FSIndexImpl
The common (among all index kinds - set, sorted, bag) info for an index Subtypes define the actual index repository (integers indexing the CAS) for each kind.
-
-
Field Summary
Fields Modifier and Type Field Description protected CASImpl
lowLevelCAS
-
Constructor Summary
Constructors Modifier Constructor Description protected
FSLeafIndexImpl(CASImpl cas, Type type, int indexType)
Constructor for FSLeafIndexImpl.
-
Method Summary
All Methods Instance Methods Abstract Methods Concrete Methods Modifier and Type Method Description protected abstract void
bulkAddTo(IntVector v)
For serialization: get all the items in this index and bulk add to an IntVectorint
compare(int fs1, int fs2)
Note: may return other than -1 , 0, and 1 (e.g., might return -6)int
compare(FeatureStructure fs1, FeatureStructure fs2)
abstract void
deleteFS(FeatureStructure fs)
Method deleteFS.boolean
equals(java.lang.Object obj)
FSIndexComparator
getComparator()
int
getIndexingStrategy()
IntPointerIterator
getIntIterator()
Type
getType()
int
hashCode()
FSIterator<T>
iterator(FeatureStructure fs)
int
ll_compare(int fs1, int fs2)
Note: may return other than -1 , 0, and 1 (e.g., might return -6)LowLevelIterator
ll_iterator(boolean ambiguous)
Get a low-level, FS reference iterator.LowLevelIterator
ll_rootIterator()
Get a low-level, FS reference iterator specifying instances of the precise type only (i.e.abstract ComparableIntPointerIterator<T>
pointerIterator(IntComparator comp, int[] detectIllegalIndexUpdates, int typeCode)
protected abstract IntPointerIterator
refIterator()
protected abstract IntPointerIterator
refIterator(int fsCode)
java.lang.String
toString()
-
Methods inherited from class java.lang.Object
clone, finalize, getClass, notify, notifyAll, wait, wait, wait
-
Methods inherited from interface java.util.Comparator
reversed, thenComparing, thenComparing, thenComparing, thenComparingDouble, thenComparingInt, thenComparingLong
-
Methods inherited from interface org.apache.uima.cas.impl.FSIndexImpl
flush
-
Methods inherited from interface org.apache.uima.cas.impl.LowLevelIndex
ll_iterator, size
-
-
-
-
Field Detail
-
lowLevelCAS
protected final CASImpl lowLevelCAS
-
-
Method Detail
-
toString
public java.lang.String toString()
- Overrides:
toString
in classjava.lang.Object
-
pointerIterator
public abstract ComparableIntPointerIterator<T> pointerIterator(IntComparator comp, int[] detectIllegalIndexUpdates, int typeCode)
-
getComparator
public FSIndexComparator getComparator()
- Specified by:
getComparator
in interfaceFSIndexImpl
- Returns:
- the FSIndexComparator structure used by this index
-
getIndexingStrategy
public int getIndexingStrategy()
-
ll_compare
public int ll_compare(int fs1, int fs2)
Note: may return other than -1 , 0, and 1 (e.g., might return -6)- Specified by:
ll_compare
in interfaceLowLevelIndex
- Parameters:
fs1
- -fs2
- -- Returns:
- 0 if equal, < 0 if fs1 < fs2, > 0 if fs1 > fs2
-
compare
public int compare(int fs1, int fs2)
Note: may return other than -1 , 0, and 1 (e.g., might return -6)- Specified by:
compare
in interfaceIntComparator
- Parameters:
fs1
- -fs2
- -- Returns:
- 0 if equal, < 0 if fs1 < fs2, > 0 if fs1 > fs2
-
hashCode
public int hashCode()
- Overrides:
hashCode
in classjava.lang.Object
-
equals
public boolean equals(java.lang.Object obj)
- Specified by:
equals
in interfacejava.util.Comparator<T extends FeatureStructure>
- Overrides:
equals
in classjava.lang.Object
-
compare
public int compare(FeatureStructure fs1, FeatureStructure fs2)
- Specified by:
compare
in interfacejava.util.Comparator<T extends FeatureStructure>
- See Also:
FSIndex.compare(FeatureStructure, FeatureStructure)
-
getType
public Type getType()
- Returns:
- The type of feature structures in this index.
- See Also:
FSIndex.getType()
-
refIterator
protected abstract IntPointerIterator refIterator()
-
getIntIterator
public IntPointerIterator getIntIterator()
- Specified by:
getIntIterator
in interfaceFSIndexImpl
-
bulkAddTo
protected abstract void bulkAddTo(IntVector v)
For serialization: get all the items in this index and bulk add to an IntVector- Parameters:
v
- the set of items to add
-
refIterator
protected abstract IntPointerIterator refIterator(int fsCode)
-
iterator
public FSIterator<T> iterator(FeatureStructure fs)
-
deleteFS
public abstract void deleteFS(FeatureStructure fs)
Method deleteFS.- Parameters:
fs
- -
-
ll_iterator
public LowLevelIterator ll_iterator(boolean ambiguous)
Description copied from interface:LowLevelIndex
Get a low-level, FS reference iterator. This iterator can be disambiguated. This means that only non-overlapping annotations will be returned. Non-annotation FSs will be filtered in this mode.- Specified by:
ll_iterator
in interfaceLowLevelIndex
- Parameters:
ambiguous
- When set tofalse
, iterator will be disambiguated.- Returns:
- An iterator for this index.
-
ll_rootIterator
public LowLevelIterator ll_rootIterator()
Description copied from interface:LowLevelIndex
Get a low-level, FS reference iterator specifying instances of the precise type only (i.e. without listing the subtypes).- Specified by:
ll_rootIterator
in interfaceLowLevelIndex
- Returns:
- An iterator for the root type of this index.
-
-