com.saxonica.serialize

Class OuterNewlineInserter

java.lang.Object

net.sf.saxon.event.SequenceReceiver

net.sf.saxon.event.ProxyReceiver

com.saxonica.serialize.OuterNewlineInserter

All Implemented Interfaces:

javax.xml.transform.Result, Receiver

public class OuterNewlineInserter
extends ProxyReceiver

OuterNewlineInserter: This ProxyReceiver inserts a newline after any comment or PI child of the document node that precedes the first element child, and before any comment or PI child that follows the first element child. This action is currently invoked only when saxon:canonical=yes is requested, though it could in principle be made available as a free-standing option.

Author:

Michael Kay

Field Summary

Fields inherited from class net.sf.saxon.event.ProxyReceiver

nextReceiver

Fields inherited from class net.sf.saxon.event.SequenceReceiver

pipelineConfiguration, previousAtomic, systemId

Fields inherited from interface javax.xml.transform.Result

PI_DISABLE_OUTPUT_ESCAPING, PI_ENABLE_OUTPUT_ESCAPING

Constructor Summary

Constructors

Constructor and Description
OuterNewlineInserter(XMLEmitter next) Create an XML Indenter

Method Summary

Modifier and Type	Method and Description
void	comment(java.lang.CharSequence chars, Location locationId, int properties) Output a comment
void	endElement() Output element end tag
void	open() Start of document
void	processingInstruction(java.lang.String target, java.lang.CharSequence data, Location locationId, int properties) Output a processing instruction
void	startElement(NodeName nameCode, SchemaType type, Location location, int properties) Output element start tag

Methods inherited from class net.sf.saxon.event.ProxyReceiver

append, attribute, characters, close, endDocument, getNamePool, getNextReceiver, namespace, setPipelineConfiguration, setSystemId, setUnderlyingReceiver, setUnparsedEntity, startContent, startDocument, usesTypeAnnotations

Methods inherited from class net.sf.saxon.event.SequenceReceiver

append, decompose, flatten, getConfiguration, getErrorCodeForDecomposingFunctionItems, getPipelineConfiguration, getSystemId, handlesAppend

Methods inherited from class java.lang.Object

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

Constructor Detail

OuterNewlineInserter

public OuterNewlineInserter(XMLEmitter next)

Create an XML Indenter

Parameters:

next - the next receiver in the pipeline, always an XMLEmitter

Method Detail

open

public void open()
          throws XPathException

Start of document

Specified by:

open in interface Receiver

Overrides:

open in class ProxyReceiver

Throws:

XPathException - if an error occurs

startElement

public void startElement(NodeName nameCode,
                         SchemaType type,
                         Location location,
                         int properties)
                  throws XPathException

Output element start tag

Specified by:

startElement in interface Receiver

Overrides:

startElement in class ProxyReceiver

Parameters:

nameCode - integer code identifying the name of the element within the name pool.

type - the element's type annotation.

location - a location associated with the event (typically either a location in the source document or the stylesheet)

properties - properties of the element node

Throws:

XPathException - if an error occurs

endElement

public void endElement()
                throws XPathException

Output element end tag

Specified by:

endElement in interface Receiver

Overrides:

endElement in class ProxyReceiver

Throws:

XPathException - if an error occurs

processingInstruction

public void processingInstruction(java.lang.String target,
                                  java.lang.CharSequence data,
                                  Location locationId,
                                  int properties)
                           throws XPathException

Output a processing instruction

Specified by:

processingInstruction in interface Receiver

Overrides:

processingInstruction in class ProxyReceiver

Parameters:

target - The PI name. This must be a legal name (it will not be checked).

data - The data portion of the processing instruction

locationId - provides information such as line number and system ID.

properties - Additional information about the PI.

Throws:

XPathException - if an error occurs

comment

public void comment(java.lang.CharSequence chars,
                    Location locationId,
                    int properties)
             throws XPathException

Output a comment

Specified by:

comment in interface Receiver

Overrides:

comment in class ProxyReceiver

Parameters:

chars - The content of the comment

locationId - provides information such as line number and system ID.

properties - Additional information about the comment.

Throws:

XPathException - if an error occurs