Package org.apache.poi.xssf.extractor

Class XSSFExportToXml

  • All Implemented Interfaces:
    java.util.Comparator<java.lang.String>
    public class XSSFExportToXml
extends java.lang.Object
implements java.util.Comparator<java.lang.String>
    Maps an XLSX to an XML according to one of the mapping defined. The output XML Schema must respect this limitations:
    • all mandatory elements and attributes must be mapped (enable validation to check this)
    • no <any> in complex type/element declaration
    • no <anyAttribute> attributes declaration
    • no recursive structures: recursive structures can't be nested more than one level
    • no abstract elements: abstract complex types can be declared but must not be used in elements.
    • no mixed content: an element can't contain simple text and child element(s) together
    • no <substitutionGroup> in complex type/element declaration

    • Constructor Summary

      Constructors 
      Constructor Description
      XSSFExportToXml​(XSSFMap map)
      Creates a new exporter and sets the mapping to be used when generating the XML output document

    • Method Summary

      All Methods Instance Methods Concrete Methods 
      Modifier and Type Method Description
      int compare​(java.lang.String leftXpath, java.lang.String rightXpath)
      Compares two xpaths to define an ordering according to the XML Schema
      void exportToXML​(java.io.OutputStream os, boolean validate)
      Exports the data in an XML stream
      void exportToXML​(java.io.OutputStream os, java.lang.String encoding, boolean validate)
      Exports the data in an XML stream

      • Methods inherited from class java.lang.Object

        equals, getClass, hashCode, notify, notifyAll, toString, wait, wait, wait

      • Methods inherited from interface java.util.Comparator

        equals, reversed, thenComparing, thenComparing, thenComparing, thenComparingDouble, thenComparingInt, thenComparingLong

    • Constructor Detail

      • XSSFExportToXml

        public XSSFExportToXml​(XSSFMap map)
        Creates a new exporter and sets the mapping to be used when generating the XML output document
        Parameters:
        map - the mapping rule to be used

    • Method Detail

      • exportToXML

        public void exportToXML​(java.io.OutputStream os,
                        boolean validate)
                 throws org.xml.sax.SAXException,
                        javax.xml.transform.TransformerException
        Exports the data in an XML stream
        Parameters:
        os - OutputStream in which will contain the output XML
        validate - if true, validates the XML against the XML Schema
        Throws:
        org.xml.sax.SAXException - If validating the document fails
        javax.xml.transform.TransformerException - If transforming the document fails

      • exportToXML

        public void exportToXML​(java.io.OutputStream os,
                        java.lang.String encoding,
                        boolean validate)
                 throws org.xml.sax.SAXException,
                        javax.xml.transform.TransformerException
        Exports the data in an XML stream
        Parameters:
        os - OutputStream in which will contain the output XML
        encoding - the output charset encoding
        validate - if true, validates the XML against the XML Schema
        Throws:
        org.xml.sax.SAXException - If validating the document fails
        javax.xml.transform.TransformerException - If transforming the document fails

      • compare

        public int compare​(java.lang.String leftXpath,
                   java.lang.String rightXpath)
        Compares two xpaths to define an ordering according to the XML Schema
        Specified by:
        compare in interface java.util.Comparator<java.lang.String>