Package net.sf.saxon.serialize
Class XMLIndenter
java.lang.Object
net.sf.saxon.event.SequenceReceiver
net.sf.saxon.event.ProxyReceiver
net.sf.saxon.serialize.XMLIndenter
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
FieldsFields 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 -
Method Summary
Modifier and TypeMethodDescriptionvoid
attribute
(NodeName attName, SimpleType typeCode, CharSequence value, int locationId, int properties) Output an attributevoid
characters
(CharSequence chars, int locationId, int properties) Output character datavoid
comment
(CharSequence chars, int locationId, int properties) Output a commentvoid
Notify the end of a document nodevoid
Output element end tagprotected int
Get the number of spaces to be used for indentationprotected int
Get the suggested maximum length of a lineprotected boolean
isDoubleSpaced
(NodeName name) Ask whether a particular element is to be double-spacedvoid
namespace
(NamespaceBinding namespaceBinding, int properties) Notify a namespace.void
open()
Start of documentvoid
processingInstruction
(String target, CharSequence data, int locationId, int properties) Output a processing instructionvoid
setOutputProperties
(Properties props) Set the properties for this indentervoid
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 tagboolean
Ask whether this Receiver (or the downstream pipeline) makes any use of the type annotations supplied on element and attribute eventsMethods 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
-
Field Details
-
totalAttributeLength
int totalAttributeLength
-
-
Constructor Details
-
XMLIndenter
Create an XML Indenter- Parameters:
next
- the next receiver in the pipeline, always an XMLEmitter
-
-
Method Details
-
setOutputProperties
Set the properties for this indenter- Parameters:
props
- the serialization properties
-
open
Start of document- Specified by:
open
in interfaceReceiver
- Overrides:
open
in classProxyReceiver
- 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 interfaceReceiver
- Overrides:
startElement
in classProxyReceiver
- 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 aLocationProvider
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
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 interfaceReceiver
- Overrides:
namespace
in classProxyReceiver
- Parameters:
namespaceBinding
- the prefix/uri pair representing the namespace bindingproperties
- 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 interfaceReceiver
- Overrides:
attribute
in classProxyReceiver
- Parameters:
attName
- The name of the attribute, as held in the name pooltypeCode
- The type of the attribute, as held in the name poolvalue
- the string value of the attributelocationId
- an integer which can be interpreted using aLocationProvider
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
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 interfaceReceiver
- Overrides:
startContent
in classProxyReceiver
- Throws:
XPathException
- if an error occurs
-
endElement
Output element end tag- Specified by:
endElement
in interfaceReceiver
- Overrides:
endElement
in classProxyReceiver
- 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 interfaceReceiver
- Overrides:
processingInstruction
in classProxyReceiver
- Parameters:
target
- The PI name. This must be a legal name (it will not be checked).data
- The data portion of the processing instructionlocationId
- an integer which can be interpreted using aLocationProvider
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
Output character data- Specified by:
characters
in interfaceReceiver
- Overrides:
characters
in classProxyReceiver
- Parameters:
chars
- The characterslocationId
- an integer which can be interpreted using aLocationProvider
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
Output a comment- Specified by:
comment
in interfaceReceiver
- Overrides:
comment
in classProxyReceiver
- Parameters:
chars
- The content of the commentlocationId
- an integer which can be interpreted using aLocationProvider
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 interfaceReceiver
- Overrides:
usesTypeAnnotations
in classProxyReceiver
- 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
Description copied from class:ProxyReceiver
Notify the end of a document node- Specified by:
endDocument
in interfaceReceiver
- Overrides:
endDocument
in classProxyReceiver
- 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
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)
-