com.j_spaces.kernel.list

Interface IScanListIterator<T>

All Superinterfaces:

IObjectsList

All Known Subinterfaces:

IEntryCacheInfo, IExtendedIndexIterator<V>, IFifoGroupIterator<T>

All Known Implementing Classes:

BlobStorePreFetchIteratorBasedHandler, BlobStoreRefEntryCacheInfo, EvictableEntryCacheInfo, ExtendedCompoundIndexFifoGroupsIterator, ExtendedIndexFifoGroupsIterator, ExtendedIndexIterator, FifoGroupsMultiList, FifoGroupsScanAllValuesByCompoundIndexIterator, FifoGroupsScanAllValuesIterator, FifoGroupsScanByFGIndexIterator, FifoGroupsScanByGeneralIndexIterator, MemoryBasedEntryCacheInfo, MultiIntersectedStoredList, MultiStoredList, QueryExtensionIndexEntryIteratorWrapper, RecentExtendedIndexUpdates.RecentExtendedUpdatesIter, ScanListSAIterator, ScanSingleListIterator, ScanUidsIterator

public interface IScanListIterator<T>
extends IObjectsList

IScanListIterator defines the interface for the result of stored-lists/extended indexes matching

Method Summary

Modifier and Type	Method and Description
default IScanListIterator	createCopyForAlternatingThread() create a shallow copy ready for alternating thread usage
int	getAlreadyMatchedFixedPropertyIndexPos() if the scan is on a property index, currently supported for extended index
default String	getAlreadyMatchedIndexPath()
boolean	hasNext()
default boolean	hasSize()
boolean	isAlreadyMatched() is the entry returned already matched against the searching template currently is true if the underlying scan made by CacheManager::EntriesIter
default boolean	isExtensionIndex()
default boolean	isMultiListsIterator() does this iter contain multiple lists
T	next()
void	releaseScan() release SLHolder for this scan
default int	size()

Methods inherited from interface com.j_spaces.kernel.list.IObjectsList

isIterator

Method Detail

hasNext

boolean hasNext()
         throws SAException

Throws:

SAException

next

T next()
throws SAException

Throws:

SAException

releaseScan

void releaseScan()
          throws SAException

release SLHolder for this scan

Throws:

SAException

getAlreadyMatchedFixedPropertyIndexPos

int getAlreadyMatchedFixedPropertyIndexPos()

if the scan is on a property index, currently supported for extended index

getAlreadyMatchedIndexPath

default String getAlreadyMatchedIndexPath()

isAlreadyMatched

boolean isAlreadyMatched()

is the entry returned already matched against the searching template currently is true if the underlying scan made by CacheManager::EntriesIter

isExtensionIndex

default boolean isExtensionIndex()

Returns:

true if this iterator is QueryExtensionIndexEntryIteratorWrapper

isMultiListsIterator

default boolean isMultiListsIterator()

does this iter contain multiple lists

createCopyForAlternatingThread

default IScanListIterator createCopyForAlternatingThread()

create a shallow copy ready for alternating thread usage

Returns:

a new shallow copyed IScanListIterator ready for alternating thread usage NOTE!! should be called before first hasNext() call

hasSize

default boolean hasSize()

Returns:

true if the iterator knows its size, and size() can be called.

size

default int size()