net.sf.saxon.event

Class Sink

java.lang.Object

net.sf.saxon.event.Sink

All Implemented Interfaces:

javax.xml.transform.Result, Receiver

public class Sink
extends java.lang.Object
implements Receiver

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

Field Summary

Fields inherited from interface javax.xml.transform.Result

PI_DISABLE_OUTPUT_ESCAPING, PI_ENABLE_OUTPUT_ESCAPING

Constructor Summary

Constructors

Constructor and Description
Sink()

Method Summary

Modifier and Type	Method and Description
void	attribute(int nameCode, int typeCode, java.lang.CharSequence value, int locationId, int properties) Notify an attribute.
void	characters(java.lang.CharSequence chars, int locationId, int properties) Character data
void	close() End of event stream
void	comment(java.lang.CharSequence chars, int locationId, int properties) Output a comment
void	endDocument() Notify the end of a document node
void	endElement() End of element
PipelineConfiguration	getPipelineConfiguration() Get the pipeline configuration
java.lang.String	getSystemId()
void	namespace(int namespaceCode, int properties) Notify a namespace.
void	open() Start of event stream
void	processingInstruction(java.lang.String target, java.lang.CharSequence data, int locationId, int properties) Processing Instruction
void	setPipelineConfiguration(PipelineConfiguration pipe) Set the pipeline configuration
void	setSystemId(java.lang.String systemId) Set the System ID of the tree represented by this event stream
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(int nameCode, int typeCode, int locationId, int properties) Notify the start of an element

Methods inherited from class java.lang.Object

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

Constructor Detail

Sink

public Sink()

Method Detail

setSystemId

public void setSystemId(java.lang.String systemId)

Description copied from interface: Receiver

Set the System ID of the tree represented by this event stream

Specified by:

setSystemId in interface javax.xml.transform.Result

Specified by:

setSystemId in interface Receiver

getSystemId

public java.lang.String getSystemId()

Specified by:

getSystemId in interface javax.xml.transform.Result

setPipelineConfiguration

public void setPipelineConfiguration(PipelineConfiguration pipe)

Set the pipeline configuration

Specified by:

setPipelineConfiguration in interface Receiver

getPipelineConfiguration

public PipelineConfiguration getPipelineConfiguration()

Get the pipeline configuration

Specified by:

getPipelineConfiguration in interface Receiver

open

public void open()
          throws XPathException

Start of event stream

Specified by:

open in interface Receiver

Throws:

XPathException

close

public void close()
           throws XPathException

End of event stream

Specified by:

close in interface Receiver

Throws:

XPathException

startDocument

public void startDocument(int properties)
                   throws XPathException

Start of a document node.

Specified by:

startDocument in interface Receiver

Throws:

XPathException

endDocument

public void endDocument()
                 throws XPathException

Notify the end of a document node

Specified by:

endDocument in interface Receiver

Throws:

XPathException

startElement

public void startElement(int nameCode,
                         int typeCode,
                         int locationId,
                         int properties)
                  throws XPathException

Notify the start of an element

Specified by:

startElement in interface Receiver

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 - for future use. Should be set to zero.

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.

Specified by:

namespace in interface Receiver

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:

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

XPathException

attribute

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

Specified by:

attribute in interface Receiver

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

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:

java.lang.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.

Specified by:

startContent in interface Receiver

Throws:

XPathException

endElement

public void endElement()
                throws XPathException

End of element

Specified by:

endElement in interface Receiver

Throws:

XPathException

characters

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

Character data

Specified by:

characters in interface Receiver

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

NO_SPECIAL_CHARACTERS

Value contains no special characters

WHITESPACE

Text is all whitespace

Throws:

XPathException

processingInstruction

public void processingInstruction(java.lang.String target,
                                  java.lang.CharSequence data,
                                  int locationId,
                                  int properties)
                           throws XPathException

Processing Instruction

Specified by:

processingInstruction in interface Receiver

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. The following bits are defined:

CHECKED

Data is known to be legal (e.g. doesn't contain "?>")

Throws:

XPathException

comment

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

Output a comment

Specified by:

comment in interface Receiver

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. The following bits are defined:

CHECKED

Comment is known to be legal (e.g. doesn't contain "--")

Throws:

XPathException

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

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