de.innovationgate.webgate.api

Class WGHierarchyContentIterator

java.lang.Object

de.innovationgate.utils.PrefetchingIterator<WGContent>

de.innovationgate.webgate.api.WGHierarchyContentIterator

All Implemented Interfaces:

CountReportingIterator<WGContent>, SkippingIterator<WGContent>, java.util.Iterator<WGContent>

public class WGHierarchyContentIterator
extends PrefetchingIterator<WGContent>
implements SkippingIterator<WGContent>, CountReportingIterator<WGContent>

An iterator over all released contents of one language at a certain hierarchy position.

Constructor Summary

Constructors

Constructor and Description
WGHierarchyContentIterator(WGStructEntryIterator structs, java.lang.String language)

Method Summary

Methods

Modifier and Type	Method and Description
int	getCount() Returns the count of pages over which this iterator iterates and retrieves contents for.
int	getCurrentOffset() Returns the offset of the last retrieved element inside the iterated collection This also includes pages that were skipped because they have no released content in the current language
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

WGHierarchyContentIterator

public WGHierarchyContentIterator(WGStructEntryIterator structs,
                          java.lang.String language)

Method Detail

getCount

public int getCount()

Returns the count of pages over which this iterator iterates and retrieves contents for. The actual count of returned contents may be lower as some contents may not be readable or may not exist as released version in the given language

Specified by:

getCount in interface CountReportingIterator<WGContent>

skip

public int skip(int nrOfElements)

Description copied from interface: 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 SkippingIterator<WGContent>

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.

getCurrentOffset

public int getCurrentOffset()

Returns the offset of the last retrieved element inside the iterated collection This also includes pages that were skipped because they have no released content in the current language

Specified by:

getCurrentOffset in interface CountReportingIterator<WGContent>