Package org.moeaframework.analysis.io

Class SampleReader

java.lang.Object

org.moeaframework.analysis.io.SampleReader

All Implemented Interfaces:

Closeable, AutoCloseable, Iterable<TypedProperties>, Iterator<TypedProperties>

public class SampleReader
extends Object
implements Iterable<TypedProperties>, Iterator<TypedProperties>, Closeable

Reads the parameter samples from the output of SampleGenerator. The column ordering in the sample file matches the ordering of parameters in a ParameterFile. The read TypedProperties map the parameter name to the parameter value.

See Also:

• SampleGenerator
• ParameterFile

Constructor Summary

Constructors

Constructor	Description
SampleReader(File file, ParameterFile parameterFile)	Constructs a sample reader for reading parameter samples from the specified file.
SampleReader(Reader reader, ParameterFile parameterFile)	Constructs a sample reader for reading parameter samples from the underlying reader.

Method Summary

Modifier and Type	Method	Description
void	close()
boolean	hasNext()
Iterator<TypedProperties>	iterator()
TypedProperties	next()
void	remove()

Methods inherited from class java.lang.Object

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

Methods inherited from interface java.lang.Iterable

forEach, spliterator

Methods inherited from interface java.util.Iterator

forEachRemaining

Constructor Details

SampleReader

public SampleReader(File file,
 ParameterFile parameterFile)
             throws IOException

Constructs a sample reader for reading parameter samples from the specified file.

Parameters:

file - the parameter sample file

parameterFile - the parameter definition file

Throws:

IOException - if an I/O error occurred

SampleReader

public SampleReader(Reader reader,
 ParameterFile parameterFile)

Constructs a sample reader for reading parameter samples from the underlying reader.

Parameters:

reader - the underlying reader

parameterFile - the parameter definition file

Method Details

iterator

public Iterator<TypedProperties> iterator()

Specified by:

iterator in interface Iterable<TypedProperties>

hasNext

public boolean hasNext()

Specified by:

hasNext in interface Iterator<TypedProperties>

next

public TypedProperties next()

Specified by:

next in interface Iterator<TypedProperties>

remove

public void remove()

Specified by:

remove in interface Iterator<TypedProperties>

close

public void close()
           throws IOException

Specified by:

close in interface AutoCloseable

Specified by:

close in interface Closeable

Throws:

IOException