net.sf.saxon.event
Class TracingFilter

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

All Implemented Interfaces:

Receiver, javax.xml.transform.Result

public class TracingFilter

extends ProxyReceiver

A filter that can be inserted into a Receiver pipeline to trace the events that pass through

Field Summary

Fields inherited from class net.sf.saxon.event.ProxyReceiver

nextReceiver, systemId

Fields inherited from class net.sf.saxon.event.SequenceReceiver

pipelineConfiguration, previousAtomic

Fields inherited from interface javax.xml.transform.Result

PI_DISABLE_OUTPUT_ESCAPING, PI_ENABLE_OUTPUT_ESCAPING

Constructor Summary

TracingFilter()

TracingFilter(Receiver r)

Method Summary

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 document
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
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	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 net.sf.saxon.event.ProxyReceiver

getConfiguration, getDocumentLocator, getNamePool, getSystemId, getUnderlyingReceiver, setPipelineConfiguration, setSystemId, setUnderlyingReceiver, setUnparsedEntity

Methods inherited from class net.sf.saxon.event.SequenceReceiver

append, getPipelineConfiguration

Methods inherited from class java.lang.Object

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

Constructor Detail

TracingFilter

public TracingFilter()

TracingFilter

public TracingFilter(Receiver r)

Method Detail

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

Overrides:

attribute in class ProxyReceiver

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

XPathException

characters

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

Character data

Specified by:

characters in interface Receiver

Overrides:

characters in class ProxyReceiver

Throws:

XPathException

close

public void close()
           throws XPathException

End of document

Specified by:

close in interface Receiver

Overrides:

close in class ProxyReceiver

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

Overrides:

comment in class ProxyReceiver

Throws:

XPathException

endDocument

public void endDocument()
                 throws XPathException

Notify the end of a document node

Specified by:

endDocument in interface Receiver

Overrides:

endDocument in class ProxyReceiver

Throws:

XPathException

endElement

public void endElement()
                throws XPathException

End of element

Specified by:

endElement in interface Receiver

Overrides:

endElement in class ProxyReceiver

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

Overrides:

namespace in class ProxyReceiver

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

XPathException

open

public void open()
          throws XPathException

Start of event stream

Specified by:

open in interface Receiver

Overrides:

open in class ProxyReceiver

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

Overrides:

processingInstruction in class ProxyReceiver

Throws:

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

Overrides:

startContent in class ProxyReceiver

Throws:

XPathException

startDocument

public void startDocument(int properties)
                   throws XPathException

Start of a document node.

Specified by:

startDocument in interface Receiver

Overrides:

startDocument in class ProxyReceiver

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

Overrides:

startElement in class ProxyReceiver

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

Throws:

XPathException