com.phasmidsoftware.tableparser.core.examples.Movie
MovieRowProcessor
Companion object MovieRowProcessor
trait MovieRowProcessor extends StringRowProcessor[Movie]
The MovieRowProcessor trait provides a concrete implementation for processing rows of
raw input (as Strings) representing Movie objects. This trait extends the StringRowProcessor
tailored for Movie rows, deducing String as the input type and Movie as the row type.
Specifically, this trait:
- Adopts a fault-tolerant approach to parsing by setting forgiving = true, enabling the
processor to recover from minor parsing errors where possible.
- Utilizes an implicit RowParser[Movie, String] to handle the actual parsing logic for individual rows.
- Optionally relies on a Header for structured row processing. If a fixed header is not provided
via maybeHeader, additional rows can be consumed to dynamically determine the header.
- Sets the default number of header rows to read as 1 (headerRowsToRead).
This processor is an integral part of the parsing workflow for Movie data parsed from
input sources such as files or streams.
Key Type Members and Fields:
- Row: Alias for Movie as the row type this processor handles.
- maybeHeader: Optionally allows for a pre-determined table header for consistent column names.
- headerRowsToRead: Specifies the number of rows to consume when detecting a dynamic header.
- forgiving: Configures fault-tolerance for processing, set to true by default.
- rowParser: An implicit instance of RowParser
- Alphabetic
- By Inheritance
- MovieRowProcessor
- StringRowProcessor
- AbstractRowProcessor
- RowProcessor
- AnyRef
- Any
- Hide All
- Show All
- Public
- Protected
Type Members
- type Input = String
The input type, typically
String.The input type, typically
String.- Definition Classes
- StringRowProcessor → RowProcessor
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[lang]
- Definition Classes
- AnyRef
- Annotations
- @throws(classOf[java.lang.CloneNotSupportedException]) @native()
- final def eq(arg0: AnyRef): Boolean
- Definition Classes
- AnyRef
- def equals(arg0: AnyRef): Boolean
- Definition Classes
- AnyRef → Any
- val forgiving: Boolean
Method to determine how errors are handled.
Method to determine how errors are handled.
- returns
true if individual errors are logged but do not cause parsing to fail.
- Definition Classes
- MovieRowProcessor → RowProcessor
- final def getClass(): Class[_ <: AnyRef]
- Definition Classes
- AnyRef → Any
- Annotations
- @native()
- def hashCode(): Int
- Definition Classes
- AnyRef → Any
- Annotations
- @native()
- val headerRowsToRead: Int
This indicates the number of header rows which must be read from the input.
This indicates the number of header rows which must be read from the input. If maybeHeader exists, then this property is ignored.
- Definition Classes
- RowProcessor
- final def isInstanceOf[T0]: Boolean
- Definition Classes
- Any
- val maybeHeader: Option[Header]
This variable determines if there is a programmed, i.e., fixed, header for the parser.
This variable determines if there is a programmed, i.e., fixed, header for the parser. If its value is None, it signifies that we must look to the first line(s) of data for an appropriate header.
- Attributes
- protected
- Definition Classes
- RowProcessor
- val multiline: Boolean
Value to determine whether it is acceptable to have a quoted string span more than one line.
Value to determine whether it is acceptable to have a quoted string span more than one line.
- returns
true if quoted strings may span more than one line.
- Attributes
- protected
- Definition Classes
- RowProcessor
- final def ne(arg0: AnyRef): Boolean
- Definition Classes
- AnyRef
- final def notify(): Unit
- Definition Classes
- AnyRef
- Annotations
- @native()
- final def notifyAll(): Unit
- Definition Classes
- AnyRef
- Annotations
- @native()
- val predicate: (Try[Movie]) => Boolean
Function to determine whether or not a row should be included in the table.
Function to determine whether or not a row should be included in the table. Typically used for random sampling.
- Attributes
- protected
- Definition Classes
- RowProcessor
- def process(xs: Iterator[String], n: Int)(implicit ev: Joinable[String]): Iterator[Movie]
Processes an iterator of input rows with an optional header and parses them into rows.
Processes an iterator of input rows with an optional header and parses them into rows.
NOTE this will not work as required because it will still have to collect all of the individual elements inside a Try at some point. That defeats the purpose of just being able to iterate.
Depending on the presence of a fixed header and the number of rows to drop (
n): - If a fixed header is available, the processing starts after dropping the firstnrows. - If no fixed header is available butn > 0, the firstnrows are extracted and used to parse the header, and subsequent rows are processed accordingly. - If no fixed header is available andn <= 0, an error is returned indicating a logic issue.This method heavily relies on implicit evidence (
Joinable[Input]) to ensure the input type adheres to the necessary constraints for the transformation and joining of rows.- xs
an iterator of inputs, where each element corresponds to a row of input data.
- n
the number of initial rows to ignore (e.g., when rows are part of the header).
- ev
an implicit evidence parameter ensuring the input type adheres to the
Joinabletype class, which provides methods to combine or validate input elements during processing.- returns
a
Trycontaining an iterator of parsedRowobjects if the parsing succeeds, or a failure if any step of the process encounters an error (e.g., invalid header or processing logic).
- Definition Classes
- StringRowProcessor → AbstractRowProcessor
- val rowParser: RowParser[Movie, String]
Method to define a row parser.
Method to define a row parser.
- returns
a RowParser[Row, Input].
- Definition Classes
- StringRowProcessor → RowProcessor
- 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(classOf[java.lang.InterruptedException])
- final def wait(arg0: Long, arg1: Int): Unit
- Definition Classes
- AnyRef
- Annotations
- @throws(classOf[java.lang.InterruptedException])
- final def wait(arg0: Long): Unit
- Definition Classes
- AnyRef
- Annotations
- @throws(classOf[java.lang.InterruptedException]) @native()
Deprecated Value Members
- def finalize(): Unit
- Attributes
- protected[lang]
- Definition Classes
- AnyRef
- Annotations
- @throws(classOf[java.lang.Throwable]) @Deprecated
- Deprecated
(Since version 9)