eu.europeana.cloud.mcs.driver

Class RepresentationIterator

java.lang.Object

eu.europeana.cloud.mcs.driver.RepresentationIterator

All Implemented Interfaces:

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

public class RepresentationIterator
extends Object
implements Iterator<eu.europeana.cloud.common.model.Representation>

Class for iterating through Representations of given data set. The best way to initialise iterator is to obtain it by calling DataSetServiceClient#getRepresentationIteratorForProvider(String providerId, String dataSetId) method. Iterator obtains Representation objects in chunks, obtaining new chunk only if needed, inside overridden Iterator class methods.

Constructor Summary

Constructors

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

Method Summary

Methods

Modifier and Type	Method and Description
boolean	hasNext() Returns true if the iteration has more elements.
eu.europeana.cloud.common.model.Representation	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

RepresentationIterator

public RepresentationIterator(DataSetServiceClient client,
                      String providerId,
                      String dataSetId)

Creates instance of RepresentationIterator.

Parameters:

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

providerId - id of the provider (required)

dataSetId - data set identifier (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. If data set does not exists, first call to this method will throw DriverException with inner exception: DataSetNotExistsException.

Specified by:

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

Returns:

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

next

public eu.europeana.cloud.common.model.Representation 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. If data set does not exists, first call to this method will throw DriverException with inner exception: DataSetNotExistsException.

Specified by:

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

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.Representation>