net.sf.saxon.serialize

Class CharacterMapIndex

java.lang.Object

net.sf.saxon.serialize.CharacterMapIndex

All Implemented Interfaces:

java.lang.Iterable<CharacterMap>

public class CharacterMapIndex
extends java.lang.Object
implements java.lang.Iterable<CharacterMap>

This class represents a set of named character maps. Each character map in the set is identified by a unique QName.

Constructor Summary

Constructors

Constructor and Description
CharacterMapIndex()

Method Summary

Modifier and Type	Method and Description
CharacterMapIndex	copy()
CharacterMap	getCharacterMap(StructuredQName name)
boolean	isEmpty()
java.util.Iterator<CharacterMap>	iterator()
CharacterMapExpander	makeCharacterMapExpander(java.lang.String useMaps, Receiver next, SerializerFactory sf) Make a CharacterMapExpander to handle the character map definitions in the serialization properties.
void	putCharacterMap(StructuredQName name, CharacterMap charMap)

Methods inherited from class java.lang.Object

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

Methods inherited from interface java.lang.Iterable

forEach, spliterator

Constructor Detail

CharacterMapIndex

public CharacterMapIndex()

Method Detail

getCharacterMap

public CharacterMap getCharacterMap(StructuredQName name)

putCharacterMap

public void putCharacterMap(StructuredQName name,
                            CharacterMap charMap)

iterator

public java.util.Iterator<CharacterMap> iterator()

Specified by:

iterator in interface java.lang.Iterable<CharacterMap>

isEmpty

public boolean isEmpty()

copy

public CharacterMapIndex copy()

makeCharacterMapExpander

public CharacterMapExpander makeCharacterMapExpander(java.lang.String useMaps,
                                                     Receiver next,
                                                     SerializerFactory sf)
                                              throws XPathException

Make a CharacterMapExpander to handle the character map definitions in the serialization properties.

This method is intended for internal use only.

Parameters:

useMaps - the expanded use-character-maps property: a space-separated list of names of character maps to be used, each one expressed as an expanded-QName in Clark notation (that is, {uri}local-name).

next - the next receiver in the pipeline

sf - the SerializerFactory - used to create a CharacterMapExpander. This callback is provided so that a user-defined SerializerFactory can customize the result of this function, for example by returning a subclass of the standard CharacterMapExpander.

Returns:

a CharacterMapExpander if one is required, or null if not (for example, if the useMaps argument is an empty string).

Throws:

XPathException - if a name in the useMaps property cannot be resolved to a declared character map.