moa.streams

Class ArffFileStream

java.lang.Object

moa.AbstractMOAObject

moa.options.AbstractOptionHandler

moa.streams.ArffFileStream

All Implemented Interfaces:

Serializable, MOAObject, OptionHandler, InstanceStream

Direct Known Subclasses:

MultilabelArffFileStream

public class ArffFileStream
extends AbstractOptionHandler
implements InstanceStream

Stream reader of ARFF files.

Version:

$Revision: 7 $

Author:

Richard Kirkby (rkirkby@cs.waikato.ac.nz)

See Also:

Serialized Form

Field Summary

Fields

Modifier and Type	Field and Description
FileOption	arffFileOption
IntOption	classIndexOption
protected InputStreamProgressMonitor	fileProgressMonitor
protected Reader	fileReader
protected boolean	hitEndOfFile
protected weka.core.Instances	instances
protected weka.core.Instance	lastInstanceRead
protected int	numInstancesRead

Fields inherited from class moa.options.AbstractOptionHandler

classOptionNamesToPreparedObjects, options

Constructor Summary

Constructors

Constructor and Description
ArffFileStream()
ArffFileStream(String arffFileName, int classIndex)

Method Summary

Methods

Modifier and Type	Method and Description
long	estimatedRemainingInstances() Gets the estimated number of remaining instances in this stream
void	getDescription(StringBuilder sb, int indent) Returns a string representation of this object.
InstancesHeader	getHeader() Gets the header of this stream.
String	getPurposeString() Gets the purpose of this object
boolean	hasMoreInstances() Gets whether this stream has more instances to output.
boolean	isRestartable() Gets whether this stream can restart.
weka.core.Instance	nextInstance() Gets the next instance from this stream.
void	prepareForUseImpl(TaskMonitor monitor, ObjectRepository repository) This method describes the implementation of how to prepare this object for use.
protected boolean	readNextInstanceFromFile()
void	restart() Restarts this stream.

Methods inherited from class moa.options.AbstractOptionHandler

copy, discoverOptionsViaReflection, getCLICreationString, getOptions, getPreparedClassOption, getPreparedClassOption, prepareClassOptions, prepareForUse, prepareForUse

Methods inherited from class moa.AbstractMOAObject

copy, measureByteSize, measureByteSize, toString

Methods inherited from class java.lang.Object

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

Methods inherited from interface moa.MOAObject

copy, measureByteSize

Field Detail

arffFileOption

public FileOption arffFileOption

classIndexOption

public IntOption classIndexOption

instances

protected weka.core.Instances instances

fileReader

protected Reader fileReader

hitEndOfFile

protected boolean hitEndOfFile

lastInstanceRead

protected weka.core.Instance lastInstanceRead

numInstancesRead

protected int numInstancesRead

fileProgressMonitor

protected InputStreamProgressMonitor fileProgressMonitor

Constructor Detail

ArffFileStream

public ArffFileStream()

ArffFileStream

public ArffFileStream(String arffFileName,
              int classIndex)

Method Detail

getPurposeString

public String getPurposeString()

Description copied from interface: OptionHandler

Gets the purpose of this object

Specified by:

getPurposeString in interface OptionHandler

Overrides:

getPurposeString in class AbstractOptionHandler

Returns:

the string with the purpose of this object

prepareForUseImpl

public void prepareForUseImpl(TaskMonitor monitor,
                     ObjectRepository repository)

Description copied from class: AbstractOptionHandler

This method describes the implementation of how to prepare this object for use. All classes that extends this class have to implement prepareForUseImpl and not prepareForUse since prepareForUse calls prepareForUseImpl.

Specified by:

prepareForUseImpl in class AbstractOptionHandler

Parameters:

monitor - the TaskMonitor to use

repository - the ObjectRepository to use

getHeader

public InstancesHeader getHeader()

Description copied from interface: InstanceStream

Gets the header of this stream. This is useful to know attributes and classes. InstancesHeader is an extension of weka.Instances.

Specified by:

getHeader in interface InstanceStream

Returns:

the header of this stream

estimatedRemainingInstances

public long estimatedRemainingInstances()

Description copied from interface: InstanceStream

Gets the estimated number of remaining instances in this stream

Specified by:

estimatedRemainingInstances in interface InstanceStream

Returns:

the estimated number of instances to get from this stream

hasMoreInstances

public boolean hasMoreInstances()

Description copied from interface: InstanceStream

Gets whether this stream has more instances to output. This is useful when reading streams from files.

Specified by:

hasMoreInstances in interface InstanceStream

Returns:

true if this stream has more instances to output

nextInstance

public weka.core.Instance nextInstance()

Description copied from interface: InstanceStream

Gets the next instance from this stream.

Specified by:

nextInstance in interface InstanceStream

Returns:

the next instance of this stream

isRestartable

public boolean isRestartable()

Description copied from interface: InstanceStream

Gets whether this stream can restart.

Specified by:

isRestartable in interface InstanceStream

Returns:

true if this stream can restart

restart

public void restart()

Description copied from interface: InstanceStream

Restarts this stream. It must be similar to starting a new stream from scratch.

Specified by:

restart in interface InstanceStream

readNextInstanceFromFile

protected boolean readNextInstanceFromFile()

getDescription

public void getDescription(StringBuilder sb,
                  int indent)

Description copied from interface: MOAObject

Returns a string representation of this object. Used in AbstractMOAObject.toString to give a string representation of the object.

Specified by:

getDescription in interface MOAObject

Parameters:

sb - the stringbuilder to add the description

indent - the number of characters to indent