Class PrincipalOutputGatekeeper
- java.lang.Object
-
- net.sf.saxon.event.SequenceReceiver
-
- net.sf.saxon.event.ProxyReceiver
-
- net.sf.saxon.serialize.PrincipalOutputGatekeeper
-
- All Implemented Interfaces:
javax.xml.transform.Result,Receiver
public class PrincipalOutputGatekeeper extends ProxyReceiver
This class is added to the output pipeline for the principal result destination for a transformation if the transformation uses xsl:result-document instructions. It is there to deal with the possibility that an xsl:result-document instruction will use the same output URI (or no output URI) in which case it is defined to write to the principal output destination, but potentially with different serialization parameters.If actual output is produced to the principal result destination, then this
PrincipalOutputGatekeeperwill 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 thehrefattribute, or by settinghrefto a zero length string) as an error. Apart from this marker, thePrincipalOutputGatekeeperacts 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
PrincipalOutputGatekeeperis marked as being "used by secondary", which will cause any attempts to write events to thePrincipalOutputGatekeeperto 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
-
-
Constructor Summary
Constructors Constructor Description PrincipalOutputGatekeeper(XsltController controller, Receiver next)
-
Method Summary
All Methods Instance Methods Concrete Methods Modifier and Type Method Description voidappend(Item item, Location locationId, int copyNamespaces)Append an arbitrary item (node or atomic value) to the outputvoidcharacters(java.lang.CharSequence chars, Location locationId, int properties)Character datavoidclose()End of output.voidcomment(java.lang.CharSequence chars, Location locationId, int properties)Output a commentReceivermakeReceiver(SerializationProperties params)voidopen()Start of event streamvoidprocessingInstruction(java.lang.String target, java.lang.CharSequence data, Location locationId, int properties)Processing InstructionvoidstartDocument(int properties)Start of a document node.voidstartElement(NodeName elemName, SchemaType type, AttributeMap attributes, NamespaceMap namespaces, Location location, int properties)Notify the start of an elementvoiduseAsSecondary()-
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 Detail
-
PrincipalOutputGatekeeper
public PrincipalOutputGatekeeper(XsltController controller, Receiver next)
-
-
Method Detail
-
open
public void open() throws XPathExceptionDescription copied from class:ProxyReceiverStart of event stream- Specified by:
openin interfaceReceiver- Overrides:
openin classProxyReceiver- Throws:
XPathException- if an error occurs
-
startDocument
public void startDocument(int properties) throws XPathExceptionDescription copied from class:ProxyReceiverStart of a document node.- Specified by:
startDocumentin interfaceReceiver- Overrides:
startDocumentin 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:ProxyReceiverNotify the start of an element- Specified by:
startElementin interfaceReceiver- Overrides:
startElementin 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(java.lang.CharSequence chars, Location locationId, int properties) throws XPathExceptionDescription copied from class:ProxyReceiverCharacter data- Specified by:
charactersin interfaceReceiver- Overrides:
charactersin 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(java.lang.String target, java.lang.CharSequence data, Location locationId, int properties) throws XPathExceptionDescription copied from class:ProxyReceiverProcessing Instruction- Specified by:
processingInstructionin interfaceReceiver- Overrides:
processingInstructionin 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
public void comment(java.lang.CharSequence chars, Location locationId, int properties) throws XPathExceptionDescription copied from class:ProxyReceiverOutput a comment- Specified by:
commentin interfaceReceiver- Overrides:
commentin 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
public void append(Item item, Location locationId, int copyNamespaces) throws XPathException
Description copied from class:ProxyReceiverAppend an arbitrary item (node or atomic value) to the output- Specified by:
appendin interfaceReceiver- Overrides:
appendin 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
public void useAsSecondary() throws XPathException- Throws:
XPathException
-
makeReceiver
public Receiver makeReceiver(SerializationProperties params)
-
close
public void close() throws XPathExceptionDescription copied from class:ProxyReceiverEnd of output. Note that closing this receiver also closes the rest of the pipeline.- Specified by:
closein interfaceReceiver- Overrides:
closein classProxyReceiver- Throws:
XPathException- if an error occurs
-
-