keel.Algorithms.Neural_Networks.NNEP_Common.data

Interface IDataset

All Known Implementing Classes:

AbstractDataset, ArffDataSet, ArrayDataset, FileDataset, KeelDataSet

public interface IDataset

Dataset Interface

Since:

JDK1.5

Version:

0.1

Author:

Written by Amelia Zafra, Sebastian Ventura (University of Cordoba) 17/07/2007

Nested Class Summary

Nested Classes

Modifier and Type	Interface and Description
static interface	IDataset.IInstance Dataset instance

Method Summary

Modifier and Type	Method and Description
void	close() Close dataset
IMetadata	getMetadata() Access to this dataset specification
java.lang.String	getName() Get name of this dataset
boolean	move(int index) Move cursor to index position
boolean	next() Return the next instance
int	numberOfInstances() Get the number of Instances
void	open() Open dataset
IDataset.IInstance	read() Returns cursor instance
int	read(IDataset.IInstance[] buffer) Reads some number of instances from the dataset and stores them into a buffer array.
int	read(IDataset.IInstance[] buffer, int offset, int length) Reads up to length instances from the input stream into an array of IInstances.
IDataset.IInstance	read(int rowNumber) Reads instance at specified row number
void	reset() Reset dataset

Method Detail

getName

java.lang.String getName()

Get name of this dataset

Returns:

name of this dataset

getMetadata

IMetadata getMetadata()

Access to this dataset specification

Returns:

Dataset specification

numberOfInstances

int numberOfInstances()
               throws DatasetException

Get the number of Instances

Returns:

number of Instances

Throws:

DatasetException - if a source access error occurs

open

void open()
   throws DatasetException

Open dataset

Throws:

DatasetException - If dataset can't be opened

close

void close()
    throws DatasetException

Close dataset

Throws:

DatasetException - If dataset can't be closed

next

boolean next()
      throws DatasetException

Return the next instance

Returns:

The next instance

Throws:

DatasetException - if a source access error occurs

move

boolean move(int index)
      throws DatasetException

Move cursor to index position

Parameters:

index - New cursor position

Returns:

true|false

Throws:

DatasetException - if a source access error occurs

reset

void reset()
    throws DatasetException

Reset dataset

Throws:

DatasetException - if a source access error occurs

read

IDataset.IInstance read()
                 throws DatasetException

Returns cursor instance

Returns:

Actual instance (if exists)

Throws:

DatasetException - if a source access error occurs

read

IDataset.IInstance read(int rowNumber)
                 throws DatasetException

Reads instance at specified row number

Parameters:

rowNumber - the row number

Returns:

Instance at specified row

Throws:

DatasetException - if an error occurs

read

int read(IDataset.IInstance[] buffer)
  throws DatasetException

Reads some number of instances from the dataset and stores them into a buffer array. The number of instances actually read is returned as an integer

Parameters:

buffer - the buffer into which the data is read

Returns:

the total number of instances read into the buffer, or -1 is there is no more data because the end of the stream has been reached

Throws:

DatasetException - if an error occurs

read

int read(IDataset.IInstance[] buffer,
         int offset,
         int length)
  throws DatasetException

Reads up to length instances from the input stream into an array of IInstances. An attempt is made to read as many as length instances, but a smaller number may be read, possibly zero. The number of instances actually read is returned as an integer

Parameters:

buffer - the buffer into which the data is read

offset - the start offset in array buffer at which the data is written

length - the maximum number of MiningVectors to read

Returns:

the total number of instances read into the buffer, or -1 if there is no more data because the end of the stream has been

Throws:

DatasetException - if an error occurs