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.boolean
isValid()
Check if the iterator is currently valid.int
ll_get()
Return the current FS reference.Get the index for just the top most type of this iterator (excludes subtypes).int
Return the size of the underlying index.void
moveTo
(int fsRef) Try to position the iterator so that the current element is greater than or equal tofsRef
, and previous elements are less thanfsRef
.void
Move iterator to first FS in index.void
Move iterator to last FS in index.void
Advance the iterator.void
Move the iterator back one position.
-
Constructor Details
-
LLUnambiguousIteratorImpl
-
-
Method Details
-
moveToFirst
public void moveToFirst()Description copied from interface:LowLevelIterator
Move iterator to first FS in index. A subsequent call toisValid()
will succeed iff the index is non-empty.- Specified by:
moveToFirst
in interfaceLowLevelIterator
-
moveToLast
public void moveToLast()Description copied from interface:LowLevelIterator
Move iterator to last FS in index. A subsequent call toisValid()
will succeed iff the index is non-empty.- Specified by:
moveToLast
in interfaceLowLevelIterator
-
isValid
public boolean isValid()Description copied from interface:LowLevelIterator
Check if the iterator is currently valid.- Specified by:
isValid
in interfaceLowLevelIterator
- Returns:
true
iff the iterator is valid.
-
ll_get
Description copied from interface:LowLevelIterator
Return the current FS reference.- Specified by:
ll_get
in interfaceLowLevelIterator
- Returns:
- The current FS reference.
- Throws:
NoSuchElementException
- Iff the iterator is not valid.
-
moveToNext
public void moveToNext()Description copied from interface:LowLevelIterator
Advance the iterator. This may invalidate the iterator.- Specified by:
moveToNext
in interfaceLowLevelIterator
-
moveToPrevious
public void moveToPrevious()Description copied from interface:LowLevelIterator
Move the iterator back one position. This may invalidate the iterator.- Specified by:
moveToPrevious
in interfaceLowLevelIterator
-
moveTo
public void moveTo(int fsRef) Description copied from interface:LowLevelIterator
Try 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:
moveTo
in interfaceLowLevelIterator
- Parameters:
fsRef
- The FS reference the iterator should be set to.
-
copy
Description copied from interface:LowLevelIterator
Create a copy of this iterator. The copy will point at the same element that this iterator is currently pointing at.- Specified by:
copy
in interfaceLowLevelIterator
- Returns:
- A copy of this iterator.
-
ll_indexSize
public int ll_indexSize()Description copied from interface:LowLevelIterator
Return the size of the underlying index.- Specified by:
ll_indexSize
in interfaceLowLevelIterator
- Returns:
- The size of the index.
-
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
- Returns:
- The index.
-