eu.europeana.cloud.mcs.driver

Class DataSetIterator

java.lang.Object

eu.europeana.cloud.mcs.driver.DataSetIterator

All Implemented Interfaces:

Iterator<eu.europeana.cloud.common.model.DataSet>

public class DataSetIterator
extends Object
implements Iterator<eu.europeana.cloud.common.model.DataSet>

Class for iterating through DataSets of given provider. The best way to initialise iterator is to obtain it by calling DataSetServiceClient.getDataSetIteratorForProvider(String) method. Iterator obtains DataSet objects in chunks, obtaining new chunk only if needed, inside overridden Iterator class methods.

Constructor Summary

Constructors

Constructor and Description
DataSetIterator(DataSetServiceClient client, String providerId) Creates instance of DataSetIterator.

Method Summary

Methods

Modifier and Type	Method and Description
boolean	hasNext() Returns true if the iteration has more elements.
eu.europeana.cloud.common.model.DataSet	next() Returns next element in the iteration.
void	remove()

Methods inherited from class java.lang.Object

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

Constructor Detail

DataSetIterator

public DataSetIterator(DataSetServiceClient client,
               String providerId)

Creates instance of DataSetIterator.

Parameters:

client - properly initialised client for internal communication with MCS server (required)

providerId - id of the provider (required)

Method Detail

hasNext

public boolean hasNext()

Returns true if the iteration has more elements. The first call to this method might take longer time than the others, as there might be a need to obtain first chunk of data.

Specified by:

hasNext in interface Iterator<eu.europeana.cloud.common.model.DataSet>

Returns:

true if the iteration has more elements, false if not.

next

public eu.europeana.cloud.common.model.DataSet next()

Returns next element in the iteration. Some calls to this method might take longer time than the others, if the new chunk of data has to be obtained.

Specified by:

next in interface Iterator<eu.europeana.cloud.common.model.DataSet>

Returns:

next element in the iteration

Throws:

NoSuchElementException - if there are no more elements

remove

public void remove()

Specified by:

remove in interface Iterator<eu.europeana.cloud.common.model.DataSet>