fm-flatfile
API
Generated with
fm-flatfile/fm.flatfile

fm.flatfile

package fm.flatfile

Members list

Concise view

Type members

Classlikes

final case class FlatFileParsedRow(values: IndexedSeq[String], rawRow: CharSequence, lineNumber: Long)

Attributes

Graph
Supertypes
trait Serializable
trait Product
trait Equals
class Object
trait Matchable
class Any
object FlatFileReader extends FlatFileReaderFactory

Attributes

Companion:
class
Graph
Supertypes
class Object
trait Matchable
class Any
Self type
abstract class FlatFileReader extends LazySeq[FlatFileRow]

Attributes

Companion:
object
Graph
Supertypes
trait LazySeq[FlatFileRow]
trait TraversableOnce[FlatFileRow]
class WithFilterCompat[FlatFileRow, LazySeq]
class WithFilter[FlatFileRow, LazySeq]
trait Serializable
class Object
trait Matchable
class Any
Known subtypes
abstract class FlatFileReaderException(msg: String, val friendlyTitle: String, val friendlyMessage: String) extends UserFriendlyException

Attributes

Companion:
object
Graph
Supertypes
class UserFriendlyException
class Exception
class Throwable
trait Serializable
class Object
trait Matchable
class Any
Known subtypes
class EmptyFile
object FlatFileReaderException

Attributes

Companion:
class
Graph
Supertypes
class Object
trait Matchable
class Any
Self type
trait FlatFileReaderFactory

Attributes

Graph
Supertypes
class Object
trait Matchable
class Any
Known subtypes
object FlatFileReader.type
object XLSFlatFileReader.type
object XLSXFlatFileReader.type
final class FlatFileReaderForImpl[IN](resource: Resource[IN], options: FlatFileReaderOptions, impl: FlatFileReaderImpl[IN]) extends FlatFileReader

This creates an instance of a FlatFileReader for a given implementation

This creates an instance of a FlatFileReader for a given implementation

Attributes

Graph
Supertypes
trait LazySeq[FlatFileRow]
trait TraversableOnce[FlatFileRow]
class WithFilterCompat[FlatFileRow, LazySeq]
class WithFilter[FlatFileRow, LazySeq]
trait Serializable
class Object
trait Matchable
class Any
trait FlatFileReaderImpl[IN] extends FlatFileReaderFactory

This is what you extends to implement a new FlatFileReader type

This is what you extends to implement a new FlatFileReader type

Attributes

Graph
Supertypes
class Object
trait Matchable
class Any
Known subtypes
object XLSFlatFileReader.type
object XLSXFlatFileReader.type
object FlatFileReaderOptions

Attributes

Companion:
class
Graph
Supertypes
trait Product
trait Mirror
class Object
trait Matchable
class Any
Self type
final case class FlatFileReaderOptions(skipLines: Int, skipTrailingLines: Int, skipEmptyLines: Boolean, hasHeaders: Boolean, headers: Option[IndexedSeq[String]], enforceColumnCount: Boolean, allowLessColumns: Boolean, columnCount: Int, addMissingValues: Boolean, trimValues: Boolean, dumpRowDetailsOnException: Boolean, headerDetection: HeaderDetection, headerTransform: IndexedSeq[String] => IndexedSeq[String], sep: String, quote: QuoteOption, characterEncoding: String, comment: String, plainLineReaderTransform: LazySeq[LineWithNumber] => LazySeq[LineWithNumber], sheetName: String)

Attributes

Companion:
object
Graph
Supertypes
trait Serializable
trait Product
trait Equals
class Object
trait Matchable
class Any
abstract class FlatFileReaderWithTries extends LazySeq[Try[FlatFileRow]]

Attributes

Graph
Supertypes
trait LazySeq[Try[FlatFileRow]]
trait TraversableOnce[Try[FlatFileRow]]
class WithFilterCompat[Try[FlatFileRow], LazySeq]
class WithFilter[Try[FlatFileRow], LazySeq]
trait Serializable
class Object
trait Matchable
class Any
Known subtypes
final class FlatFileReaderWithTriesForImpl[IN](resource: Resource[IN], options: FlatFileReaderOptions, impl: FlatFileReaderImpl[IN]) extends FlatFileReaderWithTries

Attributes

Graph
Supertypes
trait LazySeq[Try[FlatFileRow]]
trait TraversableOnce[Try[FlatFileRow]]
class WithFilterCompat[Try[FlatFileRow], LazySeq]
class WithFilter[Try[FlatFileRow], LazySeq]
trait Serializable
class Object
trait Matchable
class Any
final case class FlatFileRow(values: IndexedSeq[String], rawRowCharSequence: CharSequence, lineNumber: Long, rowHeaders: FlatFileRowHeaders)

The parsed representation of a Row with methods for reading the columns based on optional headers

The parsed representation of a Row with methods for reading the columns based on optional headers

Attributes

Graph
Supertypes
trait Serializable
trait Product
trait Equals
class Object
trait Matchable
class Any
object FlatFileRowHeaders

Attributes

Companion:
class
Graph
Supertypes
trait Product
trait Mirror
class Object
trait Matchable
class Any
Self type
final case class FlatFileRowHeaders(headers: IndexedSeq[String])

Attributes

Companion:
object
Graph
Supertypes
trait Serializable
trait Product
trait Equals
class Object
trait Matchable
class Any
object FlatFileWriter

Attributes

Companion:
class
Graph
Supertypes
class Object
trait Matchable
class Any
Self type
final class FlatFileWriter(writer: Writer, options: FlatFileWriterOptions)

Attributes

Companion:
object
Graph
Supertypes
class Object
trait Matchable
class Any
object FlatFileWriterOptions

Attributes

Companion:
class
Graph
Supertypes
trait Product
trait Mirror
class Object
trait Matchable
class Any
Self type
final case class FlatFileWriterOptions(headers: Option[IndexedSeq[String]], sep: String, quote: String, newline: String, trailingNewline: Boolean, writeHeaders: Boolean)

Attributes

Companion:
object
Graph
Supertypes
trait Serializable
trait Product
trait Equals
class Object
trait Matchable
class Any
Generated with