at.tuwien.ifs.somtoolbox.data

Class SOMLibZeroVectorRemover

java.lang.Object

at.tuwien.ifs.somtoolbox.data.SOMLibZeroVectorRemover

All Implemented Interfaces:

SOMToolboxApp

public class SOMLibZeroVectorRemover
extends java.lang.Object
implements SOMToolboxApp

Handles the removal of zero vectors in vector files in SOMLib format. This class can be run in standalone mode taking two arguments, i.e. input and output file. If the input file is gzip-compressed, the output will also be written gzip-compressed. The .gz suffix has to be specified manually in order not to alter filenames to something other than intended by the user.

Created on Mar 16, 2004

Version:

$Id: SOMLibZeroVectorRemover.java 3682 2010-07-15 09:12:22Z frank $

Author:

Michael Dittenbach

Nested Class Summary

Nested classes/interfaces inherited from interface at.tuwien.ifs.somtoolbox.apps.SOMToolboxApp

SOMToolboxApp.Type

Field Summary

Fields

Modifier and Type	Field and Description
static SOMToolboxApp.Type	APPLICATION_TYPE
static java.lang.String	DESCRIPTION
private static java.lang.String	ERROR_FILE_FORMAT_CORRUPT
static java.lang.String	LONG_DESCRIPTION
static com.martiansoftware.jsap.Parameter[]	OPTIONS

Fields inherited from interface at.tuwien.ifs.somtoolbox.apps.SOMToolboxApp

DEV_BY_STRING, HOMEPAGE, INFO, INFO_TEXT, LICENSE_TEXT, REQUIRED_MEMBERS, TYPE_GROUPED_COMPARATOR

Constructor Summary

Constructors

Constructor and Description
SOMLibZeroVectorRemover()

Method Summary

Modifier and Type	Method and Description
static void	main(java.lang.String[] args) Static method for standalone invocation.
static void	removeZeroVectors(java.io.BufferedReader inReader, java.io.BufferedWriter outWriter) Static method taking a Buffered Reader and BufferedWriter as argument.
static void	removeZeroVectors(java.lang.String inFileName, java.lang.String outFileName) Static method taking input and output filename as argument.

Methods inherited from class java.lang.Object

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

Field Detail

OPTIONS

public static final com.martiansoftware.jsap.Parameter[] OPTIONS

ERROR_FILE_FORMAT_CORRUPT

private static final java.lang.String ERROR_FILE_FORMAT_CORRUPT

See Also:

Constant Field Values

DESCRIPTION

public static final java.lang.String DESCRIPTION

See Also:

Constant Field Values

LONG_DESCRIPTION

public static final java.lang.String LONG_DESCRIPTION

See Also:

Constant Field Values

APPLICATION_TYPE

public static final SOMToolboxApp.Type APPLICATION_TYPE

Constructor Detail

SOMLibZeroVectorRemover

public SOMLibZeroVectorRemover()

Method Detail

main

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

Static method for standalone invocation.

Parameters:

args - Usage: input-filename output-filename

removeZeroVectors

public static void removeZeroVectors(java.lang.String inFileName,
                                     java.lang.String outFileName)
                              throws java.io.FileNotFoundException,
                                     java.io.IOException

Static method taking input and output filename as argument. File handling is done in this method and throws a FileNotFoundException if the input file can not be found and an IOException if some other file handling error occurs. If the input file is gzip-compressed, the output will also be written gzip-compressed. The .gz suffix has to be specified manually in order not to alter filenames to something other than intended by the user.

Parameters:

inFileName - Name of input file.

outFileName - Name of output file.

Throws:

java.io.FileNotFoundException

java.io.IOException

removeZeroVectors

public static void removeZeroVectors(java.io.BufferedReader inReader,
                                     java.io.BufferedWriter outWriter)

Static method taking a Buffered Reader and BufferedWriter as argument. The method exits the program if the file format is corrupt. TODO: This should be weakened in future by throwing a SOMLibVectorFileFormatException.

Parameters:

inReader - BufferedReader reading the file continaing unnormalized vectors.

outWriter - BuffererWriter writing the normalized vector file.