Package net.sf.saxon.event
Class ProxyReceiver
java.lang.Object
net.sf.saxon.event.SequenceReceiver
net.sf.saxon.event.ProxyReceiver
- Direct Known Subclasses:
AttributeInheritor
,AttributeSorter
,BinaryTextDecoder
,BuilderMonitor
,CatchingReceiver
,CDATAFilter
,CharacterMapExpander
,CheckSumFilter
,CloseNotifier
,CommentStripper
,ContentDetector
,CopyOfFeed.AccumulatorCopier
,CountingFilter
,DocumentValidator
,EvaluationNuisance
,ExpressionPresenterToJson
,HTMLIndenter
,HTMLURIEscaper
,IDFilter
,IgnorableWhitespaceStripper
,MetaTagAdjuster
,NamePoolConverter
,NamespaceDifferencer
,NamespaceReducer
,OuterNewlineInserter
,PackageInspector
,ParseHtml.Html5Converter
,PathMaintainer
,PIGrabber
,PrincipalOutputGatekeeper
,Projector
,RegularSequenceChecker
,SchemaModelLoader
,SequenceNormalizer
,Stripper
,TracingFilter
,TransformerReceiver
,UncommittedSerializer
,UnicodeNormalizer
,UseWhenFilter
,ValidatingFilter
,Valve
,VersionControlFilter
,XHTMLPrefixRemover
,XML10ContentChecker
,XMLIndenter
A ProxyReceiver is an Receiver that filters data before passing it to another
underlying Receiver.
-
Field Summary
FieldsFields 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 commentvoid
Notify the end of a document nodevoid
End of elementGet the namepool for this configurationGet the next Receiver in the pipelinevoid
open()
Start of event streamvoid
processingInstruction
(String target, UnicodeString data, Location locationId, int properties) Processing Instructionvoid
Set the pipeline configurationvoid
setSystemId
(String systemId) Set the system IDvoid
setUnderlyingReceiver
(Receiver receiver) Set the underlying receiver.void
setUnparsedEntity
(String name, String uri, String publicId) Set the URI for an unparsed entity in the document.void
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 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, getPipelineConfiguration, getSystemId, handlesAppend
-
Field Details
-
nextReceiver
-
-
Constructor Details
-
ProxyReceiver
-
-
Method Details
-
setSystemId
Description copied from class:SequenceReceiver
Set the system ID- Specified by:
setSystemId
in interfaceResult
- Overrides:
setSystemId
in classSequenceReceiver
- Parameters:
systemId
- the URI used to identify the tree being passed across this interface
-
setUnderlyingReceiver
Set the underlying receiver. This call is mandatory before using the Receiver.- Parameters:
receiver
- the underlying receiver, the one that is to receive events after processing by this filter.
-
getNextReceiver
Get the next Receiver in the pipeline- Returns:
- the next Receiver in the pipeline
-
setPipelineConfiguration
Description copied from interface:Receiver
Set the pipeline configuration- Specified by:
setPipelineConfiguration
in interfaceReceiver
- Overrides:
setPipelineConfiguration
in classSequenceReceiver
- Parameters:
pipe
- the pipeline configuration
-
getNamePool
Get the namepool for this configuration- Overrides:
getNamePool
in classSequenceReceiver
- Returns:
- the Name Pool that was supplied using the setConfiguration() method
-
open
Start of event stream- Specified by:
open
in interfaceReceiver
- Overrides:
open
in classSequenceReceiver
- Throws:
XPathException
- if an error occurs
-
close
End of output. Note that closing this receiver also closes the rest of the pipeline.- Throws:
XPathException
- if an error occurs
-
startDocument
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
End of element- Throws:
XPathException
- if an error occurs
-
characters
public void characters(UnicodeString chars, Location locationId, int properties) throws XPathException Character data- 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 Processing Instruction- 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
Output a comment- 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
-
setUnparsedEntity
Set the URI for an unparsed entity in the document.- Specified by:
setUnparsedEntity
in interfaceReceiver
- Overrides:
setUnparsedEntity
in classSequenceReceiver
- Parameters:
name
- The name of the unparsed entityuri
- The system identifier of the unparsed entitypublicId
- The public identifier of the unparsed entity- Throws:
XPathException
- if an error occurs
-
append
Append an arbitrary item (node or atomic value) to the output- 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
-
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
-