Package org.apache.uima.cas.impl
Class FilteredIterator<T extends FeatureStructure>
java.lang.Object
org.apache.uima.cas.impl.FilteredIterator<T>
- All Implemented Interfaces:
Iterator<T>
,ListIterator<T>
,FSIterator<T>
,LowLevelIterator<T>
Implements a filtered iterator.
-
Field Summary
FieldsFields inherited from interface org.apache.uima.cas.impl.LowLevelIterator
FS_ITERATOR_LOW_LEVEL_EMPTY, IS_ORDERED
-
Constructor Summary
ConstructorsModifierConstructorDescriptionprivate
(package private)
FilteredIterator
(FSIterator<T> it, FSMatchConstraint cons) Create a filtered iterator from a base iterator and a constraint. -
Method Summary
Modifier and TypeMethodDescriptionprivate void
private void
copy()
Copy this iterator.getNvc()
Get the structure the iterator is pointing at.boolean
boolean
isValid()
Check if this iterator is valid.Get the index for just the top most type of this iterator (excludes subtypes).int
int
boolean
Internal usevoid
Internal use same as moveToFirst, but won't reset to use current contents of index if index has changedvoid
Internal use same as moveToLast, but won't reset to use current contents of index if index has changedvoid
version of moveToNext which bypasses the isValid check - call only if you've just done this check yourselfvoid
Internal use same as moveTo(fs), but won't reset to use current contents of index if index has changedvoid
version of moveToPrevious which bypasses the isValid check - call only if you've just done this check yourselfMethods inherited from class java.lang.Object
clone, equals, finalize, getClass, hashCode, notify, notifyAll, toString, wait, wait, wait
Methods inherited from interface org.apache.uima.cas.FSIterator
add, get, getType, hasNext, hasPrevious, moveToNext, moveToPrevious, next, nextIndex, nextNvc, previous, previousIndex, previousNvc, remove, set, size, spliterator, stream
Methods inherited from interface java.util.Iterator
forEachRemaining
Methods inherited from interface org.apache.uima.cas.impl.LowLevelIterator
getArrayList, isMoveToSupported, ll_get, ll_remove, moveTo, moveTo, moveToFirst, moveToLast
-
Field Details
-
it
-
cons
-
-
Constructor Details
-
FilteredIterator
private FilteredIterator() -
FilteredIterator
FilteredIterator(FSIterator<T> it, FSMatchConstraint cons) Create a filtered iterator from a base iterator and a constraint.
-
-
Method Details
-
isValid
public boolean isValid()Description copied from interface:FSIterator
Check if this iterator is valid.- Specified by:
isValid
in interfaceFSIterator<T extends FeatureStructure>
- Returns:
true
if the iterator is valid.
-
adjustForConstraintForward
private void adjustForConstraintForward() -
adjustForConstraintBackward
private void adjustForConstraintBackward() -
moveToFirstNoReinit
public void moveToFirstNoReinit()Description copied from interface:LowLevelIterator
Internal use same as moveToFirst, but won't reset to use current contents of index if index has changed- Specified by:
moveToFirstNoReinit
in interfaceLowLevelIterator<T extends FeatureStructure>
-
moveToLastNoReinit
public void moveToLastNoReinit()Description copied from interface:LowLevelIterator
Internal use same as moveToLast, but won't reset to use current contents of index if index has changed- Specified by:
moveToLastNoReinit
in interfaceLowLevelIterator<T extends FeatureStructure>
-
moveToNextNvc
public void moveToNextNvc()Description copied from interface:FSIterator
version of moveToNext which bypasses the isValid check - call only if you've just done this check yourself- Specified by:
moveToNextNvc
in interfaceFSIterator<T extends FeatureStructure>
-
moveToPreviousNvc
public void moveToPreviousNvc()Description copied from interface:FSIterator
version of moveToPrevious which bypasses the isValid check - call only if you've just done this check yourself- Specified by:
moveToPreviousNvc
in interfaceFSIterator<T extends FeatureStructure>
-
getNvc
Description copied from interface:FSIterator
Get the structure the iterator is pointing at. Throws various unchecked exceptions, if the iterator is not valid- Specified by:
getNvc
in interfaceFSIterator<T extends FeatureStructure>
- Returns:
- The structure the iterator is pointing at.
-
copy
Description copied from interface:FSIterator
Copy this iterator.- Specified by:
copy
in interfaceFSIterator<T extends FeatureStructure>
- Returns:
- A copy of this iterator, pointing at the same element.
- See Also:
-
moveToNoReinit
Description copied from interface:LowLevelIterator
Internal use same as moveTo(fs), but won't reset to use current contents of index if index has changed- Specified by:
moveToNoReinit
in interfaceLowLevelIterator<T extends FeatureStructure>
- Parameters:
fs
- the fs to use as the template identifying the place to move to- See Also:
-
ll_indexSizeMaybeNotCurrent
public int ll_indexSizeMaybeNotCurrent()- Specified by:
ll_indexSizeMaybeNotCurrent
in interfaceLowLevelIterator<T extends FeatureStructure>
- Returns:
- The size of the index. In case of copy-on-write, this returns the size of the index at the time the iterator was created, or at the last moveTo, moveToFirst, or moveToLast. To get the current index size, use ll_getIndex().getSize()
-
ll_getIndex
Description copied from interface:LowLevelIterator
Get the index for just the top most type of this iterator (excludes subtypes).- Specified by:
ll_getIndex
in interfaceLowLevelIterator<T extends FeatureStructure>
- Returns:
- The index.
-
ll_maxAnnotSpan
public int ll_maxAnnotSpan()- Specified by:
ll_maxAnnotSpan
in interfaceLowLevelIterator<T extends FeatureStructure>
- Returns:
- an estimate of the maximum span over all annotations (end - begin)
-
isIndexesHaveBeenUpdated
public boolean isIndexesHaveBeenUpdated()- Specified by:
isIndexesHaveBeenUpdated
in interfaceLowLevelIterator<T extends FeatureStructure>
- Returns:
- true if one or more of the underlying indexes this iterator goes over, has been updated since initialization or resetting operation (moveToFirst/Last/feature_structure). This includes empty iterators becoming non-empty.
-
maybeReinitIterator
public boolean maybeReinitIterator()Description copied from interface:LowLevelIterator
Internal use- Specified by:
maybeReinitIterator
in interfaceLowLevelIterator<T extends FeatureStructure>
- Returns:
- true if the iterator was refreshed to match the current index
-
getComparator
- Specified by:
getComparator
in interfaceLowLevelIterator<T extends FeatureStructure>
- Returns:
- the comparator used by this iterator. It is always a withoutID style, and may be either a withType or NoType style.
-