net.sf.saxon.event

Class ProxyReceiver

public abstract class ProxyReceiver extends SequenceReceiver

A ProxyReceiver is an Receiver that filters data before passing it to another underlying Receiver.
Field Summary
protected ReceivernextReceiver
Method Summary
voidappend(Item item, int locationId, int copyNamespaces)
Append an arbitrary item (node or atomic value) to the output
voidattribute(int nameCode, int typeCode, CharSequence value, int locationId, int properties)
Notify an attribute.
voidcharacters(CharSequence chars, int locationId, int properties)
Character data
voidclose()
End of output.
voidcomment(CharSequence chars, int locationId, int properties)
Output a comment
voidendDocument()
Notify the end of a document node
voidendElement()
End of element
ConfigurationgetConfiguration()
LocationProvidergetDocumentLocator()
Get the Document Locator
NamePoolgetNamePool()
Get the namepool for this configuration
ReceivergetUnderlyingReceiver()
Get the underlying Receiver (that is, the next one in the pipeline)
voidnamespace(int namespaceCode, int properties)
Notify a namespace.
voidopen()
Start of event stream
voidprocessingInstruction(String target, CharSequence data, int locationId, int properties)
Processing Instruction
voidsetPipelineConfiguration(PipelineConfiguration pipe)
voidsetSystemId(String systemId)
voidsetUnderlyingReceiver(Receiver receiver)
Set the underlying receiver.
voidsetUnparsedEntity(String name, String uri, String publicId)
Set the URI for an unparsed entity in the document.
voidstartContent()
Notify the start of the content, that is, the completion of all attributes and namespaces.
voidstartDocument(int properties)
Start of a document node.
voidstartElement(int nameCode, int typeCode, int locationId, int properties)
Notify the start of an element
booleanusesTypeAnnotations()
Ask whether this Receiver (or the downstream pipeline) makes any use of the type annotations supplied on element and attribute events

Field Detail

nextReceiver

protected Receiver nextReceiver

Method Detail

append

public void append(Item item, int locationId, int copyNamespaces)
Append an arbitrary item (node or atomic value) to the output

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 ALL_NAMESPACES, LOCAL_NAMESPACES, NO_NAMESPACES

attribute

public void attribute(int nameCode, int typeCode, CharSequence value, int locationId, int properties)
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

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

characters

public void characters(CharSequence chars, int locationId, int properties)
Character data

close

public void close()
End of output. Note that closing this receiver also closes the rest of the pipeline.

comment

public void comment(CharSequence chars, int locationId, int properties)
Output a comment

endDocument

public void endDocument()
Notify the end of a document node

endElement

public void endElement()
End of element

getConfiguration

public Configuration getConfiguration()

getDocumentLocator

public LocationProvider getDocumentLocator()
Get the Document Locator

getNamePool

public NamePool getNamePool()
Get the namepool for this configuration

getUnderlyingReceiver

public Receiver getUnderlyingReceiver()
Get the underlying Receiver (that is, the next one in the pipeline)

namespace

public void namespace(int namespaceCode, int properties)
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.

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

open

public void open()
Start of event stream

processingInstruction

public void processingInstruction(String target, CharSequence data, int locationId, int properties)
Processing Instruction

setPipelineConfiguration

public void setPipelineConfiguration(PipelineConfiguration pipe)

setSystemId

public void setSystemId(String systemId)

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.

setUnparsedEntity

public void setUnparsedEntity(String name, String uri, String publicId)
Set the URI for an unparsed entity in the document.

startContent

public void startContent()
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.

startDocument

public void startDocument(int properties)
Start of a document node.

startElement

public void startElement(int nameCode, int typeCode, int locationId, int properties)
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

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