net.sf.saxon.style
Class XSLCharacterMap

java.lang.Object
  extended bynet.sf.saxon.om.AbstractNode
      extended bynet.sf.saxon.tree.NodeImpl
          extended bynet.sf.saxon.tree.ParentNodeImpl
              extended bynet.sf.saxon.tree.ElementImpl
                  extended bynet.sf.saxon.tree.ElementWithAttributes
                      extended bynet.sf.saxon.style.StyleElement
                          extended bynet.sf.saxon.style.XSLCharacterMap
All Implemented Interfaces:
javax.xml.transform.dom.DOMLocator, org.w3c.dom.Element, Item, org.xml.sax.Locator, org.w3c.dom.NamedNodeMap, org.w3c.dom.Node, NodeInfo, javax.xml.transform.Source, javax.xml.transform.SourceLocator

public class XSLCharacterMap
extends StyleElement

An xsl:character-map declaration in the stylesheet.


Field Summary
(package private)  java.util.List characterMapElements
           
(package private)  int fingerprint
           
(package private)  boolean redundant
           
(package private)  java.lang.String use
           
(package private)  boolean validated
           
 
Fields inherited from class net.sf.saxon.style.StyleElement
defaultXPathNamespace, extensionNamespaces, REPORT_ALWAYS, REPORT_IF_INSTANTIATED, REPORT_UNLESS_FORWARDS_COMPATIBLE, reportingCircumstances, staticContext, validationError, version
 
Fields inherited from class net.sf.saxon.tree.ElementWithAttributes
attributeList, namespaceList
 
Fields inherited from class net.sf.saxon.tree.ElementImpl
nameCode, root, sequence
 
Fields inherited from class net.sf.saxon.tree.NodeImpl
index, parent
 
Fields inherited from class net.sf.saxon.om.AbstractNode
NODE_LETTER
 
Fields inherited from interface org.w3c.dom.Node
ATTRIBUTE_NODE, CDATA_SECTION_NODE, COMMENT_NODE, DOCUMENT_FRAGMENT_NODE, DOCUMENT_NODE, DOCUMENT_TYPE_NODE, ELEMENT_NODE, ENTITY_NODE, ENTITY_REFERENCE_NODE, NOTATION_NODE, PROCESSING_INSTRUCTION_NODE, TEXT_NODE
 
Fields inherited from interface net.sf.saxon.om.NodeInfo
ALL_NAMESPACES, LOCAL_NAMESPACES, NO_NAMESPACES
 
Constructor Summary
XSLCharacterMap()
           
 
Method Summary
 void assemble(java.util.HashMap map)
          Assemble all the mappings defined by this character map, adding them to a HashMap that maps integer codepoints to strings
 Instruction compile()
          Get a pattern that will match the context node
 int getCharacterMapFingerprint()
          Get the fingerprint of the name of this character map
 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()
          Check that the stylesheet element is valid.
 
Methods inherited from class net.sf.saxon.style.StyleElement
allocateSlots, backwardsCompatibleModeIsEnabled, bindVariable, checkEmpty, checkTopLevel, checkUnknownAttribute, checkWithinTemplate, compileChildren, compileError, compileError, compileWarning, definesExcludedNamespace, definesExtensionElement, fallbackProcessing, fixupReferences, forwardsCompatibleModeIsEnabled, getAttributeSets, getAttributeValue, getCommonChildItemType, getConfiguration, getContainingStyleSheet, getContextItemType, getDefaultXPathNamespace, getLastChildInstruction, getLineNumber, getOwningProcedure, getPrecedence, getPreparedStyleSheet, getPrincipalStyleSheet, getReturnedItemType, getSchemaType, getStyleSheetFunction, getTargetNamePool, getTypeAnnotation, getURIForPrefix, getVariableBinding, getVersion, getWithParamInstructions, isExcludedNamespace, isExtensionNamespace, isInstruction, issueWarning, issueWarning, isTopLevel, makeAttributeValueTemplate, makeExpression, makeNameCode, makeNamespaceContext, makePattern, makeSequenceType, makeSortKeys, markTailCalls, mayContainFallback, mayContainTemplateBody, postValidate, processAllAttributes, processAttributes, processDefaultXPathNamespaceAttribute, processExcludedNamespaces, processExtensionElementAttribute, processVersionAttribute, reportAbsence, setLineNumber, setValidationError, substituteFor, typeCheck, typeCheck, validateChildren, validateSubtree
 
Methods inherited from class net.sf.saxon.tree.ElementWithAttributes
addNamespaceNodes, copy, getAttribute, getAttributeList, getAttributeNode, getAttributeNodeNS, getAttributeNS, getAttributes, getAttributeValue, getLength, getNamedItem, getNamedItemNS, getNamespaceCodes, getPrefixForURI, getURICodeForPrefix, hasAttribute, hasAttributeNS, hasAttributes, initialise, item, outputNamespaceNodes, removeAttribute, removeAttributeNode, removeAttributeNS, removeNamedItem, removeNamedItemNS, setAttribute, setAttributeNode, setAttributeNodeNS, setAttributeNS, setNamedItem, setNamedItemNS, setNamespaceDeclarations
 
Methods inherited from class net.sf.saxon.tree.ElementImpl
addChild, compact, enumerateChildren, generateId, getBaseURI, getDocumentRoot, getFirstChild, getLastChild, getNameCode, getNodeKind, getNodeValue, getNthChild, getRoot, getSequenceNumber, getStringValue, getSystemId, hasChildNodes, setNameCode, setSystemId, useChildrenArray
 
Methods inherited from class net.sf.saxon.tree.NodeImpl
compareOrder, copy, getDisplayName, getDocumentElement, getFingerprint, getLocalPart, getNamePool, getNextInDocument, getNextSibling, getOriginatingNode, getParent, getPrefix, getPreviousInDocument, getPreviousSibling, getURI, isSameNode, iterateAxis, iterateAxis
 
Methods inherited from class net.sf.saxon.om.AbstractNode
appendChild, appendData, cloneNode, createAttribute, createAttributeNS, createCDATASection, createComment, createDocumentFragment, createElement, createElementNS, createEntityReference, createProcessingInstruction, createTextNode, deleteData, disallowUpdate, getChildNodes, getColumnNumber, getData, getDoctype, getDocumentNumber, getElementById, getElementsByTagName, getElementsByTagNameNS, getImplementation, getLocalName, getName, getNamespaceURI, getNodeName, getNodeType, getOwnerDocument, getOwnerElement, getParentNode, getPublicId, getSpecified, getTagName, getTypeAnnotation, getTypedValue, getValue, importNode, insertBefore, insertData, isSupported, normalize, removeChild, replaceChild, replaceData, setData, setNodeValue, setPrefix, setValue, splitText, substringData, supports
 
Methods inherited from class java.lang.Object
clone, equals, finalize, getClass, hashCode, notify, notifyAll, toString, wait, wait, wait
 
Methods inherited from interface org.xml.sax.Locator
getColumnNumber, getPublicId, getSystemId
 
Methods inherited from interface org.w3c.dom.Element
getElementsByTagName, getElementsByTagNameNS, getTagName
 
Methods inherited from interface org.w3c.dom.Node
appendChild, cloneNode, getChildNodes, getFirstChild, getLastChild, getLocalName, getNamespaceURI, getNextSibling, getNodeName, getNodeType, getNodeValue, getOwnerDocument, getParentNode, getPrefix, getPreviousSibling, hasChildNodes, insertBefore, isSupported, normalize, removeChild, replaceChild, setNodeValue, setPrefix
 

Field Detail

fingerprint

int fingerprint

use

java.lang.String use

characterMapElements

java.util.List characterMapElements

validated

boolean validated

redundant

boolean redundant
Constructor Detail

XSLCharacterMap

public XSLCharacterMap()
Method Detail

getCharacterMapFingerprint

public int getCharacterMapFingerprint()
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.


prepareAttributes

public void prepareAttributes()
                       throws javax.xml.transform.TransformerConfigurationException
Validate the attributes on this instruction

Specified by:
prepareAttributes in class StyleElement
Throws:
javax.xml.transform.TransformerConfigurationException

validate

public void validate()
              throws javax.xml.transform.TransformerConfigurationException
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
Throws:
javax.xml.transform.TransformerConfigurationException

assemble

public void assemble(java.util.HashMap map)
Assemble all the mappings defined by this character map, adding them to a HashMap that maps integer codepoints to strings


compile

public Instruction compile()
                    throws javax.xml.transform.TransformerConfigurationException
Get a pattern that will match the context node

Specified by:
compile in class StyleElement
Returns:
null if no such pattern can be identified
Throws:
javax.xml.transform.TransformerConfigurationException