de.innovationgate.webgate.api

Class WGStructEntryRetrievalIterator

java.lang.Object

de.innovationgate.utils.PrefetchingIterator<WGStructEntry>

de.innovationgate.webgate.api.WGStructEntryRetrievalIterator

All Implemented Interfaces:

de.innovationgate.utils.SkippingIterator<WGStructEntry>, java.util.Iterator<WGStructEntry>

public class WGStructEntryRetrievalIterator
extends de.innovationgate.utils.PrefetchingIterator<WGStructEntry>
implements de.innovationgate.utils.SkippingIterator<WGStructEntry>

Class to iterate over struct entries returned by hierarchy retrieeval methods of WGAPI backend. Internal use only. The method close() should be called on this iterator after using it so it can release backend resources.

Constructor Summary

Constructors

Constructor and Description
WGStructEntryRetrievalIterator(WGDatabase db, WGDocument parent, java.util.Iterator<WGDocumentCore> structCores)

Method Summary

Methods

Modifier and Type	Method and Description
void	close()
static WGStructEntryRetrievalIterator	emptyIterator() Returns an empty version of this iterator type
WGDatabase	getDatabase() Returns the database of the struct entries returned
int	skip(int nrOfElements) Will skip the given number of elements in the queue.

Methods inherited from class de.innovationgate.utils.PrefetchingIterator

hasNext, next, previewNextValue, remove

Methods inherited from class java.lang.Object

equals, getClass, hashCode, notify, notifyAll, toString, wait, wait, wait

Methods inherited from interface java.util.Iterator

hasNext, next, remove

Constructor Detail

WGStructEntryRetrievalIterator

public WGStructEntryRetrievalIterator(WGDatabase db,
                              WGDocument parent,
                              java.util.Iterator<WGDocumentCore> structCores)

Method Detail

emptyIterator

public static WGStructEntryRetrievalIterator emptyIterator()

Returns an empty version of this iterator type

skip

public int skip(int nrOfElements)

Description copied from interface: de.innovationgate.utils.SkippingIterator

Will skip the given number of elements in the queue. The next call of the Iterator.next() method will return the element immediately after the last skipped one. Must be called before any iterating methods (Iterator.next() Iterator.hasNext()) have been used. Otherwise an IllegalStateException is thrown.

Specified by:

skip in interface de.innovationgate.utils.SkippingIterator<WGStructEntry>

Parameters:

nrOfElements - Number of elements to skip

Returns:

The number of skipping iterations that could not be performed because the iterator reached the end. Should be 0 when the iterator was able to complete all operations without reaching the end.

getDatabase

public WGDatabase getDatabase()

Returns the database of the struct entries returned

close

public void close()