eu.bandm.tools.util

Class ContentPrinter

java.lang.Object

eu.bandm.tools.util.DefaultContentHandler

eu.bandm.tools.util.ContentPrinter

All Implemented Interfaces:

org.xml.sax.ContentHandler

public class ContentPrinter
extends DefaultContentHandler

Converts SAX events into textual representation, not supporting name spaces.

Can be parametrized w.r.t

• target of output (normally a PrintStream 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 "apos" "quot" "amp" "lt" "gt". This escaping can be disabled for certain regions via pi-s, see PI_ENABLE_OUTPUT_ESCAPING and PI_DISABLE_OUTPUT_ESCAPING.
Elements with content model #PCDATA can be declared to be written out as CDATA-section, which is necessary sometimes for queer interpretation of XML by some xhtml browsers !?!? THIS feature is namespaceName-controlled THUS DIFFERS from the Rest !?!?!
SO the sax-events must be REDUNDANT: namespaceURI and localname PLUS qname !!!

Field Summary

Fields

Modifier and Type	Field and Description
protected int	attcol
protected java.util.Set<NamespaceName>	cdata_elements
protected boolean	declareDoctype
protected boolean	elementPending
protected boolean	in_cdata
protected int	indent
protected org.xml.sax.Locator	locator
static int	maxwidth
static java.lang.String	newAttLineIndent
static int	newAttLineIndentLen
protected boolean	noCharEscape
protected boolean	noendtags
protected java.io.PrintWriter	out
protected boolean	pretty
protected boolean	reindent
protected java.lang.String	selectedEncoding
static java.lang.String	xml_version

Constructor Summary

Constructors

Constructor and Description
ContentPrinter(java.io.OutputStream out, java.lang.String selectedEncoding) Insert an enconder with the given encoding name between the output and the selected drain.
ContentPrinter(java.io.OutputStream out, java.lang.String selectedEncoding, boolean pretty)
ContentPrinter(java.io.OutputStream out, java.lang.String selectedEncoding, boolean pretty, boolean noend) Creates a ContentPrinter which can omit all end tags.
ContentPrinter(java.io.PrintStream out) Deprecated. Use constructor with PrintWriter instead, for selecting the ecoding explicitly.
ContentPrinter(java.io.PrintStream out, boolean pretty) Deprecated. Use constructor with PrintWriter instead, for selecting the ecoding explicitly.
ContentPrinter(java.io.PrintStream out, boolean pretty, boolean noend) Deprecated. Use constructor with PrintWriter instead, for selecting the ecoding explicitly.
ContentPrinter(java.io.PrintWriter out)
ContentPrinter(java.io.PrintWriter out, boolean pretty)
ContentPrinter(java.io.PrintWriter out, boolean pretty, boolean noend)

Method Summary

Methods

Modifier and Type	Method and Description
void	add_cdata_tag(NamespaceName tag) ATTENTION only elements with content model (#PCDATA) are allowed! The tag must be calculated IN SYNC with any namespace embedder in the pipeline! Leads to starting a "<![CDATA[" area, and raises exception if an "open element" is found inside (for nesting we would need a STACK, which is not maintained in the current code!)
void	characters(char[] ch, int start, int length)
void	endDocument()
void	endElement(java.lang.String namespaceURI, java.lang.String localName, java.lang.String qName)
void	endPrefixMapping(java.lang.String prefix)
void	flush()
protected void	indent()
protected void	printAtt(java.lang.String s)
void	processingInstruction(java.lang.String target, java.lang.String data)
static java.lang.String	quoteAttributeValue(java.lang.String v) Cf.
void	setDeclareDoctype(boolean declareDoctype) Whether a doctype declaration shall be inserted in the generated output.
void	setDocumentLocator(org.xml.sax.Locator locator)
void	skippedEntity(java.lang.String name)
void	startDocument()
void	startElement(java.lang.String namespaceURI, java.lang.String localName, java.lang.String qName, org.xml.sax.Attributes atts)
void	startPrefixMapping(java.lang.String prefix, java.lang.String uri)

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

ignorableWhitespace

Methods inherited from class java.lang.Object

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

Field Detail

xml_version

public static final java.lang.String xml_version

See Also:

Constant Field Values

out

protected java.io.PrintWriter out

pretty

protected boolean pretty

noendtags

protected boolean noendtags

noCharEscape

protected boolean noCharEscape

reindent

protected transient boolean reindent

indent

protected transient int indent

attcol

protected transient int attcol

newAttLineIndent

public static final java.lang.String newAttLineIndent

See Also:

Constant Field Values

newAttLineIndentLen

public static final int newAttLineIndentLen

maxwidth

public static final int maxwidth

See Also:

Constant Field Values

elementPending

protected transient boolean elementPending

declareDoctype

protected transient boolean declareDoctype

in_cdata

protected transient boolean in_cdata

cdata_elements

protected java.util.Set<NamespaceName> cdata_elements

locator

protected org.xml.sax.Locator locator

selectedEncoding

protected java.lang.String selectedEncoding

Constructor Detail

ContentPrinter

@Deprecated
public ContentPrinter(java.io.PrintStream out)

Deprecated. Use constructor with PrintWriter instead, for selecting the ecoding explicitly.

ContentPrinter

@Deprecated
public ContentPrinter(java.io.PrintStream out,
                         boolean pretty)

Deprecated. Use constructor with PrintWriter instead, for selecting the ecoding explicitly.

ContentPrinter

@Deprecated
public ContentPrinter(java.io.PrintStream out,
                         boolean pretty,
                         boolean noend)

Deprecated. Use constructor with PrintWriter instead, for selecting the ecoding explicitly.

ContentPrinter

public ContentPrinter(java.io.OutputStream out,
              java.lang.String selectedEncoding)
               throws java.io.UnsupportedEncodingException

Insert an enconder with the given encoding name between the output and the selected drain. Causes an XML declaration with a document type declaration. The XML type is currently fixed to "XML 1.0"

Throws:

java.io.UnsupportedEncodingException

ContentPrinter

public ContentPrinter(java.io.OutputStream out,
              java.lang.String selectedEncoding,
              boolean pretty)
               throws java.io.UnsupportedEncodingException

Parameters:

out - where to print the output to

selectedEncoding -

pretty - whether to insert indentations

Throws:

java.io.UnsupportedEncodingException

ContentPrinter

public ContentPrinter(java.io.OutputStream out,
              java.lang.String selectedEncoding,
              boolean pretty,
              boolean noend)
               throws java.io.UnsupportedEncodingException

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

Parameters:

out - where to print the output to

selectedEncoding -

pretty - whether to insert indentations

noend - whether to leave out the end tag

Throws:

java.io.UnsupportedEncodingException

ContentPrinter

public ContentPrinter(java.io.PrintWriter out)

ContentPrinter

public ContentPrinter(java.io.PrintWriter out,
              boolean pretty)

ContentPrinter

public ContentPrinter(java.io.PrintWriter out,
              boolean pretty,
              boolean noend)

Method Detail

setDeclareDoctype

public void setDeclareDoctype(boolean declareDoctype)

Whether a doctype declaration shall be inserted in the generated output.

add_cdata_tag

public void add_cdata_tag(NamespaceName tag)

ATTENTION only elements with content model (#PCDATA) are allowed! The tag must be calculated IN SYNC with any namespace embedder in the pipeline! Leads to starting a "<![CDATA[" area, and raises exception if an "open element" is found inside (for nesting we would need a STACK, which is not maintained in the current code!)

quoteAttributeValue

public static java.lang.String quoteAttributeValue(java.lang.String v)

Cf. Format.quoteDTDstyle(Format)

characters

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

Specified by:

characters in interface org.xml.sax.ContentHandler

Overrides:

characters in class DefaultContentHandler

endElement

public void endElement(java.lang.String namespaceURI,
              java.lang.String localName,
              java.lang.String qName)

Specified by:

endElement in interface org.xml.sax.ContentHandler

Overrides:

endElement in class DefaultContentHandler

processingInstruction

public void processingInstruction(java.lang.String target,
                         java.lang.String data)

Specified by:

processingInstruction in interface org.xml.sax.ContentHandler

Overrides:

processingInstruction in class DefaultContentHandler

setDocumentLocator

public void setDocumentLocator(org.xml.sax.Locator locator)

Specified by:

setDocumentLocator in interface org.xml.sax.ContentHandler

Overrides:

setDocumentLocator in class DefaultContentHandler

skippedEntity

public void skippedEntity(java.lang.String name)

Specified by:

skippedEntity in interface org.xml.sax.ContentHandler

Overrides:

skippedEntity in class DefaultContentHandler

startDocument

public void startDocument()

Specified by:

startDocument in interface org.xml.sax.ContentHandler

Overrides:

startDocument in class DefaultContentHandler

startElement

public void startElement(java.lang.String namespaceURI,
                java.lang.String localName,
                java.lang.String qName,
                org.xml.sax.Attributes atts)

Specified by:

startElement in interface org.xml.sax.ContentHandler

Overrides:

startElement in class DefaultContentHandler

printAtt

protected void printAtt(java.lang.String s)

startPrefixMapping

public void startPrefixMapping(java.lang.String prefix,
                      java.lang.String uri)

Specified by:

startPrefixMapping in interface org.xml.sax.ContentHandler

Overrides:

startPrefixMapping in class DefaultContentHandler

endPrefixMapping

public void endPrefixMapping(java.lang.String prefix)

Specified by:

endPrefixMapping in interface org.xml.sax.ContentHandler

Overrides:

endPrefixMapping in class DefaultContentHandler

flush

public void flush()

endDocument

public void endDocument()

Specified by:

endDocument in interface org.xml.sax.ContentHandler

Overrides:

endDocument in class DefaultContentHandler

indent

protected void indent()