Package org.apache.uima.cas.impl
Class FsIndex_flat<T extends FeatureStructure>
- java.lang.Object
-
- java.util.AbstractCollection<T>
-
- org.apache.uima.cas.impl.FsIndex_singletype<T>
-
- org.apache.uima.cas.impl.FsIndex_flat<T>
-
- Type Parameters:
T
- the Java class type for this index
- All Implemented Interfaces:
java.lang.Iterable<T>
,java.util.Collection<T>
,java.util.Comparator<FeatureStructure>
,FSIndex<T>
,LowLevelIndex<T>
public class FsIndex_flat<T extends FeatureStructure> extends FsIndex_singletype<T>
Common part of flattened indexes, used for both snapshot iterators and flattened sorted indexes built from passed in instance of FsIndex_iicp
-
-
Field Summary
Fields Modifier and Type Field Description private java.util.Comparator<TOP>
comparatorWithoutId
private FsIndex_iicp<T>
iicp
private TOP[]
indexedFSs
private int
maxAnnotSpan
-
Fields inherited from class org.apache.uima.cas.impl.FsIndex_singletype
casImpl, comparatorForIndexSpecs, comparatorNoTypeWithID, comparatorNoTypeWithoutID, comparatorWithID, comparatorWithoutID, isAnnotIdx, type, wr_cow
-
Fields inherited from interface org.apache.uima.cas.FSIndex
BAG_INDEX, DEFAULT_BAG_INDEX, SET_INDEX, SORTED_INDEX
-
Fields inherited from interface org.apache.uima.cas.impl.LowLevelIndex
FS_ID_COMPARATOR, IS_ORDERED, IS_TYPE_ORDER
-
-
Constructor Summary
Constructors Constructor Description FsIndex_flat(FsIndex_iicp<T> iicp)
-
Method Summary
All Methods Instance Methods Concrete Methods Modifier and Type Method Description protected void
bulkAddTo(java.util.List<T> v)
For serialization: get all the items in this index and bulk add to an List<T>protected void
bulkAddTo(IntVector v)
int
compare(FeatureStructure fs1, FeatureStructure fs2)
This is required to avoid compilation error (but not in Eclipse) due to ambiguous interface inheritance from both FeatureStructure and Comparatorboolean
contains(FeatureStructure fs)
Check if the index contains an element equal to the given feature structure according to the comparators defined for this index.protected CopyOnWriteIndexPart
createCopyOnWriteIndexPart()
boolean
deleteFS(T fs)
private TOP[]
fillFlatArray()
Flat array filled, orderedT
find(FeatureStructure fs)
Find an entry in the index "equal to" the given feature structure according to the comparators specified for this index.(package private) FeatureStructure[]
getFlatArray()
(package private) void
insert(T fs)
Adding FS to an index.LowLevelIterator<T>
iterator()
Return an iterator over the index.LowLevelIterator<T>
iterator(boolean orderNotNeeded, boolean ignoreType)
Internal use, used by select framework.int
ll_maxAnnotSpan()
int
size()
Return the number of feature structures in this index.-
Methods inherited from class org.apache.uima.cas.impl.FsIndex_singletype
assertFsTypeMatchesIndexType, compare, compare, equals, flush, getCasImpl, getComparator, getComparatorForIndexSpecs, getComparatorImplForIndexSpecs, getCopyOnWriteIndexPart, getIndexingStrategy, getNonNullCow, getType, getTypeCode, getTypeImpl, hashCode, isSetOrSorted, isSorted, iterator, ll_compare, ll_iterator, maybeCopy, removeAll, toString, withSnapshotIterators
-
Methods inherited from class java.util.AbstractCollection
add, addAll, clear, contains, containsAll, isEmpty, remove, removeAll, retainAll, toArray, toArray
-
Methods inherited from class java.lang.Object
clone, finalize, getClass, notify, notifyAll, wait, wait, wait
-
Methods inherited from interface java.util.Collection
add, addAll, clear, contains, containsAll, isEmpty, parallelStream, remove, removeAll, removeIf, retainAll, spliterator, toArray, toArray
-
Methods inherited from interface java.util.Comparator
reversed, thenComparing, thenComparing, thenComparing, thenComparingDouble, thenComparingInt, thenComparingLong
-
Methods inherited from interface org.apache.uima.cas.impl.LowLevelIndex
getIntIterator, getSubIndex, getSubIndex, ll_iterator, select, select, select, select, select
-
-
-
-
Field Detail
-
indexedFSs
private final TOP[] indexedFSs
-
iicp
private final FsIndex_iicp<T extends FeatureStructure> iicp
-
comparatorWithoutId
private final java.util.Comparator<TOP> comparatorWithoutId
-
maxAnnotSpan
private final int maxAnnotSpan
-
-
Constructor Detail
-
FsIndex_flat
FsIndex_flat(FsIndex_iicp<T> iicp)
-
-
Method Detail
-
fillFlatArray
private TOP[] fillFlatArray()
Flat array filled, ordered- Parameters:
flatArray
- the array to fill
-
getFlatArray
FeatureStructure[] getFlatArray()
-
iterator
public LowLevelIterator<T> iterator()
Description copied from interface:LowLevelIndex
Return an iterator over the index. The position of the iterator will be set to return the first item in the index. If the index is empty, the iterator position will be marked as invalid.- Specified by:
iterator
in interfacejava.util.Collection<T extends FeatureStructure>
- Specified by:
iterator
in interfaceFSIndex<T extends FeatureStructure>
- Specified by:
iterator
in interfacejava.lang.Iterable<T extends FeatureStructure>
- Specified by:
iterator
in interfaceLowLevelIndex<T extends FeatureStructure>
- Specified by:
iterator
in classjava.util.AbstractCollection<T extends FeatureStructure>
- Returns:
- An FSIterator positioned at the beginning, or an invalid iterator.
-
iterator
public LowLevelIterator<T> iterator(boolean orderNotNeeded, boolean ignoreType)
Description copied from interface:LowLevelIndex
Internal use, used by select framework. Return an iterator over the index. The position of the iterator will be set to return the first item in the index. If the index is empty, the iterator position will be marked as invalid.- Parameters:
orderNotNeeded
- if true, skips work while iterating to keep iterators over multiple types in sync.ignoreType
- if true, the comparator used for moveTo leftmost operations will ignore typeOrder keys, if the index happens to define these- Returns:
- An FSIterator positioned at the beginning, or an invalid iterator.
-
insert
void insert(T fs)
Description copied from class:FsIndex_singletype
Adding FS to an index. not in upper interfaces because it's internal use only - called via addToIndexes etc.- Specified by:
insert
in classFsIndex_singletype<T extends FeatureStructure>
- Parameters:
fs
- the fs to be added
-
contains
public boolean contains(FeatureStructure fs)
Description copied from interface:FSIndex
Check if the index contains an element equal to the given feature structure according to the comparators defined for this index. For bag indexes (which have no comparators), the equality test means the identical feature structure. Note that this is in general not the same as feature structure identity.
The element is used as a template, and may be a supertype of the type of the index, as long as the keys specified for this index can be accessed.
- Parameters:
fs
- A Feature Structure used a template to match for equality with the FSs in the index.- Returns:
true
if the index contains such an element.
-
find
public T find(FeatureStructure fs)
Description copied from interface:FSIndex
Find an entry in the index "equal to" the given feature structure according to the comparators specified for this index. Note that this is in general not the same as feature structure identity. For BAG indexes, it is identity, for others it means the found feature structure compares equal with the parameter in terms of the defined comparators for the index. If there are multiple different FSs in the index which compare equal with the given feature structure, an arbitrary one is returned. This differs from the moveTo(fs) operation which guarantees to move to the first feature structure occurring in the index in this case.- Parameters:
fs
- A Feature Structure used a template to match with the Feature Structures in the index. It must have the keys needed to do the compare as specified for the index that it's in.- Returns:
- A FS equal to the template argument, or
null
if no such FS exists. - See Also:
FSIterator.moveTo(FeatureStructure)
-
size
public int size()
Description copied from interface:FSIndex
Return the number of feature structures in this index.- Specified by:
size
in interfacejava.util.Collection<T extends FeatureStructure>
- Specified by:
size
in interfaceFSIndex<T extends FeatureStructure>
- Specified by:
size
in classjava.util.AbstractCollection<T extends FeatureStructure>
- Returns:
- The number of FSs in this index.
- See Also:
FSIndex.size()
-
deleteFS
public boolean deleteFS(T fs)
- Specified by:
deleteFS
in classFsIndex_singletype<T extends FeatureStructure>
- Parameters:
fs
- - the Feature Structure to be removed. Only this exact Feature Structure is removed (this is a stronger test than, for example, what moveTo(fs) does, where the fs in that case is used as a template). It is not an error if this exact Feature Structure is not in an index.- Returns:
- true if something was removed, false if not found
- See Also:
FsIndex_singletype.deleteFS(FeatureStructure)
-
bulkAddTo
protected void bulkAddTo(java.util.List<T> v)
Description copied from class:FsIndex_singletype
For serialization: get all the items in this index and bulk add to an List<T>- Specified by:
bulkAddTo
in classFsIndex_singletype<T extends FeatureStructure>
- Parameters:
v
- the set of items to add
-
bulkAddTo
protected void bulkAddTo(IntVector v)
-
compare
public int compare(FeatureStructure fs1, FeatureStructure fs2)
Description copied from class:FsIndex_singletype
This is required to avoid compilation error (but not in Eclipse) due to ambiguous interface inheritance from both FeatureStructure and Comparator- Specified by:
compare
in interfacejava.util.Comparator<T extends FeatureStructure>
- Specified by:
compare
in interfaceFSIndex<T extends FeatureStructure>
- Specified by:
compare
in classFsIndex_singletype<T extends FeatureStructure>
- Parameters:
fs1
- the first Feature Structure to comparefs2
- the second Feature Structure to compare- Returns:
-1
iffs1 < fs2
;0
iffs1 = fs2
;1
else.- See Also:
FSIndex.compare(FeatureStructure, FeatureStructure)
-
createCopyOnWriteIndexPart
protected CopyOnWriteIndexPart createCopyOnWriteIndexPart()
- Specified by:
createCopyOnWriteIndexPart
in classFsIndex_singletype<T extends FeatureStructure>
-
ll_maxAnnotSpan
public int ll_maxAnnotSpan()
- Returns:
- for annotation indexes, an conservative estimate the maximum span between begin and end The value may be larger than actual.
-
-