Package net.sf.saxon.event
Class ProxyReceiver
- java.lang.Object
-
- net.sf.saxon.event.SequenceReceiver
-
- net.sf.saxon.event.ProxyReceiver
-
- All Implemented Interfaces:
javax.xml.transform.Result
,Receiver
- Direct Known Subclasses:
BinaryTextDecoder
,BuilderMonitor
,CDATAFilter
,CharacterMapExpander
,CommentStripper
,HTMLIndenter
,HTMLURIEscaper
,ImplicitResultChecker
,MetaTagAdjuster
,NamePoolConverter
,NamespaceReducer
,PathMaintainer
,PIGrabber
,StartTagBuffer
,Stripper
,TracingFilter
,TransformerReceiver
,TypeCheckingFilter
,UncommittedSerializer
,UnicodeNormalizer
,UseWhenFilter
,XML10ContentChecker
,XMLIndenter
public abstract class ProxyReceiver extends SequenceReceiver
A ProxyReceiver is an Receiver that filters data before passing it to another underlying Receiver.
-
-
Field Summary
Fields Modifier and Type Field Description protected Receiver
nextReceiver
-
Fields inherited from class net.sf.saxon.event.SequenceReceiver
pipelineConfiguration, previousAtomic, systemId
-
-
Constructor Summary
Constructors Constructor Description ProxyReceiver(Receiver nextReceiver)
-
Method Summary
All Methods Instance Methods Concrete Methods Modifier and Type Method Description void
append(Item item, int locationId, int copyNamespaces)
Append an arbitrary item (node or atomic value) to the outputvoid
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)
Character datavoid
close()
End of output.void
comment(java.lang.CharSequence chars, int locationId, int properties)
Output a commentvoid
endDocument()
Notify the end of a document nodevoid
endElement()
End of elementNamePool
getNamePool()
Get the namepool for this configurationReceiver
getUnderlyingReceiver()
Get the underlying Receiver (that is, the next one in the pipeline)void
namespace(NamespaceBinding namespaceBinding, int properties)
Notify a namespace.void
open()
Start of event streamvoid
processingInstruction(java.lang.String target, java.lang.CharSequence data, int locationId, int properties)
Processing Instructionvoid
setPipelineConfiguration(PipelineConfiguration pipe)
Set the pipeline configurationvoid
setSystemId(java.lang.String systemId)
Set the system IDvoid
setUnderlyingReceiver(Receiver receiver)
Set the underlying receiver.void
setUnparsedEntity(java.lang.String name, java.lang.String uri, java.lang.String publicId)
Set the URI for an unparsed entity in the document.void
startContent()
Notify the start of the content, that is, the completion of all attributes and namespaces.void
startDocument(int properties)
Start of a document node.void
startElement(NodeName elemName, 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, getPipelineConfiguration, getSystemId
-
-
-
-
Field Detail
-
nextReceiver
protected Receiver nextReceiver
-
-
Constructor Detail
-
ProxyReceiver
public ProxyReceiver(Receiver nextReceiver)
-
-
Method Detail
-
setSystemId
public void setSystemId(java.lang.String systemId)
Description copied from class:SequenceReceiver
Set the system ID- Specified by:
setSystemId
in interfaceReceiver
- Specified by:
setSystemId
in interfacejavax.xml.transform.Result
- Overrides:
setSystemId
in classSequenceReceiver
- Parameters:
systemId
- the URI used to identify the tree being passed across this interface
-
setUnderlyingReceiver
public void setUnderlyingReceiver(Receiver receiver)
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.
-
getUnderlyingReceiver
public Receiver getUnderlyingReceiver()
Get the underlying Receiver (that is, the next one in the pipeline)- Returns:
- the underlying Receiver (that is, the next one in the pipeline)
-
setPipelineConfiguration
public void setPipelineConfiguration(PipelineConfiguration pipe)
Description copied from interface:Receiver
Set the pipeline configuration- Specified by:
setPipelineConfiguration
in interfaceReceiver
- Overrides:
setPipelineConfiguration
in classSequenceReceiver
- Parameters:
pipe
- the pipeline configuration
-
getNamePool
public NamePool getNamePool()
Get the namepool for this configuration- Overrides:
getNamePool
in classSequenceReceiver
- Returns:
- the Name Pool that was supplied using the setConfiguration() method
-
open
public void open() throws XPathException
Start of event stream- Specified by:
open
in interfaceReceiver
- Overrides:
open
in classSequenceReceiver
- Throws:
XPathException
- if an error occurs
-
close
public void close() throws XPathException
End of output. Note that closing this receiver also closes the rest of the pipeline.- Throws:
XPathException
- if an error occurs
-
startDocument
public void startDocument(int properties) throws XPathException
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 elemName, SchemaType typeCode, int locationId, int properties) throws XPathException
Notify the start of an element- Parameters:
elemName
- integer code identifying the name of the element within the name pool.typeCode
- integer code identifying the element's type within the name pool.properties
- properties of the element nodelocationId
- an integer which can be interpreted using aLocationProvider
to return information such as line number and system ID. If no location information is available, the value zero is supplied.- 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 pair representing the namespace bindingproperties
- any special properties to be passed on this call- 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 poolproperties
- 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 attributelocationId
- an integer which can be interpreted using aLocationProvider
to return information such as line number and system ID. If no location information is available, the value zero is supplied.- 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
End of element- Throws:
XPathException
- if an error occurs
-
characters
public void characters(java.lang.CharSequence chars, int locationId, int properties) throws XPathException
Character data- Parameters:
chars
- The characterslocationId
- an integer which can be interpreted using aLocationProvider
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 target, java.lang.CharSequence data, int 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
- an integer which can be interpreted using aLocationProvider
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.- Throws:
XPathException
- if an error occurs
-
comment
public void comment(java.lang.CharSequence chars, int locationId, int properties) throws XPathException
Output a comment- Parameters:
chars
- The content of the commentlocationId
- an integer which can be interpreted using aLocationProvider
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.- Throws:
XPathException
- if an error occurs
-
setUnparsedEntity
public void setUnparsedEntity(java.lang.String name, java.lang.String uri, java.lang.String publicId) throws XPathException
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
public void append(Item item, int locationId, int copyNamespaces) throws XPathException
Append an arbitrary item (node or atomic value) to the output- 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
-
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
-
-