Package org.apache.uima.cas.impl
Class LowLevelIterator_empty<T extends FeatureStructure>
java.lang.Object
org.apache.uima.cas.impl.LowLevelIterator_empty<T>
- All Implemented Interfaces:
Iterator<T>,ListIterator<T>,FSIterator<T>,LowLevelIterator<T>
public class LowLevelIterator_empty<T extends FeatureStructure>
extends Object
implements LowLevelIterator<T>
An empty Low-level FS iterator
-
Field Summary
Fields inherited from interface org.apache.uima.cas.impl.LowLevelIterator
FS_ITERATOR_LOW_LEVEL_EMPTY, IS_ORDERED -
Constructor Summary
Constructors -
Method Summary
Modifier and TypeMethodDescriptioncopy()Copy this iterator.getNvc()Get the structure the iterator is pointing at.getType()booleanbooleanisValid()Check if this iterator is valid.Get the index for just the top most type of this iterator (excludes subtypes).intintbooleanInternal usevoidInternal use same as moveToFirst, but won't reset to use current contents of index if index has changedvoidInternal use same as moveToLast, but won't reset to use current contents of index if index has changedvoidversion of moveToNext which bypasses the isValid check - call only if you've just done this check yourselfvoidInternal use same as moveTo(fs), but won't reset to use current contents of index if index has changedvoidversion of moveToPrevious which bypasses the isValid check - call only if you've just done this check yourselfintsize()return the size of the collection being iterated over, if available.Methods inherited from class java.lang.Object
clone, equals, finalize, getClass, hashCode, notify, notifyAll, toString, wait, wait, waitMethods inherited from interface org.apache.uima.cas.FSIterator
add, get, hasNext, hasPrevious, moveToNext, moveToPrevious, next, nextIndex, nextNvc, previous, previousIndex, previousNvc, remove, set, spliterator, streamMethods inherited from interface java.util.Iterator
forEachRemainingMethods inherited from interface org.apache.uima.cas.impl.LowLevelIterator
getArrayList, isMoveToSupported, ll_get, ll_remove, moveTo, moveTo, moveToFirst, moveToLast
-
Constructor Details
-
LowLevelIterator_empty
public LowLevelIterator_empty()
-
-
Method Details
-
isValid
public boolean isValid()Description copied from interface:FSIteratorCheck if this iterator is valid.- Specified by:
isValidin interfaceFSIterator<T extends FeatureStructure>- Returns:
trueif the iterator is valid.
-
getNvc
Description copied from interface:FSIteratorGet the structure the iterator is pointing at. Throws various unchecked exceptions, if the iterator is not valid- Specified by:
getNvcin interfaceFSIterator<T extends FeatureStructure>- Returns:
- The structure the iterator is pointing at.
-
moveToFirstNoReinit
public void moveToFirstNoReinit()Description copied from interface:LowLevelIteratorInternal use same as moveToFirst, but won't reset to use current contents of index if index has changed- Specified by:
moveToFirstNoReinitin interfaceLowLevelIterator<T extends FeatureStructure>
-
moveToLastNoReinit
public void moveToLastNoReinit()Description copied from interface:LowLevelIteratorInternal use same as moveToLast, but won't reset to use current contents of index if index has changed- Specified by:
moveToLastNoReinitin interfaceLowLevelIterator<T extends FeatureStructure>
-
moveToNoReinit
Description copied from interface:LowLevelIteratorInternal use same as moveTo(fs), but won't reset to use current contents of index if index has changed- Specified by:
moveToNoReinitin interfaceLowLevelIterator<T extends FeatureStructure>- Parameters:
fs- the fs to use as the template identifying the place to move to
-
copy
Description copied from interface:FSIteratorCopy this iterator.- Specified by:
copyin interfaceFSIterator<T extends FeatureStructure>- Returns:
- A copy of this iterator, pointing at the same element.
-
moveToNextNvc
public void moveToNextNvc()Description copied from interface:FSIteratorversion of moveToNext which bypasses the isValid check - call only if you've just done this check yourself- Specified by:
moveToNextNvcin interfaceFSIterator<T extends FeatureStructure>
-
moveToPreviousNvc
public void moveToPreviousNvc()Description copied from interface:FSIteratorversion of moveToPrevious which bypasses the isValid check - call only if you've just done this check yourself- Specified by:
moveToPreviousNvcin interfaceFSIterator<T extends FeatureStructure>
-
ll_indexSizeMaybeNotCurrent
public int ll_indexSizeMaybeNotCurrent()- Specified by:
ll_indexSizeMaybeNotCurrentin 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_maxAnnotSpan
public int ll_maxAnnotSpan()- Specified by:
ll_maxAnnotSpanin interfaceLowLevelIterator<T extends FeatureStructure>- Returns:
- an estimate of the maximum span over all annotations (end - begin)
-
ll_getIndex
Description copied from interface:LowLevelIteratorGet the index for just the top most type of this iterator (excludes subtypes).- Specified by:
ll_getIndexin interfaceLowLevelIterator<T extends FeatureStructure>- Returns:
- The index.
-
isIndexesHaveBeenUpdated
public boolean isIndexesHaveBeenUpdated()- Specified by:
isIndexesHaveBeenUpdatedin 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:LowLevelIteratorInternal use- Specified by:
maybeReinitIteratorin interfaceLowLevelIterator<T extends FeatureStructure>- Returns:
- true if the iterator was refreshed to match the current index
-
getComparator
- Specified by:
getComparatorin 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.
-
getType
- Specified by:
getTypein interfaceFSIterator<T extends FeatureStructure>- Returns:
- the type this iterator is over
-
size
public int size()Description copied from interface:FSIteratorreturn the size of the collection being iterated over, if available. Because the iterator can move forwards and backwards, the size is the total size that the iterator would iterate over, starting at the first element thru the last element. This may be inefficient to compute.- Specified by:
sizein interfaceFSIterator<T extends FeatureStructure>- Returns:
- the size of the collection being iterated over.
-