Package net.sf.saxon.serialize
Class CharacterMap
java.lang.Object
net.sf.saxon.serialize.CharacterMap
This class defines a character map, that is, a mapping from characters to strings used by the serializer
when mapping individual characters in the output.
-
Constructor Summary
ConstructorsConstructorDescriptionCharacterMap
(Iterable<CharacterMap> list) Create a CharacterMap that combines a set of existing character maps.CharacterMap
(StructuredQName name, IntHashMap<String> map) Create a CharacterMap from a raw map of integers to strings -
Method Summary
Modifier and TypeMethodDescriptionvoid
Write the character map to an export filegetMap()
Get the contents of the character mapgetName()
Get the name of the character mapmap
(UnicodeString in, boolean insertNulls) Expand all the characters in a string using this character mapping
-
Constructor Details
-
CharacterMap
Create a CharacterMap from a raw map of integers to strings- Parameters:
name
- the name of the CharacterMapmap
- the mapping of integer Unicode character codes to strings. This must not be subsequently changed.
-
CharacterMap
Create a CharacterMap that combines a set of existing character maps.- Parameters:
list
- the list of existing character maps. If the same character is mapped by more than one map in the list, the last mapping takes precedence
-
-
Method Details
-
getName
Get the name of the character map- Returns:
- the name given in the stylesheet if this is an un-expanded character map, or null if this is an expanded map (a map combined with the character maps that it references)
-
getMap
Get the contents of the character map- Returns:
- the character map, as a map from integer codepoints to strings
-
map
Expand all the characters in a string using this character mapping- Parameters:
in
- the input string to be mappedinsertNulls
- true if null (0) characters are to be inserted before and after replacement characters. This is done to signal that output escaping of these characters is disabled. The flag is set to true when writing XML or HTML, but to false when writing TEXT.- Returns:
- a string with all characters expanded
-
export
Write the character map to an export file- Parameters:
out
- the output destination
-