org.neo4j.csv.reader

Class BufferedCharSeeker

java.lang.Object

org.neo4j.csv.reader.BufferedCharSeeker

All Implemented Interfaces:

Closeable, AutoCloseable, CharSeeker, SourceTraceability

public class BufferedCharSeeker
extends Object
implements CharSeeker

Much like a BufferedReader for a Reader.

Nested Class Summary

Nested classes/interfaces inherited from interface org.neo4j.csv.reader.SourceTraceability

SourceTraceability.Adapter

Field Summary

Fields inherited from interface org.neo4j.csv.reader.SourceTraceability

EMPTY

Constructor Summary

Constructors

Constructor and Description
BufferedCharSeeker(Source source, Configuration config)

Method Summary

Modifier and Type	Method and Description
void	close()
<EXTRACTOR extends Extractor<?>> EXTRACTOR	extract(Mark mark, EXTRACTOR extractor) Extracts the value specified by the Mark, previously populated by a call to CharSeeker.seek(Mark, int).
long	lineNumber() 1-based line number of the current data source.
long	position()
boolean	seek(Mark mark, int untilChar) Seeks the next occurrence of any of the characters in untilOneOfChars, or if end-of-line, or even end-of-file.
String	sourceDescription()
String	toString()
boolean	tryExtract(Mark mark, Extractor<?> extractor) Extracts the value specified by the Mark, previously populated by a call to CharSeeker.seek(Mark, int).

Methods inherited from class java.lang.Object

equals, getClass, hashCode, notify, notifyAll, wait, wait, wait

Constructor Detail

BufferedCharSeeker

public BufferedCharSeeker(Source source,
                          Configuration config)

Method Detail

seek

public boolean seek(Mark mark,
                    int untilChar)
             throws IOException

Description copied from interface: CharSeeker

Seeks the next occurrence of any of the characters in untilOneOfChars, or if end-of-line, or even end-of-file.

Specified by:

seek in interface CharSeeker

Parameters:

mark - the mutable Mark which will be updated with the findings, if any.

untilChar - array of characters to seek.

Returns:

false if the end was reached and hence no value found, otherwise true.

Throws:

IOException - in case of I/O error.

extract

public <EXTRACTOR extends Extractor<?>> EXTRACTOR extract(Mark mark,
                                                          EXTRACTOR extractor)

Description copied from interface: CharSeeker

Extracts the value specified by the Mark, previously populated by a call to CharSeeker.seek(Mark, int).

Specified by:

extract in interface CharSeeker

Parameters:

mark - the Mark specifying which part of a bigger piece of data contains the found value.

extractor - Extractor capable of extracting the value.

Returns:

the supplied Extractor, which after the call carries the extracted value itself, where either Extractor.value() or a more specific accessor method can be called to access the value.

tryExtract

public boolean tryExtract(Mark mark,
                          Extractor<?> extractor)

Description copied from interface: CharSeeker

Extracts the value specified by the Mark, previously populated by a call to CharSeeker.seek(Mark, int).

Specified by:

tryExtract in interface CharSeeker

Parameters:

mark - the Mark specifying which part of a bigger piece of data contains the found value.

extractor - Extractor capable of extracting the value.

Returns:

true if a value was extracted, otherwise false. Probably the only reason for returning false would be if the data to extract was empty.

close

public void close()
           throws IOException

Specified by:

close in interface Closeable

Specified by:

close in interface AutoCloseable

Throws:

IOException

position

public long position()

Specified by:

position in interface SourceTraceability

Returns:

a low-level byte-like position of f.ex. total number of read bytes.

sourceDescription

public String sourceDescription()

Specified by:

sourceDescription in interface SourceTraceability

Returns:

description of the source being read from.

lineNumber

public long lineNumber()

Description copied from interface: SourceTraceability

1-based line number of the current data source.

Specified by:

lineNumber in interface SourceTraceability

Returns:

current line number in the current data source.

toString

public String toString()

Overrides:

toString in class Object