org.apache.poi.xssf.extractor

Class XSSFExportToXml

java.lang.Object

org.apache.poi.xssf.extractor.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

(根据定义的映射之一将 XLSX 映射到 XML。输出 XML Schema 必须遵守此限制：必须映射所有必需的元素和属性（启用验证以检查这一点）否 在复杂类型/元素声明中没有 属性声明 没有递归结构：递归结构不能嵌套超过一层 没有抽象元素：可以声明抽象复杂类型，但不能在元素中使用。没有混合内容：一个元素不能同时包含简单的文本和子元素 在复杂类型/元素声明中)

Constructor Summary

Constructors

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

Method Summary

Modifier and Type	Method and Description
int	compare(java.lang.String leftXpath, java.lang.String rightXpath) Compares two xpaths to define an ordering according to the XML Schema (比较两个 xpath 以根据 XML Schema 定义排序)
void	exportToXML(java.io.OutputStream os, boolean validate) Exports the data in an XML stream (以 XML 流的形式导出数据)
void	exportToXML(java.io.OutputStream os, java.lang.String encoding, boolean validate) Exports the data in an XML stream (以 XML 流的形式导出数据)

Methods inherited from class java.lang.Object

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

Methods inherited from interface java.util.Comparator

comparing, comparing, comparingDouble, comparingInt, comparingLong, equals, naturalOrder, nullsFirst, nullsLast, reversed, reverseOrder, 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 (创建一个新的导出器并设置生成 XML 输出文档时要使用的映射)

Parameters:

map - the mapping rule to be used (map - 要使用的映射规则)

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 (以 XML 流的形式导出数据)

Parameters:

os - OutputStream in which will contain the output XML (os - OutputStream 将包含输出 XML)

validate - if true, validates the XML against the XML Schema (validate - 如果为 true，则根据 XML Schema 验证 XML)

Throws:

org.xml.sax.SAXException - If validating the document fails (org.xml.sax.SAXException - 如果验证文档失败)

javax.xml.transform.TransformerException - If transforming the document fails (javax.xml.transform.TransformerException - 如果转换文档失败)

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 (以 XML 流的形式导出数据)

Parameters:

os - OutputStream in which will contain the output XML (os - OutputStream 将包含输出 XML)

encoding - the output charset encoding (encoding - 输出字符集编码)

validate - if true, validates the XML against the XML Schema (validate - 如果为 true，则根据 XML Schema 验证 XML)

Throws:

org.xml.sax.SAXException - If validating the document fails (org.xml.sax.SAXException - 如果验证文档失败)

javax.xml.transform.TransformerException - If transforming the document fails (javax.xml.transform.TransformerException - 如果转换文档失败)

compare

public int compare(java.lang.String leftXpath,
                   java.lang.String rightXpath)

Compares two xpaths to define an ordering according to the XML Schema (比较两个 xpath 以根据 XML Schema 定义排序)

Specified by:

compare in interface java.util.Comparator<java.lang.String> (在接口 java.util.Comparator 中比较 )