org.corpus_tools.peppermodules.conll.tupleconnector

Interface TupleWriter

All Known Implementing Classes:

TupleWriterImpl

public interface TupleWriter

This interface provides methods to store tuples in a stream, for example a file stream. Although it provides a transactional treatment for writing tuples.

Author:

Florian Zipser

Method Summary

Methods

Modifier and Type	Method and Description
void	abortTA(Long TAId) Aborts the transaction with the given id.
void	addTuple(Collection<String> tuple) Adds a tuple to the stream without TA-Control.
void	addTuple(Long TAId, Collection<String> tuple) Adds a tuple to the stream without TA-Control.
long	beginTA() Starts a transaction and returns a unique id for it.
void	commitTA(Long TAId) Commits the transaction with the given id.
Collection<String>	getAttNames() Returns the names of attributes to which data belong.
String	getEncoding() Returns the encoding in which data shall be stored.
Hashtable<Character,String>	getEscapeTable() This method returns the current escape table for this TupleWriter
File	getFile() Returns the output file.
String	getSeperator() Returns the seperator with which the data will be departed on stream.
Boolean	isDistinct() Returns true if this tuple writer stores values more than one times, if they are equal
void	setAttNames(Collection<String> attNames) Sets the names of attributes to which data belong.
void	setDistinct(Boolean distinct) Set the distinct value for this tuple writer.
void	setEncoding(String encoding) Sets the encoding in which data shall be stored.
void	setEscapeTable(Hashtable<Character,String> escapeTable) This method sets the table of escape sequences
void	setEscaping(boolean escape) Sets an internal flag which specifies whether special chars should be escaped
void	setFile(File out) Sets the output file to the given.
void	setSeperator(String seperator) Sets the seperator with which the data will be departed on stream.

Method Detail

setEncoding

void setEncoding(String encoding)

Sets the encoding in which data shall be stored. Default is utf-8.

Parameters:

encoding - in which data shall be stored

setEscaping

void setEscaping(boolean escape)

Sets an internal flag which specifies whether special chars should be escaped

Parameters:

escape - true, if special chars should be escaped and false, if not.

setEscapeTable

void setEscapeTable(Hashtable<Character,String> escapeTable)

This method sets the table of escape sequences

Parameters:

escapeTable - the table

getEscapeTable

Hashtable<Character,String> getEscapeTable()

This method returns the current escape table for this TupleWriter

Returns:

the current escape table

getEncoding

String getEncoding()

Returns the encoding in which data shall be stored.

Returns:

encoding in which data shall be stored

setSeperator

void setSeperator(String seperator)

Sets the seperator with which the data will be departed on stream. Default seperator is tab.

Parameters:

seperator - with which the data will be departed on stream

getSeperator

String getSeperator()

Returns the seperator with which the data will be departed on stream.

Returns:

seperator with which the data will be departed on stream

setAttNames

void setAttNames(Collection<String> attNames)

Sets the names of attributes to which data belong.

Parameters:

attNames - - names of attributes to which data belong

getAttNames

Collection<String> getAttNames()

Returns the names of attributes to which data belong.

Returns:

attNames - names of attributes to which data belong

setDistinct

void setDistinct(Boolean distinct)

Set the distinct value for this tuple writer. If distinct= true, no duplicates will be stored for the same transaction. duplicates means two or more tuples with the same entries. To compare two tuples, the equals method of the string value is used (case sensitive). Default value is false. Attetntion: setting distinct to true makes add(...) very expensive

Parameters:

distinct - true if values shall be stored distinct.

isDistinct

Boolean isDistinct()

Returns true if this tuple writer stores values more than one times, if they are equal

Returns:

true, if tuples were stored distinct, default value is false.

setFile

void setFile(File out)

Sets the output file to the given.

getFile

File getFile()

Returns the output file.

Returns:

the output file

addTuple

void addTuple(Collection<String> tuple)
              throws FileNotFoundException

Adds a tuple to the stream without TA-Control.

Parameters:

tuple - - the tuple which shall be stored

Throws:

FileNotFoundException

beginTA

long beginTA()

Starts a transaction and returns a unique id for it.

Returns:

a unique transactional id

commitTA

void commitTA(Long TAId)
              throws FileNotFoundException

Commits the transaction with the given id.

Parameters:

TAId - - transactional id which is returned by beginTA()

Throws:

FileNotFoundException

abortTA

void abortTA(Long TAId)

Aborts the transaction with the given id.

Parameters:

TAId - - transactional id which is returned by beginTA()

addTuple

void addTuple(Long TAId,
            Collection<String> tuple)
              throws FileNotFoundException

Adds a tuple to the stream without TA-Control.

Parameters:

TAId - - transactional id to which this adding belongs (returned by beginTA())

tuple - - the tuple which shall be stored

Throws:

FileNotFoundException