Package net.sf.saxon.event
Class TeeOutputter
- java.lang.Object
-
- net.sf.saxon.event.SequenceReceiver
-
- net.sf.saxon.event.TeeOutputter
-
- All Implemented Interfaces:
javax.xml.transform.Result
,Receiver
public class TeeOutputter extends SequenceReceiver
TeeOutputter: a SequenceReceiver that duplicates received events to two different destinations
-
-
Field Summary
Fields Modifier and Type Field Description (package private) Receiver
seq1
(package private) Receiver
seq2
-
Fields inherited from class net.sf.saxon.event.SequenceReceiver
pipelineConfiguration, previousAtomic, systemId
-
-
Constructor Summary
Constructors Constructor Description TeeOutputter(Receiver seq1, Receiver seq2)
-
Method Summary
All Methods Instance Methods Concrete Methods Modifier and Type Method Description void
append(Item item, int locationId, int copyNamespaces)
Output an item (atomic value or node) to the sequencevoid
attribute(NodeName nameCode, SimpleType typeCode, java.lang.CharSequence value, int locationId, int properties)
Notify an attribute.void
characters(java.lang.CharSequence chars, int locationId, int properties)
Notify character data.void
close()
Notify the end of the event streamvoid
comment(java.lang.CharSequence content, int locationId, int properties)
Notify a comment.void
endDocument()
Notify the end of a document nodevoid
endElement()
Notify the end of an element.protected Receiver
getFirstDestination()
Get the first destinationprotected Receiver
getSecondDestination()
Get the second destinationvoid
namespace(NamespaceBinding namespaceBinding, int properties)
Notify a namespace.void
open()
Start the output processvoid
processingInstruction(java.lang.String name, java.lang.CharSequence data, int locationId, int properties)
Output a processing instructionprotected void
setFirstDestination(Receiver seq1)
Set the first destinationprotected void
setSecondDestination(Receiver seq2)
Set the second destinationvoid
startContent()
Notify the start of the content, that is, the completion of all attributes and namespaces.void
startDocument(int properties)
Notify the start of a document nodevoid
startElement(NodeName nameCode, SchemaType typeCode, int locationId, int properties)
Notify the start of an elementboolean
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.SequenceReceiver
append, getConfiguration, getNamePool, getPipelineConfiguration, getSystemId, setPipelineConfiguration, setSystemId, setUnparsedEntity
-
-
-
-
Method Detail
-
setFirstDestination
protected void setFirstDestination(Receiver seq1)
Set the first destination- Parameters:
seq1
- the first output destination
-
setSecondDestination
protected void setSecondDestination(Receiver seq2)
Set the second destination- Parameters:
seq2
- the second output destination
-
getFirstDestination
protected Receiver getFirstDestination()
Get the first destination- Returns:
- the first output destination
-
getSecondDestination
protected Receiver getSecondDestination()
Get the second destination- Returns:
- the second output destination
-
append
public void append(Item item, int locationId, int copyNamespaces) throws XPathException
Output an item (atomic value or node) to the sequence- Specified by:
append
in classSequenceReceiver
- Parameters:
item
- the item to be appendedlocationId
- the location of the calling instruction, for diagnosticscopyNamespaces
- if the item is an element node, this indicates whether its namespaces need to be copied. Values areNodeInfo.ALL_NAMESPACES
,NodeInfo.LOCAL_NAMESPACES
,NodeInfo.NO_NAMESPACES
- Throws:
XPathException
- if the operation fails
-
open
public void open() throws XPathException
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
public void startDocument(int properties) throws XPathException
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 classReceiverOptions
- Throws:
XPathException
- if an error occurs
-
endDocument
public void endDocument() throws XPathException
Notify the end of a document node- Throws:
XPathException
- if an error occurs
-
startElement
public void startElement(NodeName nameCode, SchemaType typeCode, int locationId, int properties) throws XPathException
Notify the start of an element- Parameters:
nameCode
- integer code identifying the name of the element within the name pool.typeCode
- integer code identifying the element's type within the name pool. The value -1 indicates the default type, xs:untyped.locationId
- 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 properties of the element node. If there are no revelant- Throws:
XPathException
- if an error occurs
-
namespace
public void namespace(NamespaceBinding namespaceBinding, int properties) throws XPathException
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.- Parameters:
namespaceBinding
- the prefix/uri pairproperties
- The most important property is REJECT_DUPLICATES. If this property is 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 nameCode, SimpleType typeCode, java.lang.CharSequence value, int locationId, int properties) throws XPathException
Notify an attribute. Attributes are notified after the startElement event, and before any children. Namespaces and attributes may be intermingled.- Parameters:
nameCode
- The name of the attribute, as held in the name pooltypeCode
- The type of the attribute, as held in the name poollocationId
- 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:- DISABLE_ESCAPING
- Disable escaping for this attribute
- NO_SPECIAL_CHARACTERS
- Attribute value contains no special characters
value
- the string value of the attribute- Throws:
XPathException
- if an error occurs
-
startContent
public void startContent() throws XPathException
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.- Throws:
XPathException
- if an error occurs
-
endElement
public void endElement() throws XPathException
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(java.lang.CharSequence chars, int 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:- 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, java.lang.CharSequence data, int 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:
XPathException
- if an error occurs
-
comment
public void comment(java.lang.CharSequence content, int 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:
XPathException
- if an error occurs
-
close
public void close() throws XPathException
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
-
-