org.corpus_tools.peppermodules.conll.tupleconnector

Interface TupleReader

All Known Implementing Classes:

TupleReaderImpl

public interface TupleReader

Classes which implements this interface can read a stream which contains tuples. Although tuples will be read in whole and gave back tuple by tuple.

Author:

Florian Zipser

Method Summary

Methods

Modifier and Type	Method and Description
Integer	characterSize() Returns the number of characters contained in this tuple reader.
Integer	characterSize(Integer fieldIndex) Returns the number of characters contained in the field given by fieldIndex of this tuple reader.
String	getEncoding() Returns the encoding in which data shall be stored.
File	getFile() Returns the
Integer	getNumOfTuples() Returns the number of read tuples.
String	getSeperator() Returns the seperator with which the data will be departed on stream.
Collection<String>	getTuple() Returns a the tuple which is next in datasource.
Collection<String>	getTuple(Integer index) Returns the tuple at position index.
Collection<Collection<String>>	getTuples() Returns all currently read tuples.
void	readFile() Reads the given file and creates an internal list of read tuples.
void	restart() Sets internal tuple pointer to start, so that getTuple() returns all tuples from beginning.
void	setEncoding(String encoding) Sets the encoding in which data shall be stored.
void	setFile(File inFile) Sets the file from which the tuples shall come, so called datasource.
void	setSeperator(String seperator) Sets the seperator with which the data will be departed on stream.
Integer	size() Returns the number of tuples contained in this tuple reader.

Method Detail

setFile

void setFile(File inFile)

Sets the file from which the tuples shall come, so called datasource.

Parameters:

inFile - - datasource

getFile

File getFile()

Returns the

Returns:

file from which the tuples shall come, so called datasource.

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

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

getEncoding

String getEncoding()

Returns the encoding in which data shall be stored.

Returns:

encoding in which data shall be stored

getTuples

Collection<Collection<String>> getTuples()

Returns all currently read tuples.

Returns:

all read tuples.

getTuple

Collection<String> getTuple()
                            throws IOException

Returns a the tuple which is next in datasource. Datasource will be read one time and stored internal. a pointer is set to data and incremented when this method is called.

Returns:

current tuple

Throws:

IOException

getNumOfTuples

Integer getNumOfTuples()

Returns the number of read tuples.

Returns:

number of tuples

getTuple

Collection<String> getTuple(Integer index)
                            throws IOException

Returns the tuple at position index.

Parameters:

index - position of tuple to return

Returns:

tuple at position index

Throws:

IOException

restart

void restart()

Sets internal tuple pointer to start, so that getTuple() returns all tuples from beginning.

size

Integer size()

Returns the number of tuples contained in this tuple reader.

Returns:

number of tuples

characterSize

Integer characterSize()

Returns the number of characters contained in this tuple reader.

Returns:

number of characters

characterSize

Integer characterSize(Integer fieldIndex)

Returns the number of characters contained in the field given by fieldIndex of this tuple reader.

Parameters:

fieldIndex - the index of the field

Returns:

number of characters in the field

readFile

void readFile()
              throws IOException

Reads the given file and creates an internal list of read tuples.

Throws:

IOException