org.xwiki.rendering.renderer.printer.XMLWikiPrinter Maven / Gradle / Ivy
Go to download
Show more of this group Show more artifacts with this name
Show all versions of xwiki-rendering-xml Show documentation
Show all versions of xwiki-rendering-xml Show documentation
XML related tools for the rendering
/*
* See the NOTICE file distributed with this work for additional
* information regarding copyright ownership.
*
* This is free software; you can redistribute it and/or modify it
* under the terms of the GNU Lesser General Public License as
* published by the Free Software Foundation; either version 2.1 of
* the License, or (at your option) any later version.
*
* This software is distributed in the hope that it will be useful,
* but WITHOUT ANY WARRANTY; without even the implied warranty of
* MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE. See the GNU
* Lesser General Public License for more details.
*
* You should have received a copy of the GNU Lesser General Public
* License along with this software; if not, write to the Free
* Software Foundation, Inc., 51 Franklin St, Fifth Floor, Boston, MA
* 02110-1301 USA, or see the FSF site: http://www.fsf.org.
*/
package org.xwiki.rendering.renderer.printer;
import java.io.IOException;
import java.util.Map;
import org.dom4j.Element;
import org.dom4j.io.XMLWriter;
import org.dom4j.tree.DefaultComment;
import org.dom4j.tree.DefaultElement;
import org.dom4j.tree.DefaultEntity;
import org.xml.sax.Attributes;
import org.xml.sax.SAXException;
import org.xml.sax.helpers.AttributesImpl;
import org.xwiki.rendering.internal.renderer.printer.WikiWriter;
import org.xwiki.rendering.xml.internal.renderer.printer.XHTMLWriter;
import org.xwiki.xml.XMLUtils;
/**
* Base toolkit class for all XML-based printers.
*
* @version $Id: 669007992fa328bdcede6592551f095ef08354ee $
* @since 1.9M1
*/
public class XMLWikiPrinter
{
protected WikiWriter wikiWriter;
protected XMLWriter xmlWriter;
/**
* @param printer the object to which to write the XHTML output to
*/
public XMLWikiPrinter(WikiPrinter printer)
{
this.wikiWriter = new WikiWriter(printer);
this.xmlWriter = new XHTMLWriter(this.wikiWriter);
}
public XMLWriter getXMLWriter()
{
return this.xmlWriter;
}
public void setWikiPrinter(WikiPrinter printer)
{
this.wikiWriter.setWikiPrinter(printer);
}
/**
* Print provided text. Takes care of xml escaping.
*
* @param str the string to print
*/
public void printXML(String str)
{
try {
this.xmlWriter.write(str);
} catch (IOException e) {
// TODO: add error log here
}
}
/**
* Print the xml element. In the form {@code attributes)
{
Element element = new DefaultElement(name);
if (attributes != null && !attributes.isEmpty()) {
for (Map.Entry entry : attributes.entrySet()) {
element.addAttribute(entry.getKey(), entry.getValue());
}
}
try {
this.xmlWriter.write(element);
} catch (IOException e) {
// TODO: add error log here
}
}
/**
* Print the start tag of xml element. In the form {@code }.
*
* @param name the xml element to print
*/
public void printXMLStartElement(String name)
{
printXMLStartElement(name, new AttributesImpl());
}
/**
* Print the start tag of xml element. In the form {@code }.
*
* @param name the xml element to print
* @param attributes the xml attributes of the element to print
*/
public void printXMLStartElement(String name, String[][] attributes)
{
printXMLStartElement(name, createAttributes(attributes));
}
/**
* Print the start tag of xml element. In the form {@code }.
*
* @param name the xml element to print
* @param attributes the xml attributes of the element to print
*/
public void printXMLStartElement(String name, Map attributes)
{
printXMLStartElement(name, createAttributes(attributes));
}
/**
* Print the start tag of xml element. In the form {@code }.
*
* @param name the xml element to print
* @param attributes the xml attributes of the element to print
*/
public void printXMLStartElement(String name, Attributes attributes)
{
try {
this.xmlWriter.startElement("", name, name, attributes);
} catch (SAXException e) {
// TODO: add error log here
}
}
/**
* Print the end tag of xml element. In the form {@code }.
*
* @param name the xml element to print
*/
public void printXMLEndElement(String name)
{
try {
this.xmlWriter.endElement("", name, name);
} catch (SAXException e) {
// TODO: add error log here
}
}
/**
* Print a XML comment. Note that the content that you pass must be valid XML comment, ie not have --
* characters (or - if it's the last character). If you're not sure what the comment content will be
* use {@link #printXMLComment(String, boolean)} instead, passing true for the second parameter.
*
* @param content the comment content
*/
public void printXMLComment(String content)
{
printXMLComment(content, false);
}
/**
* Print a XML comment.
*
* @param content the comment content
* @param escape indicate if comment content has to be escaped. XML content does not support -- and - (when it's the
* last character). Escaping is based on backslash. "- --\ -" give "- \-\-\\ \-\ ".
*/
public void printXMLComment(String content, boolean escape)
{
try {
this.xmlWriter.write(new DefaultComment(escape ? XMLUtils.escapeXMLComment(content) : content));
} catch (IOException e) {
// TODO: add error log here
}
}
/**
* Start a CDATA section.
*/
public void printXMLStartCData()
{
try {
this.xmlWriter.startCDATA();
// Ensure that characters inside CDATA sections are not escaped
this.xmlWriter.setEscapeText(false);
} catch (Exception e) {
// TODO: handle exception
}
}
/**
* End a CDATA section.
*/
public void printXMLEndCData()
{
try {
this.xmlWriter.setEscapeText(true);
this.xmlWriter.endCDATA();
} catch (Exception e) {
// TODO: handle exception
}
}
public void printEntity(String entity)
{
try {
this.xmlWriter.write(new DefaultEntity(entity, entity));
} catch (Exception e) {
// TODO: handle exception
}
}
/**
* Print some text without escaping anything, it's supposed to be XML or at least contains only valid characters in
* XML text node.
*
* @param row the content
*/
public void printRaw(String row)
{
try {
this.wikiWriter.write(row);
} catch (Exception e) {
// TODO: handle exception
}
}
/**
* Convert provided table into {@link Attributes} to use in xml writer.
*/
private Attributes createAttributes(String[][] parameters)
{
AttributesImpl attributes = new AttributesImpl();
if (parameters != null && parameters.length > 0) {
for (String[] entry : parameters) {
attributes.addAttribute(null, null, entry[0], null, entry[1]);
}
}
return attributes;
}
/**
* Convert provided map into {@link Attributes} to use in xml writer.
*/
private Attributes createAttributes(Map parameters)
{
AttributesImpl attributes = new AttributesImpl();
if (parameters != null && !parameters.isEmpty()) {
for (Map.Entry entry : parameters.entrySet()) {
String value = entry.getValue();
String key = entry.getKey();
if (key != null && value != null) {
attributes.addAttribute(null, null, key, null, value);
}
}
}
return attributes;
}
}