de.lmu.ifi.dbs.elki.datasource.parser

Class AbstractStreamingParser

java.lang.Object

de.lmu.ifi.dbs.elki.datasource.parser.AbstractParser

de.lmu.ifi.dbs.elki.datasource.parser.AbstractStreamingParser

All Implemented Interfaces:

BundleStreamSource, Parser, StreamingParser

Direct Known Subclasses:

ClusteringVectorParser, NumberVectorLabelParser, SimpleTransactionParser

public abstract class AbstractStreamingParser
extends AbstractParser
implements StreamingParser

Base class for streaming parsers. TODO: build our own replacement for BufferedReader, which recycles the string builder.

Author:

Erich Schubert

Nested Class Summary

Nested classes/interfaces inherited from class de.lmu.ifi.dbs.elki.datasource.parser.AbstractParser

AbstractParser.Parameterizer

Nested classes/interfaces inherited from interface de.lmu.ifi.dbs.elki.datasource.bundle.BundleStreamSource

BundleStreamSource.Event

Field Summary

Fields

Modifier and Type	Field and Description
private StringBuilder	buf The buffer we read the data into.
private int	lineNumber Current line number.
private LineReader	reader Line reader.

Fields inherited from class de.lmu.ifi.dbs.elki.datasource.parser.AbstractParser

ATTRIBUTE_CONCATENATION, COMMENT_PATTERN, DEFAULT_SEPARATOR, NUMBER_PATTERN, QUOTE_CHARS, tokenizer

Constructor Summary

Constructors

Constructor and Description
AbstractStreamingParser(Pattern colSep, String quoteChars, Pattern comment) Constructor.

Method Summary

Modifier and Type	Method and Description
MultipleObjectsBundle	asMultipleObjectsBundle() Return (or collect) the stream as bundle.
boolean	assignDBID(DBIDVar var) Assign the current object ID to a DBIDVar.
void	cleanup() Cleanup internal data structures.
protected int	getLineNumber() Get the current line number.
boolean	hasDBIDs() Indicate whether the stream contains DBIDs.
void	initStream(InputStream in) Init the streaming parser for the given input stream.
protected boolean	nextLineExceptComments() Read the next line into the tokenizer.
MultipleObjectsBundle	parse(InputStream in) Returns a list of the objects parsed from the specified input stream.

Methods inherited from class de.lmu.ifi.dbs.elki.datasource.parser.AbstractParser

getLogger, isComment, lengthWithoutLinefeed, toString

Methods inherited from class java.lang.Object

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

Methods inherited from interface de.lmu.ifi.dbs.elki.datasource.bundle.BundleStreamSource

data, getMeta, nextEvent

Field Detail

reader

private LineReader reader

Line reader.

buf

private StringBuilder buf

The buffer we read the data into.

lineNumber

private int lineNumber

Current line number.

Constructor Detail

AbstractStreamingParser

public AbstractStreamingParser(Pattern colSep,
                               String quoteChars,
                               Pattern comment)

Constructor.

Parameters:

colSep - Column separator pattern

quoteChars - Quote characters

comment - Comment pattern

Method Detail

parse

public final MultipleObjectsBundle parse(InputStream in)

Description copied from interface: Parser

Returns a list of the objects parsed from the specified input stream.

Specified by:

parse in interface Parser

Parameters:

in - the stream to parse objects from

Returns:

a list containing those objects parsed from the input stream

initStream

public void initStream(InputStream in)

Description copied from interface: StreamingParser

Init the streaming parser for the given input stream.

Specified by:

initStream in interface StreamingParser

Parameters:

in - the stream to parse objects from

getLineNumber

protected int getLineNumber()

Get the current line number.

Returns:

Current line number

hasDBIDs

public boolean hasDBIDs()

Description copied from interface: BundleStreamSource

Indicate whether the stream contains DBIDs.

Specified by:

hasDBIDs in interface BundleStreamSource

Returns:

true if the stream contains DBIDs.

assignDBID

public boolean assignDBID(DBIDVar var)

Description copied from interface: BundleStreamSource

Assign the current object ID to a DBIDVar.

Specified by:

assignDBID in interface BundleStreamSource

Parameters:

var - Variable to assign the object id to

Returns:

false when no object id is available

nextLineExceptComments

protected boolean nextLineExceptComments()
                                  throws IOException

Read the next line into the tokenizer.

Returns:

The next line, or null.

Throws:

IOException

cleanup

public void cleanup()

Description copied from class: AbstractParser

Cleanup internal data structures.

Specified by:

cleanup in interface Parser

Overrides:

cleanup in class AbstractParser

asMultipleObjectsBundle

public MultipleObjectsBundle asMultipleObjectsBundle()

Description copied from interface: BundleStreamSource

Return (or collect) the stream as bundle.

Specified by:

asMultipleObjectsBundle in interface BundleStreamSource

Returns:

Bundle