de.innovationgate.webgate.api

Class WGContentIterator

java.lang.Object

de.innovationgate.webgate.api.WGContentIterator

All Implemented Interfaces:

java.util.Iterator<WGContent>

public class WGContentIterator
extends java.lang.Object
implements java.util.Iterator<WGContent>

This class allows iterating over all contents stored in a content database. It serves all WGContent objects in the following order:

• It serves the areas in the order they are offered by db.getAreas().values().
• Inside the area it hierarchically goes through all the structentries and their content.
• Child struct entries are processed before the following siblings.

Constructor Summary

Constructors

Constructor and Description
WGContentIterator(WGDatabase db, boolean includeArchived) Constructs an iterator for the given database

Method Summary

Methods

Modifier and Type	Method and Description
java.util.List<WGContentKey>	getContentKeys() Returns all content keys of the contents offered by this iterator.
boolean	hasNext()
WGContent	next()
void	remove()

Methods inherited from class java.lang.Object

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

Constructor Detail

WGContentIterator

public WGContentIterator(WGDatabase db,
                 boolean includeArchived)
                  throws WGAPIException

Constructs an iterator for the given database

Parameters:

db - The database

includeArchived - Choose true if you want archived documents included in the iteration, false otherwise

Throws:

WGAPIException

Method Detail

hasNext

public boolean hasNext()

Specified by:

hasNext in interface java.util.Iterator<WGContent>

next

public WGContent next()

Specified by:

next in interface java.util.Iterator<WGContent>

remove

public void remove()

Specified by:

remove in interface java.util.Iterator<WGContent>

getContentKeys

public java.util.List<WGContentKey> getContentKeys()

Returns all content keys of the contents offered by this iterator.