DelimitedParser

An immutable parser for delimited files. This operates on chunks of input, using the parseChunk method. After parsing a chunk, the parseChunk method returns a new DelimitedParser as well as all of the complete rows parsed in that chunk. Any partially complete rows will be returned in a future call to parseChunk in either the returned DelimitedParser or a future one in a chain of calls to parseChunk.

There are also convenience methods for parsing Files, Strings, InputStreams, Readers, etc.

To get an instance of a DelimitedParser that can be used to parse a CSV, TSV, etc file, you can use something like:

val parser = DelimitedParser(DelimitedFormat.CSV)
val rows: Vector[Either[DelimitedError, Row]] =
  parser.parseFile(new java.io.File("some.csv"))

If you don't know the format of your delimited file ahead of time, not much changes:

val parser = DelimitedParser(DelimitedFormat.Guess)
val rows: Vector[Either[DelimitedError, Row]] =
  parser.parseFile(new java.io.File("some.csv"))

Linear Supertypes

AnyRef, Any

Known Subclasses

DelimitedParserImpl

Abstract Value Members

abstract def format: Option[DelimitedFormat]

The DelimitedFormat being used to parse this delimited file, or None if a format has not yet been inferred (in which case, no rows have yet been returned by parseChunk).
abstract def parseChunk(chunk: Option[String]): (DelimitedParser, Vector[Either[DelimitedError, Row]])

Parse a chunk of the input if there is any left.
Parse a chunk of the input if there is any left. If chunk is None, then that indicates to the parser that there will be no further input. In this case (chunk is None), all remaining input will be consumed and returned as rows (or errors).
This returns a new DelimitedParser to use to parse the next chunk, as well as a Vector of all complete rows parsed from chunk.
chunk
the next chunk of data as a String, or None if eof
abstract def reset: (String, DelimitedParser)

Returns all unparsed data and a DelimitedParser whose state is completely reset.

Concrete Value Members

final def !=(arg0: Any): Boolean

Definition Classes
AnyRef → Any
final def ##(): Int

Definition Classes
AnyRef → Any
final def ==(arg0: Any): Boolean

Definition Classes
AnyRef → Any
final def asInstanceOf[T0]: T0

Definition Classes
Any
def clone(): AnyRef

Attributes
protected[java.lang]
Definition Classes
AnyRef
Annotations
@throws( ... )
final def eq(arg0: AnyRef): Boolean

Definition Classes
AnyRef
def equals(arg0: Any): Boolean

Definition Classes
AnyRef → Any
def finalize(): Unit

Attributes
protected[java.lang]
Definition Classes
AnyRef
Annotations
@throws( classOf[java.lang.Throwable] )
final def getClass(): Class[_]

Definition Classes
AnyRef → Any
def hashCode(): Int

Definition Classes
AnyRef → Any
final def isInstanceOf[T0]: Boolean

Definition Classes
Any
final def ne(arg0: AnyRef): Boolean

Definition Classes
AnyRef
final def notify(): Unit

Definition Classes
AnyRef
final def notifyAll(): Unit

Definition Classes
AnyRef
def parseAll(chunks: Iterator[String]): Iterator[Either[DelimitedError, Row]]

Parse all chunks in the given iterator, consecutively, treating the last chunk in chunks as the final input.
Parse all chunks in the given iterator, consecutively, treating the last chunk in chunks as the final input. This will return all rows from the input.
def parseFile(file: File, charset: Charset = StandardCharsets.UTF_8): Vector[Either[DelimitedError, Row]]

Completely parses file and returns all the rows in a Vector.
Completely parses file and returns all the rows in a Vector.
file
the TSV file on disk
charset
the character set the TSV was encoded in
def parseInputStream(is: InputStream, charset: Charset = StandardCharsets.UTF_8): Iterator[Either[DelimitedError, Row]]

Returns an iterator that parses rows from in as elements are consumed.
Returns an iterator that parses rows from in as elements are consumed.
charset
the character set to decode the bytes as
def parseReader(reader: Reader): Iterator[Either[DelimitedError, Row]]

Returns an iterator that parses rows from reader as elements are consumed.
def parseString(input: String): Vector[Either[DelimitedError, Row]]

Parses an entire delimited file as a string.
final def synchronized[T0](arg0: ⇒ T0): T0

Definition Classes
AnyRef
def toString(): String

Definition Classes
AnyRef → Any
final def wait(): Unit

Definition Classes
AnyRef
Annotations
@throws( ... )
final def wait(arg0: Long, arg1: Int): Unit

Definition Classes
AnyRef
Annotations
@throws( ... )
final def wait(arg0: Long): Unit

Definition Classes
AnyRef
Annotations
@throws( ... )

Related Docs: object DelimitedParser | package delimited

trait DelimitedParser extends AnyRef

Abstract Value Members

abstract def format: Option[DelimitedFormat]

abstract def parseChunk(chunk: Option[String]): (DelimitedParser, Vector[Either[DelimitedError, Row]])

abstract def reset: (String, DelimitedParser)

Concrete Value Members

final def !=(arg0: Any): Boolean

final def ##(): Int

final def ==(arg0: Any): Boolean

final def asInstanceOf[T0]: T0

def clone(): AnyRef

final def eq(arg0: AnyRef): Boolean

def equals(arg0: Any): Boolean

def finalize(): Unit

final def getClass(): Class[_]

def hashCode(): Int

final def isInstanceOf[T0]: Boolean

final def ne(arg0: AnyRef): Boolean

final def notify(): Unit

final def notifyAll(): Unit

def parseAll(chunks: Iterator[String]): Iterator[Either[DelimitedError, Row]]

def parseFile(file: File, charset: Charset = StandardCharsets.UTF_8): Vector[Either[DelimitedError, Row]]

def parseInputStream(is: InputStream, charset: Charset = StandardCharsets.UTF_8): Iterator[Either[DelimitedError, Row]]

def parseReader(reader: Reader): Iterator[Either[DelimitedError, Row]]

def parseString(input: String): Vector[Either[DelimitedError, Row]]

final def synchronized[T0](arg0: ⇒ T0): T0

def toString(): String

final def wait(): Unit

final def wait(arg0: Long, arg1: Int): Unit

final def wait(arg0: Long): Unit

Inherited from AnyRef

Inherited from Any

Ungrouped