Class PrincipalOutputGatekeeper
If actual output is produced to the principal result destination, then this PrincipalOutputGatekeeper
will be marked as being "used by primary", which will cause any attempt to open a secondary result destination on the
same URI (either explicitly, or by omitting the href
attribute, or by setting href
to
a zero length string) as an error. Apart from this marker, the PrincipalOutputGatekeeper
acts as
a pass-through filter for the output events.
If a secondary result destination is opened using the principal output URI (either explicitly or implicitly),
then the PrincipalOutputGatekeeper
is marked as being "used by secondary", which will cause any
attempts to write events to the PrincipalOutputGatekeeper
to fail. Secondary result output is not
actually directed through the gatekeeper; the gatekeeper is merely notified of its existence.
-
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
Constructors -
Method Summary
Modifier and TypeMethodDescriptionvoid
Append an arbitrary item (node or atomic value) to the outputvoid
characters
(UnicodeString chars, Location locationId, int properties) Character datavoid
close()
End of output.void
comment
(UnicodeString chars, Location locationId, int properties) Output a commentmakeReceiver
(SerializationProperties params) void
open()
Start of event streamvoid
processingInstruction
(String target, UnicodeString data, Location locationId, int properties) Processing Instructionvoid
startDocument
(int properties) Start of a document node.void
startElement
(NodeName elemName, SchemaType type, AttributeMap attributes, NamespaceMap namespaces, Location location, int properties) Notify the start of an elementvoid
Methods inherited from class net.sf.saxon.event.ProxyReceiver
endDocument, endElement, getNamePool, getNextReceiver, setPipelineConfiguration, setSystemId, setUnderlyingReceiver, setUnparsedEntity, usesTypeAnnotations
Methods inherited from class net.sf.saxon.event.SequenceReceiver
append, decompose, flatten, getConfiguration, getErrorCodeForDecomposingFunctionItems, getPipelineConfiguration, getSystemId, handlesAppend
-
Constructor Details
-
PrincipalOutputGatekeeper
-
-
Method Details
-
open
Description copied from class:ProxyReceiver
Start of event stream- Specified by:
open
in interfaceReceiver
- Overrides:
open
in classProxyReceiver
- Throws:
XPathException
- if an error occurs
-
startDocument
Description copied from class:ProxyReceiver
Start of a document node.- Specified by:
startDocument
in interfaceReceiver
- Overrides:
startDocument
in classProxyReceiver
- 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
-
startElement
public void startElement(NodeName elemName, SchemaType type, AttributeMap attributes, NamespaceMap namespaces, Location location, int properties) throws XPathException Description copied from class:ProxyReceiver
Notify the start of an element- Specified by:
startElement
in interfaceReceiver
- Overrides:
startElement
in classProxyReceiver
- 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
-
characters
public void characters(UnicodeString chars, Location locationId, int properties) throws XPathException Description copied from class:ProxyReceiver
Character data- Specified by:
characters
in interfaceReceiver
- Overrides:
characters
in classProxyReceiver
- Parameters:
chars
- The characterslocationId
- 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(String target, UnicodeString data, Location locationId, int properties) throws XPathException Description copied from class:ProxyReceiver
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
- provides information such as line number and system ID.properties
- Additional information about the PI.- Throws:
XPathException
- if an error occurs
-
comment
Description copied from class:ProxyReceiver
Output a comment- Specified by:
comment
in interfaceReceiver
- Overrides:
comment
in classProxyReceiver
- Parameters:
chars
- The content of the commentlocationId
- provides information such as line number and system ID.properties
- Additional information about the comment.- Throws:
XPathException
- if an error occurs
-
append
Description copied from class:ProxyReceiver
Append an arbitrary item (node or atomic value) to the output- Specified by:
append
in interfaceReceiver
- Overrides:
append
in classProxyReceiver
- 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 areReceiverOption.ALL_NAMESPACES
; the default (0) means- Throws:
XPathException
- if an error occurs
-
useAsSecondary
- Throws:
XPathException
-
makeReceiver
-
close
Description copied from class:ProxyReceiver
End of output. Note that closing this receiver also closes the rest of the pipeline.- Specified by:
close
in interfaceReceiver
- Overrides:
close
in classProxyReceiver
- Throws:
XPathException
- if an error occurs
-