class TextReader extends Serializable
Class to read and parse text files.
- Alphabetic
- By Inheritance
- TextReader
- Serializable
- AnyRef
- Any
- Hide All
- Show All
- Public
- Protected
Instance Constructors
- new TextReader(titleLengthSize: Int = 50, storeContent: Boolean = false, blockSplit: String = BLOCK_SPLIT_PATTERN, groupBrokenParagraphs: Boolean = false, paragraphSplit: String = DOUBLE_PARAGRAPH_PATTERN, shortLineWordThreshold: Int = 5, maxLineCount: Int = 2000, threshold: Double = 0.1)
- titleLengthSize
Maximum character length used to determine if a text block qualifies as a title during parsing. The default value is 50.
- storeContent
Timeout value in seconds for reading remote HTML resources. Applied when fetching content from URLs. By default, it is set to false.
- groupBrokenParagraphs
Whether to merge fragmented lines into coherent paragraphs using heuristics based on line length and structure. By default, it is set to false.
- paragraphSplit
Regex pattern used to detect paragraph boundaries when grouping broken paragraphs. Default value is set to double paragraph pattern.
- shortLineWordThreshold
Maximum word count for a line to be considered 'short' during broken paragraph grouping. Default value is 5.
- maxLineCount
Maximum number of lines to evaluate when estimating paragraph layout characteristics. Default value is 2000.
- threshold
Threshold ratio of empty lines used to decide between new line-based or broken-paragraph grouping. Default value is 0.1.
Example
val filePath = "./txt-files/simple-text.txt" val textReader = new TextReader() val textDf = textReader.txt(filePath)
textDf.show() +--------------------+--------------------+ | path| txt| +--------------------+--------------------+ |file:/content/txt...|[{Title, BIG DATA...| +--------------------+--------------------+ textDf.printSchema() root |-- path: string (nullable = true) |-- txt: array (nullable = true) | |-- element: struct (containsNull = true) | | |-- elementType: string (nullable = true) | | |-- content: string (nullable = true) | | |-- metadata: map (nullable = true) | | | |-- key: string | | | |-- value: string (valueContainsNull = true)For more examples please refer to this notebook.
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]) @HotSpotIntrinsicCandidate() @native()
- final def eq(arg0: AnyRef): Boolean
- Definition Classes
- AnyRef
- def equals(arg0: AnyRef): Boolean
- Definition Classes
- AnyRef → Any
- final def getClass(): Class[_ <: AnyRef]
- Definition Classes
- AnyRef → Any
- Annotations
- @HotSpotIntrinsicCandidate() @native()
- def getOutputColumn: String
- def hashCode(): Int
- Definition Classes
- AnyRef → Any
- Annotations
- @HotSpotIntrinsicCandidate() @native()
- final def isInstanceOf[T0]: Boolean
- Definition Classes
- Any
- final def ne(arg0: AnyRef): Boolean
- Definition Classes
- AnyRef
- final def notify(): Unit
- Definition Classes
- AnyRef
- Annotations
- @HotSpotIntrinsicCandidate() @native()
- final def notifyAll(): Unit
- Definition Classes
- AnyRef
- Annotations
- @HotSpotIntrinsicCandidate() @native()
- def setOutputColumn(value: String): TextReader.this.type
- final def synchronized[T0](arg0: => T0): T0
- Definition Classes
- AnyRef
- def toString(): String
- Definition Classes
- AnyRef → Any
- def txt(filePath: String): DataFrame
Parses TXT files and returns a DataFrame.
Parses TXT files and returns a DataFrame.
The DataFrame will contain:
- "path": the file path,
- "content": the raw text content,
- outputColumn: a Seq[HTMLElement] containing the parsed elements.
- def txtContent(content: String): DataFrame
- def txtToHTMLElement(text: String): Seq[HTMLElement]
- 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()
- final def wait(): Unit
- Definition Classes
- AnyRef
- Annotations
- @throws(classOf[java.lang.InterruptedException])
Deprecated Value Members
- def finalize(): Unit
- Attributes
- protected[lang]
- Definition Classes
- AnyRef
- Annotations
- @throws(classOf[java.lang.Throwable]) @Deprecated
- Deprecated
(Since version 9)