weka.core.converters
Class SerializedInstancesLoader

java.lang.Object
  weka.core.converters.AbstractLoader
      weka.core.converters.SerializedInstancesLoader

All Implemented Interfaces:

BatchLoader, IncrementalLoader, Loader, java.io.Serializable

public class SerializedInstancesLoader

extends AbstractLoader

implements BatchLoader, IncrementalLoader

Reads a source that contains serialized Instances.

Version:

$Revision: 1.6 $

Author:

Len Trigg

See Also:

Loader, Serialized Form

Field Summary

protected Instances	m_Dataset Holds the structure (header) of the data set.
protected int	m_IncrementalIndex The current index position for incremental reading

Fields inherited from class weka.core.converters.AbstractLoader

BATCH, INCREMENTAL, m_retrieval, NONE

Constructor Summary

SerializedInstancesLoader()

Method Summary

Instances	getDataSet() Return the full data set.
Instance	getNextInstance() Read the data set incrementally---get the next instance in the data set or returns null if there are no more instances to get.
Instances	getStructure() Determines and returns (if possible) the structure (internally the header) of the data set as an empty set of instances.
static void	main(java.lang.String[] args) Main method.
void	reset() Resets the Loader ready to read a new data set
void	setSource(java.io.File file) Resets the Loader object and sets the source of the data set to be the supplied File object.
void	setSource(java.io.InputStream in) Resets the Loader object and sets the source of the data set to be the supplied InputStream.

Methods inherited from class weka.core.converters.AbstractLoader

getRetrieval, setRetrieval

Methods inherited from class java.lang.Object

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

Field Detail

m_Dataset

protected Instances m_Dataset

Holds the structure (header) of the data set.

m_IncrementalIndex

protected int m_IncrementalIndex

The current index position for incremental reading

Constructor Detail

SerializedInstancesLoader

public SerializedInstancesLoader()

Method Detail

reset

public void reset()

Resets the Loader ready to read a new data set

setSource

public void setSource(java.io.File file)
               throws java.io.IOException

Resets the Loader object and sets the source of the data set to be the supplied File object.

Specified by:

setSource in interface Loader

Overrides:

setSource in class AbstractLoader

Parameters:

file - the source file.

Throws:

java.io.IOException - if an error occurs

setSource

public void setSource(java.io.InputStream in)
               throws java.io.IOException

Resets the Loader object and sets the source of the data set to be the supplied InputStream.

Specified by:

setSource in interface Loader

Overrides:

setSource in class AbstractLoader

Parameters:

in - the source InputStream.

Throws:

java.io.IOException - if there is a problem with IO

getStructure

public Instances getStructure()
                       throws java.io.IOException

Determines and returns (if possible) the structure (internally the header) of the data set as an empty set of instances.

Specified by:

getStructure in interface Loader

Specified by:

getStructure in class AbstractLoader

Returns:

the structure of the data set as an empty set of Instances

Throws:

java.io.IOException - if an error occurs

getDataSet

public Instances getDataSet()
                     throws java.io.IOException

Return the full data set. If the structure hasn't yet been determined by a call to getStructure then method should do so before processing the rest of the data set.

Specified by:

getDataSet in interface Loader

Specified by:

getDataSet in class AbstractLoader

Returns:

the structure of the data set as an empty set of Instances

Throws:

java.io.IOException - if there is no source or parsing fails

getNextInstance

public Instance getNextInstance()
                         throws java.io.IOException

Read the data set incrementally---get the next instance in the data set or returns null if there are no more instances to get. If the structure hasn't yet been determined by a call to getStructure then method should do so before returning the next instance in the data set.

Specified by:

getNextInstance in interface Loader

Specified by:

getNextInstance in class AbstractLoader

Returns:

the next instance in the data set as an Instance object or null if there are no more instances to be read

Throws:

java.io.IOException - if there is an error during parsing

main

public static void main(java.lang.String[] args)

Main method.

Parameters:

args - should contain the name of an input file.