boone.io

Class BooneFilter

java.lang.Object

boone.io.IOFilter

boone.io.BooneFilter

public class BooneFilter
extends IOFilter

An I/O filter for the native Boone file format with optional GZip compression. The type name describing the type of data is a bit redundant, but it is also used for a basic check, if a file contains indeed Boone data.

Since:

14. Sept. 2004

Version:

$Id$

Author:

August Mayer, Helmut A. Mayer

Field Summary

Fields inherited from class boone.io.IOFilter

compressed, file, parser, streamSize, writer

Constructor Summary

Constructors

Constructor and Description
BooneFilter() Constructs the plain filter.
BooneFilter(java.io.File file, java.lang.String typeName) Constructs the filter.
BooneFilter(java.lang.String typeName, boolean compressed) Constructs the filter with type and compression flag.

Method Summary

Modifier and Type	Method and Description
Storable	load(Storable storable) Loads data from a file to a data container.
void	reset() Resets the filter to an initial state.
void	save(Storable storable) Saves Boone data to an XML file.

Methods inherited from class boone.io.IOFilter

createInputStream, createOutputStream, getFile, getStreamSize, isCompressed, isStreaming, readValues, setCompressed, setFile

Methods inherited from class java.lang.Object

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

Constructor Detail

BooneFilter

public BooneFilter()

Constructs the plain filter.

BooneFilter

public BooneFilter(java.io.File file,
                   java.lang.String typeName)

Constructs the filter.

Parameters:

file - the IO file

typeName - the type of data

BooneFilter

public BooneFilter(java.lang.String typeName,
                   boolean compressed)

Constructs the filter with type and compression flag.

Parameters:

typeName - the type of data

compressed - true, if compressed

Method Detail

reset

public void reset()

Resets the filter to an initial state. Does nothing.

Overrides:

reset in class IOFilter

save

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

Saves Boone data to an XML file.

Specified by:

save in class IOFilter

Parameters:

storable - a Storable

Throws:

java.io.IOException - if problems during writing

load

public Storable load(Storable storable)
              throws java.io.IOException

Loads data from a file to a data container.

Specified by:

load in class IOFilter

Parameters:

storable - the data container

Returns:

the data container (for convenience)

Throws:

java.io.IOException