com.saxonica.serialize

Class NamespaceSorter

java.lang.Object

net.sf.saxon.event.SequenceReceiver

net.sf.saxon.event.ProxyReceiver

com.saxonica.serialize.NamespaceSorter

All Implemented Interfaces:

javax.xml.transform.Result, Receiver, Sortable

public class NamespaceSorter
extends ProxyReceiver
implements Sortable

NamespaceSorter: This filter sorts namespace declarations into alphabetical order, required for XML Canonicalization

Author:

Michael Kay

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 and Description
NamespaceSorter(Receiver next) Create a namespace sorter

Method Summary

Modifier and Type	Method and Description
int	compare(int a, int b) Compare two objects within this Sortable, identified by their position.
void	namespace(NamespaceBindingSet namespaceBindings, int properties) Notify a namespace.
void	startContent() Notify the start of the content, that is, the completion of all attributes and namespaces.
void	startElement(NodeName elemName, SchemaType typeCode, Location location, int properties) Notify the start of an element
void	swap(int a, int b) Swap two objects within this Sortable, identified by their position.

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

append, attribute, characters, close, comment, endDocument, endElement, getNamePool, getNextReceiver, open, processingInstruction, setPipelineConfiguration, setSystemId, setUnderlyingReceiver, setUnparsedEntity, startDocument, 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 Detail

NamespaceSorter

public NamespaceSorter(Receiver next)

Create a namespace sorter

Parameters:

next - the next receiver in the pipeline

Method Detail

startElement

public void startElement(NodeName elemName,
                         SchemaType typeCode,
                         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 - integer code identifying the name of the element within the name pool.

typeCode - integer code identifying the element's type within the name pool.

location - the element's line & column number

properties - properties of the element node

Throws:

XPathException - if an error occurs

namespace

public void namespace(NamespaceBindingSet namespaceBindings,
                      int properties)
               throws XPathException

Description copied from class: ProxyReceiver

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:

namespaceBindings - the prefix/uri pair representing the namespace binding

properties - any special properties to be passed on this call

Throws:

XPathException - if an error occurs

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 - if an error occurs

compare

public int compare(int a,
                   int b)

Compare two objects within this Sortable, identified by their position.

Specified by:

compare in interface Sortable

Returns:

<0 if obj[a]<obj[b], 0 if obj[a]=obj[b], >0 if obj[a]>obj[b]

swap

public void swap(int a,
                 int b)

Swap two objects within this Sortable, identified by their position.

Specified by:

swap in interface Sortable