class XMLReader extends Serializable

Class to parse and read XML files.

Linear Supertypes
Serializable, Serializable, AnyRef, Any
Ordering
  1. Alphabetic
  2. By Inheritance
Inherited
  1. XMLReader
  2. Serializable
  3. Serializable
  4. AnyRef
  5. Any
  1. Hide All
  2. Show All
Visibility
  1. Public
  2. All

Instance Constructors

  1. new XMLReader(storeContent: Boolean = false, xmlKeepTags: Boolean = false, onlyLeafNodes: Boolean = true)

    storeContent

    Whether to include the raw XML content in the resulting DataFrame as a separate 'content' column. By default, this is false.

    xmlKeepTags

    Whether to retain original XML tag names and include them in the metadata for each extracted element. Useful for preserving structure. Default is false.

    onlyLeafNodes

    If true, only the deepest elements (those without child elements) are extracted. If false, all elements are extracted. Default is true.

    Input Format

    Input must be a valid path to an XML file or a directory containing XML files.

    Example

    val xmlPath = "./data/sample.xml"
val xmlReader = new XMLReader()
val xmlDf = xmlReader.read(xmlPath)
    xmlDf.show(truncate = false)
+----------------------+--------------------------------------------------+
|path                  |xml                                               |
+----------------------+--------------------------------------------------+
|file:/data/sample.xml |[{Title, My Book, {tag -> title}}, ...]          |
+----------------------+--------------------------------------------------+

xmlDf.printSchema()
root
 |-- path: string (nullable = true)
 |-- xml: 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 refer to: notebook

Value Members

  1. final def !=(arg0: Any): Boolean
    Definition Classes
    AnyRef → Any
  2. final def ##(): Int
    Definition Classes
    AnyRef → Any
  3. final def ==(arg0: Any): Boolean
    Definition Classes
    AnyRef → Any
  4. final def asInstanceOf[T0]: T0
    Definition Classes
    Any
  5. def clone(): AnyRef
    Attributes
    protected[lang]
    Definition Classes
    AnyRef
    Annotations
    @throws( ... ) @native()
  6. final def eq(arg0: AnyRef): Boolean
    Definition Classes
    AnyRef
  7. def equals(arg0: Any): Boolean
    Definition Classes
    AnyRef → Any
  8. def finalize(): Unit
    Attributes
    protected[lang]
    Definition Classes
    AnyRef
    Annotations
    @throws( classOf[java.lang.Throwable] )
  9. final def getClass(): Class[_]
    Definition Classes
    AnyRef → Any
    Annotations
    @native()
  10. def hash(s: String): String
  11. def hashCode(): Int
    Definition Classes
    AnyRef → Any
    Annotations
    @native()
  12. final def isInstanceOf[T0]: Boolean
    Definition Classes
    Any
  13. final def ne(arg0: AnyRef): Boolean
    Definition Classes
    AnyRef
  14. final def notify(): Unit
    Definition Classes
    AnyRef
    Annotations
    @native()
  15. final def notifyAll(): Unit
    Definition Classes
    AnyRef
    Annotations
    @native()
  16. def parseXml(xmlString: String): List[HTMLElement]
  17. def read(inputSource: String): DataFrame
  18. def setOutputColumn(value: String): XMLReader.this.type
  19. final def synchronized[T0](arg0: ⇒ T0): T0
    Definition Classes
    AnyRef
  20. def toString(): String
    Definition Classes
    AnyRef → Any
  21. final def wait(): Unit
    Definition Classes
    AnyRef
    Annotations
    @throws( ... )
  22. final def wait(arg0: Long, arg1: Int): Unit
    Definition Classes
    AnyRef
    Annotations
    @throws( ... )
  23. final def wait(arg0: Long): Unit
    Definition Classes
    AnyRef
    Annotations
    @throws( ... ) @native()

Inherited from Serializable

Inherited from Serializable

Inherited from AnyRef

Inherited from Any

Ungrouped