org.neo4j.csv.reader

Interface SourceTraceability

All Known Subinterfaces:

CharReadable, CharSeeker

All Known Implementing Classes:

BufferedCharSeeker, CharReadable.Adapter, MultiReadable, SourceTraceability.Adapter, ThreadAheadReadable

public interface SourceTraceability

Provides information about a source of data. An example usage would be reading a text file where sourceDescription() would say the name of the file, lineNumber() the line number and position() the byte position the reader is currently at. Another example could be reading from a relationship db table where sourceDescription() would say the name of the database and table, or similar, lineNumber() the ordinal of the row we're currently at and position() some sort of absolute position saying how many bytes we've read from the data source.

Nested Class Summary

Nested Classes

Modifier and Type	Interface and Description
static class	SourceTraceability.Adapter

Method Summary

Modifier and Type	Method and Description
long	lineNumber() 1-based line number of the current data source.
long	position()
String	sourceDescription()

Method Detail

sourceDescription

String sourceDescription()

Returns:

description of the source being read from.

lineNumber

long lineNumber()

1-based line number of the current data source.

Returns:

current line number in the current data source.

position

long position()

Returns:

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