boone.io

Class IOFilter

java.lang.Object

boone.io.IOFilter

Direct Known Subclasses:

BooneFilter, CSVPatternFilter, Proben1PatternFilter, SNNSNetFilter, SNNSPatternFilter

public abstract class IOFilter
extends java.lang.Object

This is the base filter for loading and saving networks and patterns. Data is written to or read from the given IO file. The specific filter determines the data format. Boone native files are loaded/stored using the BooneFilter. You may also write custom filters by extending this class.

Since:

14. Sept. 2004

Version:

$Id$

Author:

August Mayer, Helmut A. Mayer

Field Summary

Fields

Modifier and Type	Field and Description
protected boolean	compressed Indicates file compression.
protected java.io.File	file The IO file.
protected java.lang.Object	parser The file parser.
protected int	streamSize The number of patterns read in a single stream event.
protected java.io.Writer	writer The file writer.

Constructor Summary

Constructors

Constructor and Description
IOFilter() Constructs the plain filter without IO file.
IOFilter(java.io.File file) Constructs the filter with IO file.

Method Summary

Modifier and Type	Method and Description
protected java.io.InputStream	createInputStream() Creates an input stream for reading from data file.
protected java.io.OutputStream	createOutputStream() Creates an output stream for writing to data file.
java.io.File	getFile() Returns the IO file.
int	getStreamSize() Returns the number of patterns read in a single stream event.
boolean	isCompressed() Returns the file compression flag.
boolean	isStreaming() Indicates, if the filter is streaming data.
abstract Storable	load(Storable container) Loads data from a file to a data container.
protected java.util.List<java.lang.Double>	readValues(StreamParser parser, int count, char separator, java.util.List<java.lang.Double> values) Reads 'count' double values from a pattern file.
void	reset() Resets the filter to an initial state.
abstract void	save(Storable storable) Saves Boone data to a file.
void	setCompressed(boolean compressed) Sets the file compression flag.
void	setFile(java.io.File file) Sets the IO file.

Methods inherited from class java.lang.Object

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

Field Detail

file

protected java.io.File file

The IO file.

compressed

protected boolean compressed

Indicates file compression.

parser

protected java.lang.Object parser

The file parser.

writer

protected java.io.Writer writer

The file writer.

streamSize

protected int streamSize

The number of patterns read in a single stream event. If the size is 0 (default), then the filter is not streaming.

Constructor Detail

IOFilter

public IOFilter()

Constructs the plain filter without IO file.

IOFilter

public IOFilter(java.io.File file)

Constructs the filter with IO file.

Parameters:

file - the file to read or write data

Method Detail

reset

public void reset()

Resets the filter to an initial state.

getFile

public java.io.File getFile()

Returns the IO file.

Returns:

the IO file

setFile

public void setFile(java.io.File file)

Sets the IO file. Also, calls reset().

Parameters:

file - the IO file

isCompressed

public boolean isCompressed()

Returns the file compression flag.

Returns:

true, if compressed

setCompressed

public void setCompressed(boolean compressed)

Sets the file compression flag.

Parameters:

compressed - true, if compression

getStreamSize

public int getStreamSize()

Returns the number of patterns read in a single stream event.

Returns:

the stream size

isStreaming

public boolean isStreaming()

Indicates, if the filter is streaming data.

Returns:

true, if streaming supported

readValues

protected java.util.List<java.lang.Double> readValues(StreamParser parser,
                                                      int count,
                                                      char separator,
                                                      java.util.List<java.lang.Double> values)
                                               throws java.io.IOException

Reads 'count' double values from a pattern file.

Parameters:

parser - the parser

count - the number of values to read

separator - the character separating the values

values - a container for the values, if null it is created

Returns:

the container with values

Throws:

java.io.IOException - if the file format is incorrect

createInputStream

protected java.io.InputStream createInputStream()
                                         throws java.io.IOException

Creates an input stream for reading from data file.

Returns:

an input stream (may be compressed)

Throws:

java.io.IOException

createOutputStream

protected java.io.OutputStream createOutputStream()
                                           throws java.io.IOException

Creates an output stream for writing to data file.

Returns:

an output stream (may be compressed)

Throws:

java.io.IOException

load

public abstract Storable load(Storable container)
                       throws java.io.IOException

Loads data from a file to a data container.

Parameters:

container - the data container

Returns:

the data container (for convenience)

Throws:

java.io.IOException

save

public abstract void save(Storable storable)
                   throws java.io.IOException

Saves Boone data to a file.

Parameters:

storable - a Storable

Throws:

java.io.IOException - problems when writing