Package org.apache.uima.cas.impl
Class FsIndex_snapshot<T extends FeatureStructure>
java.lang.Object
java.util.AbstractCollection<T>
org.apache.uima.cas.impl.FsIndex_snapshot<T>
- All Implemented Interfaces:
Iterable<T>,Collection<T>,Comparator<FeatureStructure>,FSIndex<T>,LowLevelIndex<T>
public class FsIndex_snapshot<T extends FeatureStructure>
extends AbstractCollection<T>
implements LowLevelIndex<T>, Comparator<FeatureStructure>
Implementation of light-weight wrapper of normal indexes, which support special kinds of
iterators base on the setting of IteratorExtraFunction
-
Field Summary
Fields inherited from interface org.apache.uima.cas.FSIndex
BAG_INDEX, DEFAULT_BAG_INDEX, SET_INDEX, SORTED_INDEXFields inherited from interface org.apache.uima.cas.impl.LowLevelIndex
FS_ID_COMPARATOR, IS_ORDERED, IS_TYPE_ORDER -
Constructor Summary
ConstructorsConstructorDescriptionFsIndex_snapshot(org.apache.uima.cas.impl.FsIndex_iicp<T> wrapped, Comparator<TOP> comparatorWithoutId, Comparator<TOP> comparatorTypeWithoutId) -
Method Summary
Modifier and TypeMethodDescriptionintcompare(FeatureStructure o1, FeatureStructure o2) Compare two feature structures according to the ordering relation of the index.booleanCheck if the index contains an element equal to the given feature structure according to the comparators defined for this index.find(FeatureStructure fs) Find an entry in the index "equal to" the given feature structure according to the comparators specified for this index.This is **NOT** a comparator for Feature Structures, but rather something that compares two comparator specificationsintReturn the indexing strategy.getType()Return the type of feature structures this index contains.booleanisSorted()iterator()Return an iterator over the index.iterator(boolean orderNotNeeded, boolean ignoreType) Internal use, used by select framework.intll_compare(int ref1, int ref2) Compare two Feature structures, referred to by IDsll_iterator(boolean ambiguous) Get a low-level, FS reference iterator.intintsize()Return the number of feature structures in this index.Creates a shared copy of this FSIndex configured to produce snapshot iterators that don't throw ConcurrentModificationExceptions.Methods inherited from class java.util.AbstractCollection
add, addAll, clear, contains, containsAll, isEmpty, remove, removeAll, retainAll, toArray, toArray, toStringMethods inherited from class java.lang.Object
clone, equals, finalize, getClass, hashCode, notify, notifyAll, wait, wait, waitMethods inherited from interface java.util.Collection
add, addAll, clear, contains, containsAll, equals, hashCode, isEmpty, parallelStream, remove, removeAll, removeIf, retainAll, spliterator, toArray, toArray, toArrayMethods inherited from interface java.util.Comparator
equals, reversed, thenComparing, thenComparing, thenComparing, thenComparingDouble, thenComparingInt, thenComparingLongMethods inherited from interface org.apache.uima.cas.impl.LowLevelIndex
flush, getIntIterator, getSubIndex, getSubIndex, ll_iterator, select, select, select, select, select
-
Constructor Details
-
FsIndex_snapshot
public FsIndex_snapshot(org.apache.uima.cas.impl.FsIndex_iicp<T> wrapped, Comparator<TOP> comparatorWithoutId, Comparator<TOP> comparatorTypeWithoutId)
-
-
Method Details
-
getType
Description copied from interface:FSIndexReturn the type of feature structures this index contains.- Specified by:
getTypein interfaceFSIndex<T extends FeatureStructure>- Returns:
- The type of feature structures in this index.
-
contains
Description copied from interface:FSIndexCheck 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.
- Specified by:
containsin interfaceFSIndex<T extends FeatureStructure>- Parameters:
fs- A Feature Structure used a template to match for equality with the FSs in the index.- Returns:
trueif the index contains such an element.
-
find
Description copied from interface:FSIndexFind 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.- Specified by:
findin interfaceFSIndex<T extends FeatureStructure>- 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
nullif no such FS exists. - See Also:
-
iterator
Description copied from interface:LowLevelIndexReturn 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:
iteratorin interfaceCollection<T extends FeatureStructure>- Specified by:
iteratorin interfaceFSIndex<T extends FeatureStructure>- Specified by:
iteratorin interfaceIterable<T extends FeatureStructure>- Specified by:
iteratorin interfaceLowLevelIndex<T extends FeatureStructure>- Specified by:
iteratorin classAbstractCollection<T extends FeatureStructure>- Returns:
- An FSIterator positioned at the beginning, or an invalid iterator.
-
iterator
Description copied from interface:LowLevelIndexInternal 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.- Specified by:
iteratorin interfaceLowLevelIndex<T extends FeatureStructure>- 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.
-
getIndexingStrategy
public int getIndexingStrategy()Description copied from interface:FSIndexReturn the indexing strategy.- Specified by:
getIndexingStrategyin interfaceFSIndex<T extends FeatureStructure>- Returns:
- One of
SORTED_INDEX,BAG_INDEXorSET_INDEX.
-
withSnapshotIterators
Description copied from interface:FSIndexCreates a shared copy of this FSIndex configured to produce snapshot iterators that don't throw ConcurrentModificationExceptions.- Specified by:
withSnapshotIteratorsin interfaceFSIndex<T extends FeatureStructure>- Returns:
- a light-weight copy of this FSIndex, configured such that any iterator created using it will be a snapshot iterator - one where a snapshot is made of the state of the index at the time the iterator is created, and where subsequent modifications to the underlying index are allowed, but don't affect the iterator (which iterates over the read-only snapshot). Iterators produced with this won't throw ConcurrentModificationExceptions.
-
size
public int size()Description copied from interface:FSIndexReturn the number of feature structures in this index.- Specified by:
sizein interfaceCollection<T extends FeatureStructure>- Specified by:
sizein interfaceFSIndex<T extends FeatureStructure>- Specified by:
sizein classAbstractCollection<T extends FeatureStructure>- Returns:
- The number of FSs in this index.
-
compare
Description copied from interface:FSIndexCompare two feature structures according to the ordering relation of the index. If the input feature structures are not of the type of the index or a supertype, the result is undefined. Because the indexes compare might use only features defined in supertypes, the arguments being compared could be supertypes of the indexed type.- Specified by:
comparein interfaceComparator<T extends FeatureStructure>- Specified by:
comparein interfaceFSIndex<T extends FeatureStructure>- Parameters:
o1- the first Feature Structure to compareo2- the second Feature Structure to compare- Returns:
-1iffs1 < fs2;0iffs1 = fs2;1else.
-
ll_iterator
Description copied from interface:LowLevelIndexGet 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_iteratorin interfaceLowLevelIndex<T extends FeatureStructure>- Parameters:
ambiguous- When set tofalse, iterator will be disambiguated.- Returns:
- An iterator for this index.
-
ll_compare
public int ll_compare(int ref1, int ref2) Description copied from interface:LowLevelIndexCompare two Feature structures, referred to by IDs- Specified by:
ll_comparein interfaceLowLevelIndex<T extends FeatureStructure>- Parameters:
ref1- -ref2- -- Returns:
- -
-
getCasImpl
- Specified by:
getCasImplin interfaceLowLevelIndex<T extends FeatureStructure>- Returns:
- a CAS View associated with this iterator
-
getComparator
- Specified by:
getComparatorin interfaceLowLevelIndex<T extends FeatureStructure>- Returns:
- a comparator used by this index to compare Feature Structures For sets, the equal is used to determine set membership For sorted, the comparator is the sort order (this comparator is without the ID)
-
getComparatorForIndexSpecs
Description copied from interface:LowLevelIndexThis is **NOT** a comparator for Feature Structures, but rather something that compares two comparator specifications- Specified by:
getComparatorForIndexSpecsin interfaceLowLevelIndex<T extends FeatureStructure>- Returns:
- -
-
ll_maxAnnotSpan
public int ll_maxAnnotSpan()- Specified by:
ll_maxAnnotSpanin interfaceLowLevelIndex<T extends FeatureStructure>- Returns:
- for annotation indexes, an conservative estimate the maximum span between begin and end The value may be larger than actual.
-
isSorted
public boolean isSorted()- Specified by:
isSortedin interfaceLowLevelIndex<T extends FeatureStructure>- Returns:
- true if the index is sorted
-