Package org.apache.uima.cas.impl
Class LLUnambiguousIteratorImpl
java.lang.Object
org.apache.uima.cas.impl.LLUnambiguousIteratorImpl
- All Implemented Interfaces:
LowLevelIterator
-
Constructor Summary
Constructors -
Method Summary
Modifier and TypeMethodDescriptioncopy()Create a copy of this iterator.booleanisValid()Check if the iterator is currently valid.intll_get()Return the current FS reference.Get the index for just the top most type of this iterator (excludes subtypes).intReturn the size of the underlying index.voidmoveTo(int fsRef) Try to position the iterator so that the current element is greater than or equal tofsRef, and previous elements are less thanfsRef.voidMove iterator to first FS in index.voidMove iterator to last FS in index.voidAdvance the iterator.voidMove the iterator back one position.
-
Constructor Details
-
LLUnambiguousIteratorImpl
-
-
Method Details
-
moveToFirst
public void moveToFirst()Description copied from interface:LowLevelIteratorMove iterator to first FS in index. A subsequent call toisValid()will succeed iff the index is non-empty.- Specified by:
moveToFirstin interfaceLowLevelIterator
-
moveToLast
public void moveToLast()Description copied from interface:LowLevelIteratorMove iterator to last FS in index. A subsequent call toisValid()will succeed iff the index is non-empty.- Specified by:
moveToLastin interfaceLowLevelIterator
-
isValid
public boolean isValid()Description copied from interface:LowLevelIteratorCheck if the iterator is currently valid.- Specified by:
isValidin interfaceLowLevelIterator- Returns:
trueiff the iterator is valid.
-
ll_get
Description copied from interface:LowLevelIteratorReturn the current FS reference.- Specified by:
ll_getin interfaceLowLevelIterator- Returns:
- The current FS reference.
- Throws:
NoSuchElementException- Iff the iterator is not valid.
-
moveToNext
public void moveToNext()Description copied from interface:LowLevelIteratorAdvance the iterator. This may invalidate the iterator.- Specified by:
moveToNextin interfaceLowLevelIterator
-
moveToPrevious
public void moveToPrevious()Description copied from interface:LowLevelIteratorMove the iterator back one position. This may invalidate the iterator.- Specified by:
moveToPreviousin interfaceLowLevelIterator
-
moveTo
public void moveTo(int fsRef) Description copied from interface:LowLevelIteratorTry to position the iterator so that the current element is greater than or equal tofsRef, and previous elements are less thanfsRef. This may invalidate the iterator. If fsRef can not be compared to FSs in the index, the results are undefined.- Specified by:
moveToin interfaceLowLevelIterator- Parameters:
fsRef- The FS reference the iterator should be set to.
-
copy
Description copied from interface:LowLevelIteratorCreate a copy of this iterator. The copy will point at the same element that this iterator is currently pointing at.- Specified by:
copyin interfaceLowLevelIterator- Returns:
- A copy of this iterator.
-
ll_indexSize
public int ll_indexSize()Description copied from interface:LowLevelIteratorReturn the size of the underlying index.- Specified by:
ll_indexSizein interfaceLowLevelIterator- Returns:
- The size of the index.
-
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- Returns:
- The index.
-