de.innovationgate.webgate.api

Class WGStructEntryIterator

java.lang.Object

de.innovationgate.utils.PrefetchingIterator<WGStructEntry>

de.innovationgate.webgate.api.WGStructEntryIterator

All Implemented Interfaces:

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

public class WGStructEntryIterator
extends de.innovationgate.utils.PrefetchingIterator<WGStructEntry>
implements de.innovationgate.utils.SkippingIterator<WGStructEntry>, de.innovationgate.utils.CountReportingIterator<WGStructEntry>

Iterator to iterate over struct entries. This iterator fetches struct entries page-wise, allowing performant usage with very many struct entries

Method Summary

Methods

Modifier and Type	Method and Description
int	getCount() Returns the count of all entries in this iterator, only if the database supports effective count retrieval without loading all resources.
int	getCurrentOffset() Returns the offset of the last retrieved element inside the iterated collection
WGDocument	getParent() Returns the parent document of the iterated struct entries, either a WGArea or a WGStructEntry
int	skip(int nrOfElements)

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

Method Detail

skip

public int skip(int nrOfElements)

Specified by:

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

getParent

public WGDocument getParent()

Returns the parent document of the iterated struct entries, either a WGArea or a WGStructEntry

getCount

public int getCount()

Returns the count of all entries in this iterator, only if the database supports effective count retrieval without loading all resources. Otherwise returns -1.

Specified by:

getCount in interface de.innovationgate.utils.CountReportingIterator<WGStructEntry>

Throws:

WGAPIException

getCurrentOffset

public int getCurrentOffset()

Returns the offset of the last retrieved element inside the iterated collection

Specified by:

getCurrentOffset in interface de.innovationgate.utils.CountReportingIterator<WGStructEntry>