net.sf.saxon.serialize

Class CharacterMapExpander

java.lang.Object

net.sf.saxon.event.SequenceReceiver

net.sf.saxon.event.ProxyReceiver

net.sf.saxon.serialize.CharacterMapExpander

All Implemented Interfaces:

javax.xml.transform.Result, Receiver

public class CharacterMapExpander
extends ProxyReceiver

CharacterMapExpander: This ProxyReceiver expands characters occurring in a character map, as specified by the XSLT 2.0 xsl:character-map declaration

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
CharacterMapExpander(Receiver next)

Method Summary

Modifier and Type	Method and Description
void	characters(java.lang.CharSequence chars, Location locationId, int properties) Output character data
CharacterMap	getCharacterMap() Get the character map used by this CharacterMapExpander
void	setCharacterMap(CharacterMap map) Set the character map to be used by this CharacterMapExpander.
void	setUseNullMarkers(boolean use) Indicate whether the result of character mapping should be marked using NUL characters to prevent subsequent XML or HTML character escaping.
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, 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

CharacterMapExpander

public CharacterMapExpander(Receiver next)

Method Detail

setCharacterMap

public void setCharacterMap(CharacterMap map)

Set the character map to be used by this CharacterMapExpander. They will have been merged into a single character map if there is more than one.

Parameters:

map - the character map

getCharacterMap

public CharacterMap getCharacterMap()

Get the character map used by this CharacterMapExpander

Returns:

the character map

setUseNullMarkers

public void setUseNullMarkers(boolean use)

Indicate whether the result of character mapping should be marked using NUL characters to prevent subsequent XML or HTML character escaping. The default value is true (used for the XML and HTML output methods); the value false is used by the text output method.

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

characters

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

Output character data

Specified by:

characters in interface Receiver

Overrides:

characters in class ProxyReceiver

Parameters:

chars - The characters

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