net.sf.saxon.style

Class XSLCharacterMap

java.lang.Object

net.sf.saxon.tree.linked.NodeImpl

net.sf.saxon.tree.linked.ParentNodeImpl

net.sf.saxon.tree.linked.ElementImpl

net.sf.saxon.style.StyleElement

net.sf.saxon.style.XSLCharacterMap

All Implemented Interfaces:

Iterable<NodeInfo>, Source, SourceLocator, Location, GroundedValue<NodeInfo>, Item<NodeInfo>, MutableNodeInfo, NamespaceResolver, NodeInfo, Sequence<NodeInfo>, SteppingNode<NodeImpl>, SiblingCountingNode, Locator

public class XSLCharacterMap
extends StyleElement

An xsl:character-map declaration in the stylesheet.

Field Summary

Fields

Modifier and Type	Field and Description
(package private) List<XSLCharacterMap>	characterMapElements
(package private) boolean	redundant
(package private) String	use
(package private) boolean	validated

Fields inherited from class net.sf.saxon.style.StyleElement

ACTION_COMPILE, ACTION_FIXUP, ACTION_OPTIMIZE, ACTION_PROCESS_ATTRIBUTES, ACTION_TYPECHECK, ACTION_VALIDATE, actionsCompleted, defaultCollationName, defaultMode, defaultXPathNamespace, expandText, extensionNamespaces, IGNORED_INSTRUCTION, REPORT_ALWAYS, REPORT_DYNAMICALLY_UNLESS_FALLBACK_AVAILABLE, REPORT_IF_INSTANTIATED, REPORT_STATICALLY_UNLESS_FALLBACK_AVAILABLE, REPORT_UNLESS_FORWARDS_COMPATIBLE, reportingCircumstances, staticContext, validationError, version, YES_NO

Fields inherited from class net.sf.saxon.tree.linked.NodeImpl

NODE_LETTER

Fields inherited from interface net.sf.saxon.om.NodeInfo

IS_DTD_TYPE, IS_NILLED

Constructor Summary

Constructors

Constructor and Description
XSLCharacterMap()

Method Summary

Modifier and Type	Method and Description
void	assemble(IntHashMap<String> map) Assemble all the mappings defined by this character map, adding them to a HashMap that maps integer codepoints to strings
void	compileDeclaration(Compilation compilation, ComponentDeclaration decl) Compile a declaration in the stylesheet tree for use at run-time.
StructuredQName	getCharacterMapName() Get the fingerprint of the name of this character map
boolean	isDeclaration() Ask whether this node is a declaration, that is, a permitted child of xsl:stylesheet (including xsl:include and xsl:import).
boolean	isRedundant() Test whether this character map is redundant (because another with the same name has higher import precedence).
void	prepareAttributes() Validate the attributes on this instruction
void	validate(ComponentDeclaration decl) Check that the stylesheet element is valid.

Methods inherited from class net.sf.saxon.style.StyleElement

allocateLocalSlots, allocateLocation, bindLocalVariable, bindVariable, changesRetainedStaticContext, checkAttributeValue, checkEmpty, checkSortComesFirst, checkTopLevel, checkUnknownAttribute, compile, compileContentValueTemplate, compileError, compileError, compileError, compileError, compileErrorInAttribute, compileSequenceConstructor, compileSequenceConstructor, compileWarning, compileWarning, definesExcludedNamespace, definesExtensionElement, fallbackProcessing, findAncestorElement, findCollation, fixupReferences, forwardsCompatibleModeIsEnabled, generateId, getAttributeValue, getBaseURI, getBindingInformation, getCompilation, getConfiguration, getConstructType, getContainingPackage, getContainingSlotManager, getContainingStylesheet, getDeclaredVisibility, getDefaultCollationName, getDefaultMode, getDefaultValidation, getDefaultXPathNamespace, getEffectiveVersion, getEffectiveVersionAsString, getLastChildInstruction, getNamespaceResolver, getObjectName, getOverriddenComponent, getPackageData, getPrincipalStylesheetModule, getProperties, getProperty, getSchemaType, getStaticContext, getStaticContext, getTypeAnnotation, getUsedAttributeSets, getUsedPackage, getVisibility, getWithParamInstructions, getXslOriginal, hasImplicitBinding, index, interpretVisibilityValue, invalidAttribute, isActionCompleted, isConstructingComplexContent, isExcludedNamespace, isExpandingText, isExplaining, isExtensionNamespace, isInstruction, isNo, isPermittedChild, isSchemaAware, issueWarning, issueWarning, isTopLevel, isWithinDeclaredStreamableConstruct, isYes, makeAttributeValueTemplate, makeExpression, makeExpressionVisitor, makeExtendedSequenceType, makeNamespaceContext, makePattern, makeQName, makeRetainedStaticContext, makeSequenceType, makeSortKeys, makeTraceInstruction, markTailCalls, mayContainFallback, mayContainParam, mayContainSequenceConstructor, postValidate, processAllAttributes, processAttributes, processBooleanAttribute, processDefaultCollationAttribute, processDefaultMode, processDefaultValidationAttribute, processDefaultXPathNamespaceAttribute, processExcludedNamespaces, processExpandTextAttribute, processExtensionElementAttribute, processStandardAttributes, processStreamableAtt, processVersionAttribute, reportAbsence, seesAvuncularVariables, setActionCompleted, setCompilation, setIgnoreInstruction, setObjectName, setValidationError, substituteFor, typeCheck, typeCheck, undeclaredNamespaceError, validateChildren, validateSubtree, validateValidationAttribute, xPath10ModeIsEnabled

Methods inherited from class net.sf.saxon.tree.linked.ElementImpl

addAttribute, addNamespace, copy, delete, fixupInsertedNamespaces, generateId, getAttributeList, getAttributeValue, getColumnNumber, getDeclaredNamespaces, getLineNumber, getNamespaceList, getNodeKind, getNodeName, getRoot, getSchemaType, getSystemId, getURIForPrefix, gsetAttributeCollection, initialise, isId, isIdref, isInScopeNamespace, isNilled, iteratePrefixes, removeAttribute, removeTypeAnnotation, rename, replaceStringValue, setAttributeList, setLocation, setNamespaceDeclarations, setNamespaceList, setNilled, setNodeName, setSystemId, setTypeAnnotation

Methods inherited from class net.sf.saxon.tree.linked.ParentNodeImpl

addChild, compact, getFirstChild, getLastChild, getNthChild, getNumberOfChildren, getRawSequenceNumber, getSequenceNumber, getStringValue, getStringValueCS, hasChildNodes, insertChildren, insertChildrenAt, iterateChildren, removeChild, replaceChildrenAt, setChildren, setRawSequenceNumber

Methods inherited from class net.sf.saxon.tree.linked.NodeImpl

atomize, compareOrder, effectiveBooleanValue, equals, getDisplayName, getFingerprint, getLocalPart, getNamePool, getNextInDocument, getNextSibling, getParent, getPhysicalRoot, getPrefix, getPreviousInDocument, getPreviousSibling, getRawParent, getSiblingPosition, getSuccessorElement, getTreeInfo, getURI, hasFingerprint, head, insertSiblings, isDeleted, iterate, iterateAxis, iterateAxis, newBuilder, replace, saveLocation, setRawParent, setSiblingPosition

Methods inherited from class java.lang.Object

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

Methods inherited from interface net.sf.saxon.om.NodeInfo

equals, getGenre, getPublicId, hashCode, isSameNodeInfo, isStreamed, toShortString

Methods inherited from interface net.sf.saxon.om.Item

getLength, itemAt, iterator, reduce, subsequence, toGroundedValue

Methods inherited from interface net.sf.saxon.om.GroundedValue

asIterable, materialize

Methods inherited from interface net.sf.saxon.om.Sequence

makeRepeatable

Methods inherited from interface java.lang.Iterable

forEach, spliterator

Field Detail

use

String use

characterMapElements

List<XSLCharacterMap> characterMapElements

validated

boolean validated

redundant

boolean redundant

Constructor Detail

XSLCharacterMap

public XSLCharacterMap()

Method Detail

isDeclaration

public boolean isDeclaration()

Ask whether this node is a declaration, that is, a permitted child of xsl:stylesheet (including xsl:include and xsl:import).

Overrides:

isDeclaration in class StyleElement

Returns:

true for this element

getCharacterMapName

public StructuredQName getCharacterMapName()

Get the fingerprint of the name of this character map

Returns:

the fingerprint value

isRedundant

public boolean isRedundant()

Test whether this character map is redundant (because another with the same name has higher import precedence). Note that a character map is not considered redundant simply because it is not referenced in an xsl:output declaration; we allow character-maps to be selected at run-time using the setOutputProperty() API.

Returns:

true if this character map is redundant

prepareAttributes

public void prepareAttributes()
                       throws XPathException

Validate the attributes on this instruction

Specified by:

prepareAttributes in class StyleElement

Throws:

XPathException

validate

public void validate(ComponentDeclaration decl)
              throws XPathException

Description copied from class: StyleElement

Check that the stylesheet element is valid. This is called once for each element, after the entire tree has been built. As well as validation, it can perform first-time initialisation. The default implementation does nothing; it is normally overriden in subclasses.

Overrides:

validate in class StyleElement

Parameters:

decl - the declaration to be validated

Throws:

XPathException - if any error is found during validation

assemble

public void assemble(IntHashMap<String> map)

Assemble all the mappings defined by this character map, adding them to a HashMap that maps integer codepoints to strings

Parameters:

map - an IntHash map populated with the character mappings

compileDeclaration

public void compileDeclaration(Compilation compilation,
                               ComponentDeclaration decl)
                        throws XPathException

Description copied from class: StyleElement

Compile a declaration in the stylesheet tree for use at run-time.

Overrides:

compileDeclaration in class StyleElement

Parameters:

compilation - the compilation episode

decl - the containing top-level declaration, for example xsl:function or xsl:template

Throws:

XPathException - if compilation fails