Package net.sf.saxon.trace
Class CountingFilter
java.lang.Object
net.sf.saxon.event.SequenceReceiver
net.sf.saxon.event.ProxyReceiver
net.sf.saxon.trace.CountingFilter
A filter that can be inserted into a Receiver pipeline to count the events that pass through.
This class is not normally used in Saxon, but is available for diagnostics when needed. Note
that the counters are only maintained if
Instrumentation.ACTIVE
is set to true. The counters
can be displayed by calling Instrumentation.report()
.-
Field Summary
Fields inherited from class net.sf.saxon.event.ProxyReceiver
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
ConstructorsConstructorDescriptionCountingFilter
(Receiver nextReceiver) Create a TracingFilter and allocate a unique Id.CountingFilter
(Receiver nextReceiver, PrintStream diagnosticOutput) Create a TracingFilter, allocate a unique Id, and supply the destination for diagnostic trace messages -
Method Summary
Modifier and TypeMethodDescriptionvoid
Append an arbitrary item (node or atomic value) to the outputvoid
characters
(UnicodeString chars, Location locationId, int properties) Character datavoid
close()
End of documentvoid
comment
(UnicodeString chars, Location locationId, int properties) Output a commentvoid
Notify the end of a document nodevoid
End of elementint
getId()
Get the unique id that was allocated to this TracingFiltervoid
open()
Start of event streamvoid
processingInstruction
(String target, UnicodeString data, Location locationId, int properties) Processing Instructionvoid
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 elementMethods inherited from class net.sf.saxon.event.ProxyReceiver
getNamePool, getNextReceiver, setPipelineConfiguration, setSystemId, setUnderlyingReceiver, setUnparsedEntity, usesTypeAnnotations
Methods inherited from class net.sf.saxon.event.SequenceReceiver
append, decompose, flatten, getConfiguration, getErrorCodeForDecomposingFunctionItems, getPipelineConfiguration, getSystemId, handlesAppend
-
Constructor Details
-
CountingFilter
Create a TracingFilter and allocate a unique Id.- Parameters:
nextReceiver
- the underlying receiver to which the events will be sent
-
CountingFilter
Create a TracingFilter, allocate a unique Id, and supply the destination for diagnostic trace messages- Parameters:
nextReceiver
- the underlying receiver to which the events will be sentdiagnosticOutput
- the destination for diagnostic trace messages
-
-
Method Details
-
getId
public int getId()Get the unique id that was allocated to this TracingFilter- Returns:
- the unique id (which is included in all diagnostic messages)
-
append
Append an arbitrary item (node or atomic value) to the output- Specified by:
append
in interfaceReceiver
- Overrides:
append
in classProxyReceiver
- Parameters:
item
- the item to be appendedlocationId
- the location of the calling instruction, for diagnosticscopyNamespaces
- if the item is an element node, this indicates whether its namespaces need to be copied. Values areReceiverOption.ALL_NAMESPACES
; the default (0) means- Throws:
XPathException
- if an error occurs
-
characters
public void characters(UnicodeString chars, Location locationId, int properties) throws XPathException Character data- Specified by:
characters
in interfaceReceiver
- Overrides:
characters
in classProxyReceiver
- Parameters:
chars
- The characterslocationId
- 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
- Throws:
XPathException
- if an error occurs
-
close
End of document- Specified by:
close
in interfaceReceiver
- Overrides:
close
in classProxyReceiver
- Throws:
XPathException
- if an error occurs
-
comment
Output a comment- Specified by:
comment
in interfaceReceiver
- Overrides:
comment
in classProxyReceiver
- Parameters:
chars
- The content of the commentlocationId
- provides information such as line number and system ID.properties
- Additional information about the comment.- Throws:
XPathException
- if an error occurs
-
endDocument
Notify the end of a document node- Specified by:
endDocument
in interfaceReceiver
- Overrides:
endDocument
in classProxyReceiver
- Throws:
XPathException
- if an error occurs
-
endElement
End of element- Specified by:
endElement
in interfaceReceiver
- Overrides:
endElement
in classProxyReceiver
- Throws:
XPathException
- if an error occurs
-
open
Start of event stream- Specified by:
open
in interfaceReceiver
- Overrides:
open
in classProxyReceiver
- Throws:
XPathException
- if an error occurs
-
processingInstruction
public void processingInstruction(String target, UnicodeString data, Location locationId, int properties) throws XPathException Processing Instruction- Specified by:
processingInstruction
in interfaceReceiver
- Overrides:
processingInstruction
in classProxyReceiver
- Parameters:
target
- The PI name. This must be a legal name (it will not be checked).data
- The data portion of the processing instructionlocationId
- provides information such as line number and system ID.properties
- Additional information about the PI.- Throws:
XPathException
- if an error occurs
-
startDocument
Start of a document node.- Specified by:
startDocument
in interfaceReceiver
- Overrides:
startDocument
in classProxyReceiver
- Parameters:
properties
- properties of the document node- Throws:
XPathException
- if an error occurs
-
startElement
public void startElement(NodeName elemName, SchemaType type, AttributeMap attributes, NamespaceMap namespaces, Location location, int properties) throws XPathException Notify the start of an element- Specified by:
startElement
in interfaceReceiver
- Overrides:
startElement
in classProxyReceiver
- Parameters:
elemName
- the name of the element.type
- the type annotation of the element.attributes
- the attributes of this elementnamespaces
- the in-scope namespaces of this element: generally this is all the in-scope namespaces, without relying on inheriting namespaces from parent elementslocation
- an object providing information about the module, line, and column where the node originatedproperties
- bit-significant properties of the element node. If there are no relevant properties, zero is supplied. The definitions of the bits are in classReceiverOption
- Throws:
XPathException
- if an error occurs
-