Package net.sf.saxon.event

Class LineNumberRetainer

java.lang.Object

net.sf.saxon.event.SequenceReceiver

net.sf.saxon.event.ProxyReceiver

net.sf.saxon.event.LineNumberRetainer

All Implemented Interfaces:

Result, Receiver

public class LineNumberRetainer
extends ProxyReceiver

This class is used to adjust the line and column positions reported by a SAX parser. SAX reports the line/column at the end of each event (for example, the position at the end of a text node), whereas what the user wants is typically the position at the start of the event. This class therefore remembers the position reported with one event, and reports it onwards as the position of the next event. Unfortunately it doesn't solve the problem that we get no information about the position of attributes.

There's one complication: the Receiver pipeline doesn't pass location information for an endElement event. Rather than introduce an interface change to pass an extra argument to endElement, we instead register the original SAX Location object in the PipelineConfiguration, and pick the value up from there.

DROPPED from the Saxon 13 build because in edge cases with multiple-entity files, it gets the base URI of nodes wrong.

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

Constructors

Constructor	Description
LineNumberRetainer(Receiver out)

Method Summary

Modifier and Type	Method	Description
void	characters(UnicodeString chars, Location location, int properties)	Character data
void	comment(UnicodeString chars, Location location, int properties)	Output a comment
void	endDocument()	Notify the end of a document node
void	endElement()	End of element
void	processingInstruction(String target, UnicodeString data, Location location, int properties)	Processing Instruction
void	resetLocation(Location loc)
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

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

append, close, getNamePool, getNextReceiver, open, setPipelineConfiguration, setSystemId, setUnderlyingReceiver, setUnparsedEntity, usesTypeAnnotations

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

append, decompose, flatten, getConfiguration, getErrorCodeForDecomposingFunctionItems, getPipelineConfiguration, getSystemId, handlesAppend

Methods inherited from class java.lang.Object

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

Constructor Details

LineNumberRetainer

public LineNumberRetainer(Receiver out)

Method Details

startDocument

public void startDocument(int properties)
                   throws XPathException

Start of a document node.

Specified by:

startDocument in interface Receiver

Overrides:

startDocument in class ProxyReceiver

Parameters:

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

Throws:

XPathException - if an error occurs

resetLocation

public void resetLocation(Location loc)

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

Overrides:

startElement in class ProxyReceiver

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()
                throws XPathException

End of element

Specified by:

endElement in interface Receiver

Overrides:

endElement in class ProxyReceiver

Throws:

XPathException - if an error occurs

characters

public void characters(UnicodeString chars,
 Location location,
 int properties)
                throws XPathException

Character data

Specified by:

characters in interface Receiver

Overrides:

characters in class ProxyReceiver

Parameters:

chars - The characters

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

processingInstruction

public void processingInstruction(String target,
 UnicodeString data,
 Location location,
 int properties)
                           throws XPathException

Processing Instruction

Specified by:

processingInstruction in interface Receiver

Overrides:

processingInstruction in class ProxyReceiver

Parameters:

target - The PI name. This must be a legal name (it will not be checked).

data - The data portion of the processing instruction

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

properties - Additional information about the PI.

Throws:

XPathException - if an error occurs

comment

public void comment(UnicodeString chars,
 Location location,
 int properties)
             throws XPathException

Output a comment

Specified by:

comment in interface Receiver

Overrides:

comment in class ProxyReceiver

Parameters:

chars - The content of the comment

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

properties - Additional information about the comment.

Throws:

XPathException - if an error occurs