Package net.sf.saxon.event

Class Sink

java.lang.Object

net.sf.saxon.event.SequenceReceiver

net.sf.saxon.event.Sink

All Implemented Interfaces:

javax.xml.transform.Result, Receiver

public class Sink
extends SequenceReceiver

A Sink is a Receiver that discards all information passed to it

Field Summary

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

Constructors

Constructor	Description
Sink(PipelineConfiguration pipe)

Method Summary

Modifier and Type	Method	Description
void	append(Item item, Location locationId, int copyNamespaces)	Append an arbitrary item (node or atomic value) to the output
void	characters(UnicodeString chars, Location locationId, int properties)	Character data
void	close()	End of event stream
void	comment(UnicodeString chars, Location locationId, int properties)	Output a comment
void	endDocument()	Notify the end of a document node
void	endElement()	End of element
void	open()	Start of event stream
void	processingInstruction(java.lang.String target, UnicodeString data, Location locationId, int properties)	Processing Instruction
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	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 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, decompose, flatten, getConfiguration, getErrorCodeForDecomposingFunctionItems, getNamePool, getPipelineConfiguration, getSystemId, handlesAppend, setPipelineConfiguration, setSystemId

Methods inherited from class java.lang.Object

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

Constructor Detail

Sink

public Sink(PipelineConfiguration pipe)

Method Detail

open

public void open()

Start of event stream

Specified by:

open in interface Receiver

Overrides:

open in class SequenceReceiver

close

public void close()

End of event stream

startDocument

public void startDocument(int properties)

Start of a document node.

Parameters:

properties - bit-significant integer indicating properties of the document node. The definitions of the bits are in class ReceiverOption

endDocument

public void endDocument()

Notify the end of a document node

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 element

namespaces - the in-scope namespaces of this element: generally this is all the in-scope namespaces, without relying on inheriting namespaces from parent elements

location - an object providing information about the module, line, and column where the node originated

properties - bit-significant properties of the element node. If there are no relevant properties, zero is supplied. The definitions of the bits are in class ReceiverOption

Throws:

XPathException - if an error occurs

endElement

public void endElement()

End of element

characters

public void characters(UnicodeString chars,
                       Location locationId,
                       int properties)

Character data

Parameters:

chars - The characters

locationId - 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

processingInstruction

public void processingInstruction(java.lang.String target,
                                  UnicodeString data,
                                  Location locationId,
                                  int properties)

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 - provides information such as line number and system ID.

properties - Additional information about the PI.

comment

public void comment(UnicodeString chars,
                    Location locationId,
                    int properties)

Output a comment

Parameters:

chars - The content of the comment

locationId - provides information such as line number and system ID.

properties - Additional information about the comment.

append

public void append(Item item,
                   Location locationId,
                   int copyNamespaces)

Append an arbitrary item (node or atomic value) to the output

Specified by:

append in interface Receiver

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 ReceiverOption.ALL_NAMESPACES; the default (0) means

setUnparsedEntity

public void setUnparsedEntity(java.lang.String name,
                              java.lang.String uri,
                              java.lang.String publicId)

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

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