eu.etrap.medusa.utils

Class CooccWriter

java.lang.Object

eu.etrap.medusa.utils.CooccWriter

public class CooccWriter
extends java.lang.Object

Utility for writing files for cooccaccess.

Author:

christian

Field Summary

Fields

Modifier and Type	Field and Description
private java.lang.StringBuilder	buffer
static java.lang.String	BUFFER_SIZE_PROPERTY A system property to configure the buffer size of the CooccWriter.
private boolean	buffered
private int	bufferSize
static java.lang.String	DEFAULT_BUFFER_SIZE
private static java.lang.String	DELEM
private static byte[]	DELEM_B
private static java.lang.String	LINE_END
private static byte[]	LINE_END_B
private int	maxVectorSize
private java.io.OutputStream	out

Constructor Summary

Constructors

Constructor and Description
CooccWriter(java.io.OutputStream out) Directly use an OutputStream (preferably a BufferedOutputStream)
CooccWriter(java.io.OutputStream out, boolean buffered) Directly use an OutputStream (preferably a BufferedOutputStream)
CooccWriter(java.lang.String filename, boolean buffered) Creates a new CooccWriter and opens the file determined by the filename attribute for writing.
CooccWriter(java.lang.String filename, boolean append, boolean buffered) Creates a new CooccWriter and opens the file determined by the filename attribute for writing.

Method Summary

Modifier and Type	Method and Description
private void	checkBuffer(boolean forceWrite) Writes the buffer out if it's full.
void	close() Closes the file and write the buffer to disk, if the CooccWriter is used in buffered mode.
private static int	getBufferSize() Reads the system property.
int	getMaxVectorSize() The maximum size of the written vectors (may be used for padding)
static void	main(java.lang.String[] argv)
static void	paddVectors(java.lang.String filename, java.lang.String pad, int maxVectorSize) Pads a coocc file with a pattern, so that all vectors have equal size.
void	writeVector(int[] vec, int length) Appends an integer vector to the current file.
void	writeVector(java.lang.Integer[] vec) Appends an integer vector to the current file.
void	writeVector(java.lang.String[] vec) Appends a vector to the current file.

Methods inherited from class java.lang.Object

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

Field Detail

BUFFER_SIZE_PROPERTY

public static final java.lang.String BUFFER_SIZE_PROPERTY

A system property to configure the buffer size of the CooccWriter.

See Also:

Constant Field Values

DEFAULT_BUFFER_SIZE

public static final java.lang.String DEFAULT_BUFFER_SIZE

See Also:

Constant Field Values

DELEM

private static final java.lang.String DELEM

See Also:

Constant Field Values

DELEM_B

private static final byte[] DELEM_B

LINE_END

private static final java.lang.String LINE_END

See Also:

Constant Field Values

LINE_END_B

private static final byte[] LINE_END_B

out

private java.io.OutputStream out

buffered

private boolean buffered

buffer

private java.lang.StringBuilder buffer

bufferSize

private int bufferSize

maxVectorSize

private int maxVectorSize

Constructor Detail

CooccWriter

public CooccWriter(java.lang.String filename,
                   boolean append,
                   boolean buffered)
            throws java.io.FileNotFoundException

Creates a new CooccWriter and opens the file determined by the filename attribute for writing.

Parameters:

filename - The name of the output file

append - if true, then bytes will be written to the end of the file rather than the beginning

buffered - if true an internal buffer is used. You must properly use the close method to be sure that the buffer is written to disk.

Throws:

java.io.FileNotFoundException

CooccWriter

public CooccWriter(java.lang.String filename,
                   boolean buffered)
            throws java.io.FileNotFoundException

Creates a new CooccWriter and opens the file determined by the filename attribute for writing.

Parameters:

filename - The name of the file to write to.

buffered - if true an internal buffer is used. You must properly use the close method to be sure that the buffer is written to disk.

Throws:

java.io.FileNotFoundException

CooccWriter

public CooccWriter(java.io.OutputStream out)

Directly use an OutputStream (preferably a BufferedOutputStream)

Parameters:

out - The Stream to write to.

CooccWriter

public CooccWriter(java.io.OutputStream out,
                   boolean buffered)

Directly use an OutputStream (preferably a BufferedOutputStream)

Parameters:

out - out The Stream to write to.

buffered - buffered or not(true or false)

Method Detail

writeVector

public void writeVector(java.lang.String[] vec)
                 throws java.io.IOException

Appends a vector to the current file.

Parameters:

vec -

Throws:

java.io.IOException

writeVector

public void writeVector(java.lang.Integer[] vec)
                 throws java.io.IOException

Appends an integer vector to the current file.

Parameters:

vec -

Throws:

java.io.IOException

writeVector

public void writeVector(int[] vec,
                        int length)
                 throws java.io.IOException

Appends an integer vector to the current file.

Parameters:

vec -

Throws:

java.io.IOException

checkBuffer

private void checkBuffer(boolean forceWrite)
                  throws java.io.IOException

Writes the buffer out if it's full.

Parameters:

forceWrite -

Throws:

java.io.IOException

close

public void close()
           throws java.io.IOException

Closes the file and write the buffer to disk, if the CooccWriter is used in buffered mode.

Throws:

java.io.IOException

getBufferSize

private static int getBufferSize()

Reads the system property.

Returns:

The value of the BUFFER_SIZE system property or the default value.

See Also:

BUFFER_SIZE_PROPERTY, DEFAULT_BUFFER_SIZE

getMaxVectorSize

public int getMaxVectorSize()

The maximum size of the written vectors (may be used for padding)

Returns:

max size of vectors

paddVectors

public static void paddVectors(java.lang.String filename,
                               java.lang.String pad,
                               int maxVectorSize)
                        throws java.io.IOException,
                               java.io.FileNotFoundException

Pads a coocc file with a pattern, so that all vectors have equal size. In case of an IOException or any other strangeness, this method might destroy your input file. So better do a backup before!

Parameters:

filename - The filename of the file to pad.

pad - The String to pad with ("0" or "-1" for example)

maxVectorSize - The max vector size.

Throws:

java.io.IOException

java.io.FileNotFoundException

main

public static void main(java.lang.String[] argv)
                 throws java.lang.Exception

Throws:

java.lang.Exception