Package eu.bandm.tools.util.xml

Class ContentPrinter

java.lang.Object

eu.bandm.tools.util.xml.DefaultContentHandler

eu.bandm.tools.util.xml.ContentPrinter

All Implemented Interfaces:

ContentHandler, LexicalHandler

public class ContentPrinter
extends DefaultContentHandler

Converts SAX events into textual representation, not supporting name spaces. Supports a subset of ContentHandler and LexicalHandler.
Can be parametrized w.r.t

• target of output (normally a PrintWriter or sim.
• encoding
• format of output (indenting, compressed, debug only)
• whether to include doctype and/or xmltype declaration

Character data is transformed, using the standard character entities "quot" "amp" "lt" "gt". ("apos" should not be used, for old html handlers.)
CData sections and disable output escaping are not supported.

The encoding name which appears in the XML output must have a form like "UTF-8", and "SHOULD be understood in a case-insensitive way." ([XML1.0], setion 4.3.3).
Similarly, the API doc for Charset says "Charset names are not case sensitive". In this module all instances of the Charset class are replaced by their "canonical name". To detect cases of UnsupportedEncodingException are left to the java runtime classes.

CHECK NOETIG !?!?!? Korrekte übersetzung nicht automatisch bei PrintWriter !?!?

Surrogate pairs are translated to Numeric character references, BUT ONLY IN CDATA/PCDATA, not in Element names, attribute names, pi targets, etc.
FIXME: currently PrintWriter is only needed for "println()".
This COULD be replaced by a Writer and »append("\n")«, PLUS an additional method to alter this explicitly!

Field Summary

Fields

Modifier and Type	Field	Description
protected int	attcol
protected boolean	beforeFirstElement
protected boolean	declareXml
protected @Opt XMLDocumentIdentifier	dtdDocId
protected int	indent
protected boolean	initialComment
protected int	maxwidth
static final String	NEW_ATTLINE_INDENT
static final int	NEW_ATTLINE_INDENT_LEN
protected boolean	noendtags	Only for compact debugging output: endtags are omitted and reflected by indentation only.
protected Set<NamespaceName>	noindent
protected boolean	openTagPending
protected PrintWriter	out
protected boolean	pretty
protected boolean	reindent
protected @Opt String	selectedEncoding
static final String	SURROGATE_ERROR_INDICATION
static final String	XML_VERSION

Constructor Summary

Constructors

Constructor	Description
ContentPrinter(OutputStream out, @Opt String selectedEncoding)	Deprecated, for removal: This API element is subject to removal in a future version. use ContentPrinter(java.io.OutputStream,java.nio.charset.Charset) instead
ContentPrinter(OutputStream out, @Opt String selectedEncoding, boolean pretty)	Deprecated, for removal: This API element is subject to removal in a future version. use ContentPrinter(java.io.OutputStream,java.nio.charset.Charset,boolean) instead
ContentPrinter(OutputStream out, @Opt String selectedEncoding, boolean pretty, boolean noend)	Creates a ContentPrinter which can omit all end tags.
ContentPrinter(OutputStream out, @Opt String selectedEncoding, Set<NamespaceName> noindent)	Creates a ContentPrinter which inserts indentation ONLY inside of elements which do not have mixed contents.
ContentPrinter(OutputStream out, Charset selectedEncoding)
ContentPrinter(OutputStream out, Charset selectedEncoding, boolean pretty)
ContentPrinter(OutputStream out, Charset selectedEncoding, boolean pretty, boolean noend)
ContentPrinter(OutputStream out, Charset selectedEncoding, Set<NamespaceName> noindent)
ContentPrinter(PrintWriter out)
ContentPrinter(PrintWriter out, boolean pretty)
ContentPrinter(PrintWriter out, boolean pretty, boolean noend)
ContentPrinter(PrintWriter out, Set<NamespaceName> noindent)	Creates a ContentPrinter which inserts indentation ONLY inside of elements which do not have mixed contents.

Method Summary

Modifier and Type	Method	Description
void	characters(char[] ch, int start, int length)
void	comment(char[] ch, int start, int length)	Print comment to output; assume no double dashes and no trailing dash are contained [XSLT 1.0:7.4] FIXME indentation, newline, etc.
void	comment(String s)
void	comment(String s, boolean linefeed)
protected void	doWrite(char[] ch, int start, int length, boolean inAtt, boolean replaceDoubleQuote)	Prints character data in text contents (ie.
(package private) void	doWriteErronuous_1(char c)
(package private) void	doWriteSurrogate(char c1, char c2)	Write the two java characters which form a "unicode surrogate pair" as one single "XML character entity", in hexadecimal format.
void	endDocument()
void	endElement(String namespaceURI, String localName, String qName)
void	endPrefixMapping(String prefix)
void	flush()
protected void	flushPending()	close the open tag of an element.
void	ignorableWhitespace(char[] ch, int start, int length)
protected void	indent()	Start a new line and advance to the column given by indent, the current identation depth, reflecting open and close element events.
protected void	printAtt(String name, String v)
void	processingInstruction(String target, String data)
ContentPrinter	setDeclareXml(boolean declareXml)	Whether an XML type declaration shall be printed at the start of the generated output.
ContentPrinter	setDtdDocId(XMLDocumentIdentifier dtdDocId)	The dtd adress of the doctype declaration which will be printed inserted in the generated output, iff !=null
ContentPrinter	setLineWidth(int maxwidth)
void	setPretty(boolean pretty)
void	skippedEntity(String name)
void	startDocument()	Prints the XML declaration.
void	startElement(String namespaceURI, String localName, String qName, Attributes atts)	Prints an open tag of the given element, with all given attributes.
void	startPrefixMapping(String prefix, String uri)

Methods inherited from class eu.bandm.tools.util.xml.DefaultContentHandler

endCDATA, endDTD, endEntity, setDocumentLocator, startCDATA, startDTD, startEntity

Methods inherited from class java.lang.Object

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

Methods inherited from interface org.xml.sax.ContentHandler

declaration

Field Details

out

protected PrintWriter out

pretty

protected boolean pretty

noendtags

protected boolean noendtags

Only for compact debugging output: endtags are omitted and reflected by indentation only.

noindent

protected Set<NamespaceName> noindent

selectedEncoding

@Opt
protected @Opt String selectedEncoding

declareXml

protected transient boolean declareXml

dtdDocId

@Opt
protected transient @Opt XMLDocumentIdentifier dtdDocId

maxwidth

protected transient int maxwidth

XML_VERSION

public static final String XML_VERSION

See Also:

• Constant Field Values

SURROGATE_ERROR_INDICATION

public static final String SURROGATE_ERROR_INDICATION

See Also:

• Constant Field Values

NEW_ATTLINE_INDENT

public static final String NEW_ATTLINE_INDENT

See Also:

• Constant Field Values

NEW_ATTLINE_INDENT_LEN

public static final int NEW_ATTLINE_INDENT_LEN

beforeFirstElement

protected transient boolean beforeFirstElement

initialComment

protected transient boolean initialComment

reindent

protected transient boolean reindent

indent

protected transient int indent

attcol

protected transient int attcol

openTagPending

protected transient boolean openTagPending

Constructor Details

ContentPrinter

@Deprecated(forRemoval=true)
public ContentPrinter(OutputStream out,
 @Opt
 @Opt String selectedEncoding)
               throws UnsupportedEncodingException

Deprecated, for removal: This API element is subject to removal in a future version.

use ContentPrinter(java.io.OutputStream,java.nio.charset.Charset) instead

Insert an encoder with the given encoding name between the output and the selected drain. If an XML declaration is selected by setDeclareXml(boolean), then the encoding name will be included. The XML type is currently fixed to "XML 1.0"

Throws:

UnsupportedEncodingException

ContentPrinter

public ContentPrinter(OutputStream out,
 Charset selectedEncoding)
               throws UnsupportedEncodingException

Throws:

UnsupportedEncodingException

ContentPrinter

@Deprecated(forRemoval=true)
public ContentPrinter(OutputStream out,
 @Opt
 @Opt String selectedEncoding,
 boolean pretty)
               throws UnsupportedEncodingException

Deprecated, for removal: This API element is subject to removal in a future version.

use ContentPrinter(java.io.OutputStream,java.nio.charset.Charset,boolean) instead

Parameters:

out - where to print the output to

selectedEncoding -

pretty - whether to insert indentations

Throws:

UnsupportedEncodingException

ContentPrinter

public ContentPrinter(OutputStream out,
 Charset selectedEncoding,
 boolean pretty)
               throws UnsupportedEncodingException

Throws:

UnsupportedEncodingException

ContentPrinter

public ContentPrinter(OutputStream out,
 @Opt
 @Opt String selectedEncoding,
 boolean pretty,
 boolean noend)
               throws UnsupportedEncodingException

Creates a ContentPrinter which can omit all end tags. This is useful only with pretty==true, as a more compact rendering for human readers, e.g. for debugging.

Parameters:

out - where to print the output to

selectedEncoding -

pretty - whether to insert indentations (always or-ed with "noend")

noend - whether to leave out the end tag

Throws:

UnsupportedEncodingException

ContentPrinter

public ContentPrinter(OutputStream out,
 Charset selectedEncoding,
 boolean pretty,
 boolean noend)
               throws UnsupportedEncodingException

Throws:

UnsupportedEncodingException

ContentPrinter

public ContentPrinter(OutputStream out,
 @Opt
 @Opt String selectedEncoding,
 Set<NamespaceName> noindent)
               throws UnsupportedEncodingException

Creates a ContentPrinter which inserts indentation ONLY inside of elements which do not have mixed contents. (In these, whitespace may have some significance.) The set of mixed contents elements is given by a set of NamespaceNames.

Parameters:

out - where to print the output to

selectedEncoding -

noindent - elements in which no identation may happen

Throws:

UnsupportedEncodingException

ContentPrinter

public ContentPrinter(OutputStream out,
 Charset selectedEncoding,
 Set<NamespaceName> noindent)
               throws UnsupportedEncodingException

Throws:

UnsupportedEncodingException

ContentPrinter

public ContentPrinter(PrintWriter out)

ContentPrinter

public ContentPrinter(PrintWriter out,
 boolean pretty)

ContentPrinter

public ContentPrinter(PrintWriter out,
 boolean pretty,
 boolean noend)

ContentPrinter

public ContentPrinter(PrintWriter out,
 Set<NamespaceName> noindent)

Creates a ContentPrinter which inserts indentation ONLY inside of elements which do not have mixed contents. (In these, whitespace may have some significance.) The set of mixed contents elements is given by a set of NamespaceNames.

Parameters:

out - where to print the output to

noindent - elements in which no identation may happen

Method Details

setPretty

public void setPretty(boolean pretty)

setDeclareXml

public ContentPrinter setDeclareXml(boolean declareXml)

Whether an XML type declaration shall be printed at the start of the generated output.

setDtdDocId

public ContentPrinter setDtdDocId(XMLDocumentIdentifier dtdDocId)

The dtd adress of the doctype declaration which will be printed inserted in the generated output, iff !=null

setLineWidth

public ContentPrinter setLineWidth(int maxwidth)

doWriteErronuous_1

void doWriteErronuous_1(char c)

doWriteSurrogate

void doWriteSurrogate(char c1,
 char c2)

Write the two java characters which form a "unicode surrogate pair" as one single "XML character entity", in hexadecimal format.

doWrite

protected void doWrite(char[] ch,
 int start,
 int length,
 boolean inAtt,
 boolean replaceDoubleQuote)

Prints character data in text contents (ie. cdata sax events) and attribute nodes.

Prints some characters as named character references, according to [XML 1.0:4.6]. (Not all these rules are sensible, see our whitepaper.)

Prints surrogate pairs as XML numeric character reference "&#x...;".

In attribute values, the newline character \n is replaced by the text of a character entity reference, namely "
", see the last paragraph in XSLT 1.0: 7.1.3

ATTENTION assume surrogate pairs are completely (=both chars) contained in the character range to print. In cases of errors with surrogate pairs, an error indicating text SURROGATE_ERROR_INDICATION is inserted in the output.

comment

public void comment(char[] ch,
 int start,
 int length)
             throws SAXException

Print comment to output; assume no double dashes and no trailing dash are contained [XSLT 1.0:7.4]
FIXME indentation, newline, etc.

Specified by:

comment in interface LexicalHandler

Overrides:

comment in class DefaultContentHandler

Throws:

SAXException

comment

public void comment(String s,
 boolean linefeed)
             throws SAXException

Throws:

SAXException

comment

public void comment(String s)
             throws SAXException

Throws:

SAXException

ignorableWhitespace

public void ignorableWhitespace(char[] ch,
 int start,
 int length)
                         throws SAXException

Description copied from class: DefaultContentHandler

Specified by:

ignorableWhitespace in interface ContentHandler

Overrides:

ignorableWhitespace in class DefaultContentHandler

Throws:

SAXException

characters

public void characters(char[] ch,
 int start,
 int length)

Description copied from class: DefaultContentHandler

Specified by:

characters in interface ContentHandler

Overrides:

characters in class DefaultContentHandler

endElement

public void endElement(String namespaceURI,
 String localName,
 String qName)

Description copied from class: DefaultContentHandler

Specified by:

endElement in interface ContentHandler

Overrides:

endElement in class DefaultContentHandler

processingInstruction

public void processingInstruction(String target,
 String data)

Description copied from class: DefaultContentHandler

Specified by:

processingInstruction in interface ContentHandler

Overrides:

processingInstruction in class DefaultContentHandler

skippedEntity

public void skippedEntity(String name)

Description copied from class: DefaultContentHandler

Specified by:

skippedEntity in interface ContentHandler

Overrides:

skippedEntity in class DefaultContentHandler

startDocument

public void startDocument()

Prints the XML declaration. This is "version='1.0'", and the encoding, if it is known here.

Specified by:

startDocument in interface ContentHandler

Overrides:

startDocument in class DefaultContentHandler

startElement

public void startElement(String namespaceURI,
 String localName,
 String qName,
 Attributes atts)

Prints an open tag of the given element, with all given attributes. If this is the very first call, then the document type definition is printed first. This cannot be done earlier and independently, because the topmost element name must be (redundantly) named therein.

Specified by:

startElement in interface ContentHandler

Overrides:

startElement in class DefaultContentHandler

printAtt

protected void printAtt(String name,
 String v)

startPrefixMapping

public void startPrefixMapping(String prefix,
 String uri)

Description copied from class: DefaultContentHandler

Specified by:

startPrefixMapping in interface ContentHandler

Overrides:

startPrefixMapping in class DefaultContentHandler

endPrefixMapping

public void endPrefixMapping(String prefix)

Description copied from class: DefaultContentHandler

Specified by:

endPrefixMapping in interface ContentHandler

Overrides:

endPrefixMapping in class DefaultContentHandler

flushPending

protected void flushPending()

close the open tag of an element. (is kept open for the case that the end tag arrives without intervening contents, and an empty tag can be created instead.

flush

public void flush()

endDocument

public void endDocument()

Description copied from class: DefaultContentHandler

Specified by:

endDocument in interface ContentHandler

Overrides:

endDocument in class DefaultContentHandler

indent

protected void indent()

Start a new line and advance to the column given by indent, the current identation depth, reflecting open and close element events. reindent is cleared. (If pretty==false, no output is generated.)