boone.io

Class CSVPatternFilter

java.lang.Object

boone.io.IOFilter

boone.io.CSVPatternFilter

public class CSVPatternFilter
extends IOFilter

The CSV pattern filter assumes that a complete pattern (input and target) is written in a single line (a record), where the values are separated by a specific character (default is the comma ','). First there are 'inputCount' input values and then 'targetCount' target values. If there are less values in a line, only these are read. If there are more values in a line only the requested number is read. There may be an optional header, which is a single line at the beginning of the file, where the pattern features may be given a name. If there, the header is ignored. Optional comment lines must start with a '#' character (these lines are also ignored). Blank lines are ignored, too. An expression starting with a non-numerical value is ignored and a default value of 0 is read instead of the expression. From that it follows that an expression under quotation marks is ignored, also (even if there is a numerical value inside the quotation).

Since:

September 27, 2011

Version:

0.1

Author:

Helmut A. Mayer

Field Summary

Fields inherited from class boone.io.IOFilter

compressed, file, parser, streamSize, writer

Constructor Summary

Constructors

Constructor and Description
CSVPatternFilter(char separator, int inputCount, int targetCount, boolean header, int streamSize) Constructs the CSV pattern filter.
CSVPatternFilter(int inputCount, int targetCount) Constructs the CSV pattern filter with a comma separator and no header.

Method Summary

Modifier and Type	Method and Description
Storable	load(Storable storable) Loads data from a CSV pattern file.
protected java.util.List<java.lang.Double>	readValues(StreamParser parser, int count, char separator, java.util.List<java.lang.Double> values) Reads maximally 'count' double values from a pattern file.
void	reset() Resets the filter to an initial state.
void	save(Storable storable) Saves a pattern set to a CSV file.

Methods inherited from class boone.io.IOFilter

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

Methods inherited from class java.lang.Object

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

Constructor Detail

CSVPatternFilter

public CSVPatternFilter(int inputCount,
                        int targetCount)

Constructs the CSV pattern filter with a comma separator and no header.

Parameters:

inputCount - the number of input values

targetCount - the number of target values

CSVPatternFilter

public CSVPatternFilter(char separator,
                        int inputCount,
                        int targetCount,
                        boolean header,
                        int streamSize)

Constructs the CSV pattern filter.

Parameters:

separator - the separating character

inputCount - the number of input values

targetCount - the number of target values

header - true, if header record exists

streamSize - the number of patterns to be streamed in a stream load

Method Detail

reset

public void reset()

Resets the filter to an initial state.

Overrides:

reset in class IOFilter

load

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

Loads data from a CSV pattern file. Note that if there are less values than requested, the pattern set simply has less values, i.e., you have to check the pattern dimensions. If there are more values in a line than requested, the excess values are not read. If the filter is streaming then only stream size patterns are read (the number might be also smaller).

Specified by:

load in class IOFilter

Parameters:

storable - the data container

Returns:

the data container (for convenience)

Throws:

java.io.IOException

save

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

Saves a pattern set to a CSV file. This works also in streaming mode.

Specified by:

save in class IOFilter

Parameters:

storable - the data source to be stored

Throws:

java.io.IOException - problems when writing

readValues

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

Reads maximally 'count' double values from a pattern file. If a value is missing or it is not a number (e.g., a string) 0 is used instead. Note that everything between quotation marks (like "this") is ignored (even if it is a number) and again, 0 is used as value for the quotation sequence. If there are fewer than 'count' values in the line, then these values are returned.

Overrides:

readValues in class IOFilter

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