Package adams.db

Class SpectrumIterator

java.lang.Object

adams.db.SpectrumIterator

All Implemented Interfaces:

AutoCloseable, Iterator<Spectrum>

public class SpectrumIterator
extends Object
implements Iterator<Spectrum>, AutoCloseable

Iterator for Spectrum result sets.

Author:

fracpete (fracpete at waikato dot ac dot nz)

Field Summary

Fields

Modifier and Type	Field	Description
protected Connection	m_Connection	the connection to close.
protected Spectrum	m_Next	the next spectrum.
protected ResultSet	m_ResultSet	the underlying resultset.
protected SampleDataIntf	m_SampleData	the underlying sampledata DB handler.
protected int	m_Size	the number of rows in the resultset.
protected SpectrumIntf	m_Spectrum	the underlying spectrum DB handler.

Constructor Summary

Constructors

Constructor	Description
SpectrumIterator(SpectrumIntf spectrum, SampleDataIntf sampleData, ResultSet resultSet, Connection connection)	Initializes the iterator.

Method Summary

Modifier and Type	Method	Description
void	close()	Closes the results set and query.
int	getSize()	Returns the number of rows.
boolean	hasNext()	Returns true if the iteration has more elements.
Spectrum	next()	Returns the next element in the iteration.

Methods inherited from class java.lang.Object

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

Methods inherited from interface java.util.Iterator

forEachRemaining, remove

Field Detail

m_Spectrum

protected SpectrumIntf m_Spectrum

the underlying spectrum DB handler.

m_SampleData

protected SampleDataIntf m_SampleData

the underlying sampledata DB handler.

m_ResultSet

protected ResultSet m_ResultSet

the underlying resultset.

m_Next

protected Spectrum m_Next

the next spectrum.

m_Connection

protected Connection m_Connection

the connection to close.

m_Size

protected int m_Size

the number of rows in the resultset.

Constructor Detail

SpectrumIterator

public SpectrumIterator(SpectrumIntf spectrum,
                        SampleDataIntf sampleData,
                        ResultSet resultSet,
                        Connection connection)

Initializes the iterator.

Parameters:

spectrum - the spectrum handler

sampleData - the sampledata handler

resultSet - the result set to iterate

connection - the connection to close after finished reading, if any

Method Detail

getSize

public int getSize()

Returns the number of rows.

Returns:

the rows

hasNext

public boolean hasNext()

Returns true if the iteration has more elements. (In other words, returns true if next() would return an element rather than throwing an exception.)

Specified by:

hasNext in interface Iterator<Spectrum>

Returns:

true if the iteration has more elements

next

public Spectrum next()

Returns the next element in the iteration.

Specified by:

next in interface Iterator<Spectrum>

Returns:

the next element in the iteration

Throws:

NoSuchElementException - if the iteration has no more elements

close

public void close()
           throws Exception

Closes the results set and query.

Specified by:

close in interface AutoCloseable

Throws:

Exception - does not happen