net.sf.saxon.event
Class ProxyReceiver

java.lang.Object
  net.sf.saxon.event.SequenceReceiver
      net.sf.saxon.event.ProxyReceiver

All Implemented Interfaces:

Result, Receiver

Direct Known Subclasses:

BuilderMonitor, CDATAFilter, CharacterMapExpander, CommentStripper, DocumentValidator, EntityValidator, EvaluationNuisance, HTMLIndenter, HTMLURIEscaper, IdValidator, IgnorableWhitespaceStripper, ImplicitResultChecker, MetaTagAdjuster, NamePoolConverter, NamespaceReducer, PIGrabber, Projector, StartTagBuffer, Stripper, TracingFilter, TransformerReceiver, TypeCheckingFilter, UncommittedSerializer, UnicodeNormalizer, UseWhenFilter, ValidatingFilter, VersionControlFilter, WatchManager, 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

protected Receiver

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

ProxyReceiver()

Method Summary

void	append(Item item, int locationId, int copyNamespaces) Append an arbitrary item (node or atomic value) to the output
void	attribute(int nameCode, int typeCode, CharSequence value, int locationId, int properties) Notify an attribute.
void	characters(CharSequence chars, int locationId, int properties) Character data
void	close() End of output.
void	comment(CharSequence chars, int locationId, int properties) Output a comment
void	endDocument() Notify the end of a document node
void	endElement() End of element
Configuration	getConfiguration() Get the Saxon Configuration
LocationProvider	getDocumentLocator() Get the Document Locator
NamePool	getNamePool() Get the namepool for this configuration
Receiver	getUnderlyingReceiver() Get the underlying Receiver (that is, the next one in the pipeline)
void	namespace(int namespaceCode, int properties) Notify a namespace.
void	open() Start of event stream
void	processingInstruction(String target, CharSequence data, int locationId, int properties) Processing Instruction
void	setPipelineConfiguration(PipelineConfiguration pipe) Set the pipeline configuration
void	setSystemId(String systemId) Set the system ID
void	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	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(int nameCode, int typeCode, int locationId, int properties) Notify the start of an element
boolean	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, getPipelineConfiguration, getSystemId

Methods inherited from class java.lang.Object

clone, equals, finalize, getClass, hashCode, notify, notifyAll, toString, wait, wait, wait

Field Detail

nextReceiver

protected Receiver nextReceiver

Constructor Detail

ProxyReceiver

public ProxyReceiver()

Method Detail

setSystemId

public void setSystemId(String systemId)

Description copied from class: SequenceReceiver

Set the system ID

Specified by:

setSystemId in interface Result

Specified by:

setSystemId in interface Receiver

Overrides:

setSystemId in class SequenceReceiver

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)

setPipelineConfiguration

public void setPipelineConfiguration(PipelineConfiguration pipe)

Description copied from interface: Receiver

Set the pipeline configuration

Specified by:

setPipelineConfiguration in interface Receiver

Overrides:

setPipelineConfiguration in class SequenceReceiver

Parameters:

pipe - the pipeline configuration

getConfiguration

public Configuration getConfiguration()

Description copied from class: SequenceReceiver

Get the Saxon Configuration

Overrides:

getConfiguration in class SequenceReceiver

Returns:

the Configuration

getNamePool

public NamePool getNamePool()

Get the namepool for this configuration

Overrides:

getNamePool in class SequenceReceiver

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 interface Receiver

Overrides:

open in class SequenceReceiver

Throws:

XPathException

close

public void close()
           throws XPathException

End of output. Note that closing this receiver also closes the rest of the pipeline.

Throws:

XPathException

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 class ReceiverOptions

Throws:

XPathException

endDocument

public void endDocument()
                 throws XPathException

Notify the end of a document node

Throws:

XPathException

startElement

public void startElement(int nameCode,
                         int 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.

properties - properties of the element node

locationId - an integer which can be interpreted using a LocationProvider to return information such as line number and system ID. If no location information is available, the value zero is supplied.

Throws:

XPathException

namespace

public void namespace(int namespaceCode,
                      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:

namespaceCode - an integer: the top half is a prefix code, the bottom half a URI code. These may be translated into an actual prefix and URI using the name pool. A prefix code of zero represents the empty prefix (that is, the default namespace). A URI code of zero represents a URI of "", that is, a namespace undeclaration.

properties - 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: it sets the REJECT_DUPLICATES flag, and this is treated as a hard error.

Throws:

IllegalStateException: - attempt to output a namespace when there is no open element start tag

XPathException

attribute

public void attribute(int nameCode,
                      int typeCode,
                      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 pool

typeCode - The type of the attribute, as held in the name pool

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

locationId - an integer which can be interpreted using a LocationProvider to return information such as line number and system ID. If no location information is available, the value zero is supplied.

Throws:

IllegalStateException: - attempt to output an attribute when there is no open element start tag

XPathException

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

endElement

public void endElement()
                throws XPathException

End of element

Throws:

XPathException

characters

public void characters(CharSequence chars,
                       int locationId,
                       int properties)
                throws XPathException

Character data

Parameters:

chars - The characters

locationId - an integer which can be interpreted using a LocationProvider 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

processingInstruction

public void processingInstruction(String target,
                                  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 instruction

locationId - an integer which can be interpreted using a LocationProvider 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

comment

public void comment(CharSequence chars,
                    int locationId,
                    int properties)
             throws XPathException

Output a comment

Parameters:

chars - The content of the comment

locationId - an integer which can be interpreted using a LocationProvider 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

setUnparsedEntity

public void setUnparsedEntity(String name,
                              String uri,
                              String publicId)
                       throws XPathException

Set the URI for an unparsed entity in the document.

Specified by:

setUnparsedEntity in interface Receiver

Overrides:

setUnparsedEntity in class SequenceReceiver

Parameters:

name - The name of the unparsed entity

uri - The system identifier of the unparsed entity

publicId - The public identifier of the unparsed entity

Throws:

XPathException

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 class SequenceReceiver

Parameters:

item - the item to be appended

locationId - the location of the calling instruction, for diagnostics

copyNamespaces - if the item is an element node, this indicates whether its namespaces need to be copied. Values are NodeInfo.ALL_NAMESPACES, NodeInfo.LOCAL_NAMESPACES, NodeInfo.NO_NAMESPACES

Throws:

XPathException

getDocumentLocator

public LocationProvider getDocumentLocator()

Get the Document Locator

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