net.sf.saxon.serialize
Class XMLIndenter

java.lang.Object
  extended by net.sf.saxon.event.SequenceReceiver
      extended by net.sf.saxon.event.ProxyReceiver
          extended by net.sf.saxon.serialize.XMLIndenter
All Implemented Interfaces:
Result, Receiver
Direct Known Subclasses:
XMLIndenterPE

public class XMLIndenter
extends ProxyReceiver

XMLIndenter: This ProxyReceiver indents elements, by adding character data where appropriate. The character data is always added as "ignorable white space", that is, it is never added adjacent to existing character data.

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
XMLIndenter(XMLEmitter next)
          Create an XML Indenter
 
Method Summary
 void attribute(NodeName attName, SimpleType typeCode, CharSequence value, int locationId, int properties)
          Output an attribute
 void characters(CharSequence chars, int locationId, int properties)
          Output character data
 void comment(CharSequence chars, int locationId, int properties)
          Output a comment
 void endDocument()
          Notify the end of a document node
 void endElement()
          Output element end tag
protected  int getIndentation()
          Get the number of spaces to be used for indentation
protected  int getLineLength()
          Get the suggested maximum length of a line
protected  boolean isDoubleSpaced(NodeName name)
          Ask whether a particular element is to be double-spaced
 void namespace(NamespaceBinding namespaceBinding, int properties)
          Notify a namespace.
 void open()
          Start of document
 void processingInstruction(String target, CharSequence data, int locationId, int properties)
          Output a processing instruction
 void setOutputProperties(Properties props)
          Set the properties for this indenter
 void startContent()
          Notify the start of the content, that is, the completion of all attributes and namespaces.
 void startElement(NodeName nameCode, SchemaType type, int locationId, int properties)
          Output element start tag
 boolean usesTypeAnnotations()
          Ask whether this Receiver (or the downstream pipeline) makes any use of the type annotations supplied on element and attribute events
 
Methods inherited from class net.sf.saxon.event.ProxyReceiver
append, close, getNamePool, getUnderlyingReceiver, setPipelineConfiguration, setSystemId, setUnderlyingReceiver, setUnparsedEntity, startDocument
 
Methods inherited from class net.sf.saxon.event.SequenceReceiver
append, getConfiguration, getPipelineConfiguration, getSystemId
 
Methods inherited from class java.lang.Object
clone, equals, finalize, getClass, hashCode, notify, notifyAll, toString, wait, wait, wait
 

Constructor Detail

XMLIndenter

public XMLIndenter(XMLEmitter next)
Create an XML Indenter

Parameters:
next - the next receiver in the pipeline, always an XMLEmitter
Method Detail

setOutputProperties

public void setOutputProperties(Properties props)
Set the properties for this indenter

Parameters:
props - the serialization properties

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,
                         int locationId,
                         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 - integer code identifying the element's type within the name pool.
locationId - an integer which can be interpreted using a LocationProvider to return information such as line number and system ID. If no location information is available, the value zero is supplied.
properties - properties of the element node
Throws:
XPathException - if an error occurs

namespace

public void namespace(NamespaceBinding namespaceBinding,
                      int properties)
               throws XPathException
Description copied from class: ProxyReceiver
Notify a namespace. Namespaces are notified after the startElement event, and before any children for the element. The namespaces that are reported are only required to include those that are different from the parent element; however, duplicates may be reported. A namespace must not conflict with any namespaces already used for element or attribute names.

Specified by:
namespace in interface Receiver
Overrides:
namespace in class ProxyReceiver
Parameters:
namespaceBinding - the prefix/uri pair representing the namespace binding
properties - any special properties to be passed on this call
Throws:
XPathException - if an error occurs

attribute

public void attribute(NodeName attName,
                      SimpleType typeCode,
                      CharSequence value,
                      int locationId,
                      int properties)
               throws XPathException
Output an attribute

Specified by:
attribute in interface Receiver
Overrides:
attribute in class ProxyReceiver
Parameters:
attName - The name of the attribute, as held in the name pool
typeCode - The type of the attribute, as held in the name pool
value - the string value of the attribute
locationId - an integer which can be interpreted using a LocationProvider to return information such as line number and system ID. If no location information is available, the value zero is supplied.
properties - Bit significant value. The following bits are defined:
DISABLE_ESCAPING
Disable escaping for this attribute
NO_SPECIAL_CHARACTERS
Attribute value contains no special characters
Throws:
XPathException - if an error occurs

startContent

public void startContent()
                  throws XPathException
Description copied from class: ProxyReceiver
Notify the start of the content, that is, the completion of all attributes and namespaces. Note that the initial receiver of output from XSLT instructions will not receive this event, it has to detect it itself. Note that this event is reported for every element even if it has no attributes, no namespaces, and no content.

Specified by:
startContent in interface Receiver
Overrides:
startContent in class ProxyReceiver
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(String target,
                                  CharSequence data,
                                  int 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 - an integer which can be interpreted using a LocationProvider to return information such as line number and system ID. If no location information is available, the value zero is supplied.
properties - Additional information about the PI.
Throws:
XPathException - if an error occurs

characters

public void characters(CharSequence chars,
                       int locationId,
                       int properties)
                throws XPathException
Output character data

Specified by:
characters in interface Receiver
Overrides:
characters in class ProxyReceiver
Parameters:
chars - The characters
locationId - an integer which can be interpreted using a LocationProvider to return information such as line number and system ID. If no location information is available, the value zero is supplied.
properties - Bit significant value. The following bits are defined:
DISABLE_ESCAPING
Disable escaping for this text node
USE_CDATA
Output as a CDATA section
Throws:
XPathException - if an error occurs

comment

public void comment(CharSequence chars,
                    int 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 - an integer which can be interpreted using a LocationProvider to return information such as line number and system ID. If no location information is available, the value zero is supplied.
properties - Additional information about the comment.
Throws:
XPathException - if an error occurs

usesTypeAnnotations

public boolean usesTypeAnnotations()
Ask whether this Receiver (or the downstream pipeline) makes any use of the type annotations supplied on element and attribute events

Specified by:
usesTypeAnnotations in interface Receiver
Overrides:
usesTypeAnnotations in class ProxyReceiver
Returns:
true if the Receiver makes any use of this information. If false, the caller may supply untyped nodes instead of supplying the type annotation

endDocument

public void endDocument()
                 throws XPathException
Description copied from class: ProxyReceiver
Notify the end of a document node

Specified by:
endDocument in interface Receiver
Overrides:
endDocument in class ProxyReceiver
Throws:
XPathException - if an error occurs

getIndentation

protected int getIndentation()
Get the number of spaces to be used for indentation

Returns:
the number of spaces to be added to the indentation for each level

isDoubleSpaced

protected boolean isDoubleSpaced(NodeName name)
Ask whether a particular element is to be double-spaced

Parameters:
name - the element name
Returns:
true if double-spacing is in effect for this element

getLineLength

protected int getLineLength()
Get the suggested maximum length of a line

Returns:
the suggested maximum line length (used for wrapping attributes)


Copyright (c) 2004-2011 Saxonica Limited. All rights reserved.