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

Method Summary

Modifier and Type	Method	Description
void	attribute(NodeName nameCode, SimpleType typeCode, java.lang.CharSequence value, int locationId, int properties)	Output an attribute
void	characters(java.lang.CharSequence chars, int locationId, int properties)	Output character data
void	setCharacterMap(CharacterMap map)	Set the character maps 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.

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

append, close, comment, endDocument, endElement, getNamePool, getUnderlyingReceiver, namespace, open, processingInstruction, setPipelineConfiguration, setSystemId, setUnderlyingReceiver, setUnparsedEntity, startContent, startDocument, startElement, usesTypeAnnotations

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

append, getConfiguration, getPipelineConfiguration, getSystemId

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 maps to be used by this CharacterMapExpander. They are merged into a single character map if there is more than one.

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.

attribute

public void attribute(NodeName nameCode,
                      SimpleType typeCode,
                      java.lang.CharSequence value,
                      int locationId,
                      int properties)
               throws XPathException

Output an attribute

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

value - the string value of the attribute

locationId - an integer which can be interpreted using a LocationProvider to return information such as line number and system ID. If no location information is available, the value zero is supplied.

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:

XPathException - if an error occurs

characters

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

Output character data

Specified by:

characters in interface Receiver

Overrides:

characters in class ProxyReceiver

Parameters:

chars - The characters

locationId - an integer which can be interpreted using a LocationProvider to return information such as line number and system ID. If no location information is available, the value zero is supplied.

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