|
|||||||||
PREV CLASS NEXT CLASS | FRAMES NO FRAMES | ||||||||
SUMMARY: NESTED | FIELD | CONSTR | METHOD | DETAIL: FIELD | CONSTR | METHOD |
java.lang.Object net.sf.saxon.event.SequenceReceiver net.sf.saxon.event.ProxyReceiver net.sf.saxon.serialize.XMLIndenter
public class 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.
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 |
---|
public XMLIndenter(XMLEmitter next)
next
- the next receiver in the pipeline, always an XMLEmitterMethod Detail |
---|
public void setOutputProperties(Properties props)
props
- the serialization propertiespublic void open() throws XPathException
open
in interface Receiver
open
in class ProxyReceiver
XPathException
- if an error occurspublic void startElement(NodeName nameCode, SchemaType type, int locationId, int properties) throws XPathException
startElement
in interface Receiver
startElement
in class ProxyReceiver
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
XPathException
- if an error occurspublic void namespace(NamespaceBinding namespaceBinding, int properties) throws XPathException
ProxyReceiver
namespace
in interface Receiver
namespace
in class ProxyReceiver
namespaceBinding
- the prefix/uri pair representing the namespace bindingproperties
- any special properties to be passed on this call
XPathException
- if an error occurspublic void attribute(NodeName attName, SimpleType typeCode, CharSequence value, int locationId, int properties) throws XPathException
attribute
in interface Receiver
attribute
in class ProxyReceiver
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 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:
XPathException
- if an error occurspublic void startContent() throws XPathException
ProxyReceiver
startContent
in interface Receiver
startContent
in class ProxyReceiver
XPathException
- if an error occurspublic void endElement() throws XPathException
endElement
in interface Receiver
endElement
in class ProxyReceiver
XPathException
- if an error occurspublic void processingInstruction(String target, CharSequence data, int locationId, int properties) throws XPathException
processingInstruction
in interface Receiver
processingInstruction
in class ProxyReceiver
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 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.
XPathException
- if an error occurspublic void characters(CharSequence chars, int locationId, int properties) throws XPathException
characters
in interface Receiver
characters
in class ProxyReceiver
chars
- The characterslocationId
- 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:
XPathException
- if an error occurspublic void comment(CharSequence chars, int locationId, int properties) throws XPathException
comment
in interface Receiver
comment
in class ProxyReceiver
chars
- The content of the commentlocationId
- 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.
XPathException
- if an error occurspublic boolean usesTypeAnnotations()
usesTypeAnnotations
in interface Receiver
usesTypeAnnotations
in class ProxyReceiver
public void endDocument() throws XPathException
ProxyReceiver
endDocument
in interface Receiver
endDocument
in class ProxyReceiver
XPathException
- if an error occursprotected int getIndentation()
protected boolean isDoubleSpaced(NodeName name)
name
- the element name
protected int getLineLength()
|
|||||||||
PREV CLASS NEXT CLASS | FRAMES NO FRAMES | ||||||||
SUMMARY: NESTED | FIELD | CONSTR | METHOD | DETAIL: FIELD | CONSTR | METHOD |