Package net.sf.saxon.event
Class SinkOutputter
- java.lang.Object
-
- net.sf.saxon.event.Outputter
-
- net.sf.saxon.event.SinkOutputter
-
-
Field Summary
-
Fields inherited from class net.sf.saxon.event.Outputter
pipelineConfiguration, systemId
-
-
Constructor Summary
Constructors Constructor Description SinkOutputter()
-
Method Summary
All Methods Instance Methods Concrete Methods Modifier and Type Method Description void
attribute(NodeName attName, SimpleType typeCode, java.lang.String value, Location location, int properties)
Notify an attribute.void
characters(UnicodeString chars, Location location, int properties)
Notify character data.void
comment(UnicodeString content, Location location, int properties)
Notify a comment.void
endDocument()
Notify the end of a document nodevoid
endElement()
Notify the end of an element.void
namespace(java.lang.String prefix, NamespaceUri namespaceUri, int properties)
Notify a namespace binding.void
processingInstruction(java.lang.String name, UnicodeString data, Location location, int properties)
Output a processing instructionvoid
startDocument(int properties)
Notify the start of a document nodevoid
startElement(NodeName elemName, SchemaType typeCode, Location location, int properties)
Notify the start of an element.-
Methods inherited from class net.sf.saxon.event.Outputter
append, append, close, getConfiguration, getPipelineConfiguration, getStringReceiver, getSystemId, namespaces, open, setPipelineConfiguration, setSystemId, setUnparsedEntity, startContent, startElement, usesTypeAnnotations
-
Methods inherited from class java.lang.Object
clone, equals, finalize, getClass, hashCode, notify, notifyAll, toString, wait, wait, wait
-
Methods inherited from interface net.sf.saxon.event.Receiver
handlesAppend
-
-
-
-
Method Detail
-
startDocument
public void startDocument(int properties) throws XPathException
Description copied from class:Outputter
Notify the start of a document node- Specified by:
startDocument
in interfaceReceiver
- Specified by:
startDocument
in classOutputter
- Parameters:
properties
- bit-significant integer indicating properties of the document node. The definitions of the bits are in classReceiverOption
- Throws:
XPathException
- if an error occurs
-
endDocument
public void endDocument() throws XPathException
Description copied from class:Outputter
Notify the end of a document node- Specified by:
endDocument
in interfaceReceiver
- Specified by:
endDocument
in classOutputter
- Throws:
XPathException
- if an error occurs
-
startElement
public void startElement(NodeName elemName, SchemaType typeCode, Location location, int properties) throws XPathException
Description copied from class:Outputter
Notify the start of an element. This version ofstartElement()
must be followed by calls onOutputter.attribute(NodeName, SimpleType, String, Location, int)
andOutputter.namespace(String, NamespaceUri, int)
to supply the attributes and namespaces; these calls may be terminated by a call onOutputter.startContent()
but this is not mandatory.- Specified by:
startElement
in classOutputter
- Parameters:
elemName
- the name of the element.typeCode
- the type annotation of the element.location
- an object providing information about the module, line, and column where the node originatedproperties
- bit-significant properties of the element node. If there are no relevant properties, zero is supplied. The definitions of the bits are in classReceiverOption
- Throws:
XPathException
- if an error occurs
-
namespace
public void namespace(java.lang.String prefix, NamespaceUri namespaceUri, int properties) throws XPathException
Description copied from class:Outputter
Notify a namespace binding. This method is called at some point after startElement(). The semantics are similar to the xsl:namespace instruction in XSLT, or the namespace node constructor in XQuery. A namespace must not conflict with any namespaces already used for element or attribute names.- Specified by:
namespace
in classOutputter
- Parameters:
prefix
- The namespace prefix; zero-length string for the default namespacenamespaceUri
- The namespace URI. In some cases a zero-length string may be used to indicate a namespace undeclaration.properties
- The REJECT_DUPLICATES property: if set, the namespace declaration will be rejected if it conflicts with a previous declaration of the same prefix. If the property is not set, the namespace declaration will be ignored if it conflicts with a previous declaration. This reflects the fact that when copying a tree, namespaces for child elements are emitted before the namespaces of their parent element. Unfortunately this conflicts with the XSLT rule for complex content construction, where the recovery action in the event of conflicts is to take the namespace that comes last. XSLT therefore doesn't recover from this error:- Throws:
XPathException
- if an error occurs
-
attribute
public void attribute(NodeName attName, SimpleType typeCode, java.lang.String value, Location location, int properties) throws XPathException
Description copied from class:Outputter
Notify an attribute. Attributes are notified after the startElement event, and before any children. Namespaces and attributes may be intermingled.- Specified by:
attribute
in classOutputter
- Parameters:
attName
- The name of the attributetypeCode
- The type annotation of the attributevalue
- the string value of the attributelocation
- provides information such as line number and system ID.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
-
endElement
public void endElement() throws XPathException
Description copied from class:Outputter
Notify the end of an element. The Outputter must maintain a stack if it needs to know which element is ending.- Specified by:
endElement
in interfaceReceiver
- Specified by:
endElement
in classOutputter
- Throws:
XPathException
- if an error occurs
-
characters
public void characters(UnicodeString chars, Location location, int properties) throws XPathException
Description copied from class:Outputter
Notify character data. Note that some receivers may require the character data to be sent in a single event, but in general this is not a requirement.- Specified by:
characters
in interfaceReceiver
- Specified by:
characters
in classOutputter
- Parameters:
chars
- The characterslocation
- provides information such as line number and system ID.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
-
processingInstruction
public void processingInstruction(java.lang.String name, UnicodeString data, Location location, int properties) throws XPathException
Description copied from class:Outputter
Output a processing instruction- Specified by:
processingInstruction
in interfaceReceiver
- Specified by:
processingInstruction
in classOutputter
- Parameters:
name
- The PI name. This must be a legal name (it will not be checked).data
- The data portion of the processing instructionlocation
- 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(UnicodeString content, Location location, int properties) throws XPathException
Description copied from class:Outputter
Notify a comment. Comments are only notified if they are outside the DTD.- Specified by:
comment
in interfaceReceiver
- Specified by:
comment
in classOutputter
- Parameters:
content
- The content of the commentlocation
- provides information such as line number and system ID.properties
- Additional information about the comment.- Throws:
XPathException
- if an error occurs
-
-