Package net.sf.saxon.event
Class TeeOutputter
java.lang.Object
net.sf.saxon.event.SequenceReceiver
net.sf.saxon.event.TeeOutputter
- Direct Known Subclasses:
AssertionTreeBuilder
TeeOutputter: a SequenceReceiver that duplicates received events to two different destinations
-
Field Summary
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
Output an item (atomic value or node) to the sequencevoid
characters
(UnicodeString chars, Location locationId, int properties) Notify character data.void
close()
Notify the end of the event streamvoid
comment
(UnicodeString content, Location locationId, int properties) Notify a comment.void
Notify the end of a document nodevoid
Notify the end of an element.protected Receiver
Get the first destinationprotected Receiver
Get the second destinationvoid
open()
Start the output processvoid
processingInstruction
(String name, UnicodeString data, Location locationId, int properties) Output a processing instructionprotected void
setFirstDestination
(Receiver seq1) Set the first destinationprotected void
setSecondDestination
(Receiver seq2) Set the second destinationvoid
setUnparsedEntity
(String name, String systemID, String publicID) Pass on information about unparsed entitiesvoid
startDocument
(int properties) Notify the start of a document nodevoid
startElement
(NodeName elemName, SchemaType type, AttributeMap attributes, NamespaceMap namespaces, Location location, int properties) Notify the start of an elementboolean
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.SequenceReceiver
append, decompose, flatten, getConfiguration, getErrorCodeForDecomposingFunctionItems, getNamePool, getPipelineConfiguration, getSystemId, handlesAppend, setPipelineConfiguration, setSystemId
-
Constructor Details
-
TeeOutputter
-
-
Method Details
-
setFirstDestination
Set the first destination- Parameters:
seq1
- the first output destination
-
setSecondDestination
Set the second destination- Parameters:
seq2
- the second output destination
-
getFirstDestination
Get the first destination- Returns:
- the first output destination
-
getSecondDestination
Get the second destination- Returns:
- the second output destination
-
setUnparsedEntity
Pass on information about unparsed entities- Specified by:
setUnparsedEntity
in interfaceReceiver
- Overrides:
setUnparsedEntity
in classSequenceReceiver
- Parameters:
name
- The name of the unparsed entitysystemID
- The system identifier of the unparsed entitypublicID
- The public identifier of the unparsed entity- Throws:
XPathException
- in the event of an error
-
append
Output an item (atomic value or node) to the sequence- Specified by:
append
in interfaceReceiver
- Specified by:
append
in classSequenceReceiver
- Parameters:
item
- the item to be appendedlocationId
- the location of the calling instruction, for diagnosticsproperties
- if the item is an element node, this indicates whether its namespaces need to be copied. Values areReceiverOption.ALL_NAMESPACES
; the default (0) means- Throws:
XPathException
- if an error occurs
-
open
Description copied from class:SequenceReceiver
Start the output process- Specified by:
open
in interfaceReceiver
- Overrides:
open
in classSequenceReceiver
- Throws:
XPathException
- if an error occurs
-
startDocument
Notify the start of a document node- 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
Notify the end of a document node- Throws:
XPathException
- if an error occurs
-
startElement
public void startElement(NodeName elemName, SchemaType type, AttributeMap attributes, NamespaceMap namespaces, Location location, int properties) throws XPathException Notify the start of an element- Parameters:
elemName
- the name of the element.type
- the type annotation of the element.attributes
- the attributes of this elementnamespaces
- the in-scope namespaces of this element: generally this is all the in-scope namespaces, without relying on inheriting namespaces from parent elementslocation
- 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
-
endElement
Notify the end of an element. The receiver must maintain a stack if it needs to know which element is ending.- Throws:
XPathException
- if an error occurs
-
characters
public void characters(UnicodeString chars, Location locationId, int properties) throws XPathException 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.- Parameters:
chars
- The characterslocationId
- an integer which can be interpreted using a LocationMap 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:- Throws:
XPathException
- if an error occurs
-
processingInstruction
public void processingInstruction(String name, UnicodeString data, Location locationId, int properties) throws XPathException Output a processing instruction- Parameters:
name
- 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 LocationMap 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. The following bits are defined:- CHECKED
- Data is known to be legal (e.g. doesn't contain "?>")
- Throws:
IllegalArgumentException
- the content is invalid for an XML processing instructionXPathException
- if an error occurs
-
comment
public void comment(UnicodeString content, Location locationId, int properties) throws XPathException Notify a comment. Comments are only notified if they are outside the DTD.- Parameters:
content
- The content of the commentlocationId
- an integer which can be interpreted using a LocationMap 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. The following bits are defined:- CHECKED
- Comment is known to be legal (e.g. doesn't contain "--")
- Throws:
IllegalArgumentException
- the content is invalid for an XML commentXPathException
- if an error occurs
-
close
Notify the end of the event stream- 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- 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
-