Package com.icl.saxon.style
Class SAXONHandler
-
- All Implemented Interfaces:
NodeHandler,NodeInfo,DOMLocator,Source,SourceLocator,Element,NamedNodeMap,Node,Locator
public class SAXONHandler extends XSLTemplate
A saxon:handler element in the style sheet: defines a Java nodehandler that can be used to process a node in place of an XSLT template
-
-
Field Summary
Fields Modifier and Type Field Description protected intsequence-
Fields inherited from class com.icl.saxon.style.XSLTemplate
match, modeNameCode, needsStackFrame, priority, prioritySpecified, procedure, templateFingerprint
-
Fields inherited from class com.icl.saxon.style.StyleElement
attributeSets, extensionNamespaces, REPORT_ALWAYS, REPORT_IF_INSTANTIATED, REPORT_UNLESS_FORWARDS_COMPATIBLE, reportingCircumstances, staticContext, validationError, version
-
Fields inherited from class com.icl.saxon.tree.ElementWithAttributes
attributeList, namespaceList
-
Fields inherited from class com.icl.saxon.tree.ElementImpl
nameCode, root
-
Fields inherited from class com.icl.saxon.tree.NodeImpl
emptyArray, index, parent
-
Fields inherited from class com.icl.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_POSITION_CONTAINED_BY, DOCUMENT_POSITION_CONTAINS, DOCUMENT_POSITION_DISCONNECTED, DOCUMENT_POSITION_FOLLOWING, DOCUMENT_POSITION_IMPLEMENTATION_SPECIFIC, DOCUMENT_POSITION_PRECEDING, DOCUMENT_TYPE_NODE, ELEMENT_NODE, ENTITY_NODE, ENTITY_REFERENCE_NODE, NOTATION_NODE, PROCESSING_INSTRUCTION_NODE, TEXT_NODE
-
-
Constructor Summary
Constructors Constructor Description SAXONHandler()
-
Method Summary
All Methods Instance Methods Concrete Methods Modifier and Type Method Description voidaddChild(NodeImpl node, int index)Add a child node to this node.voidcheckUnknownAttribute(int nc)Check whether an unknown attribute is permitted.voidcompact(int size)Compact the space used by this nodevoidcopyStringValue(Outputter out)Copy the string-value of this node to a given outputtervoiddropChildren()Drop a branch of the tree.AxisEnumerationenumerateChildren(NodeTest test)Get an enumeration of the children of this nodevoidexpand(Context context)Invoke the node handler.NodeListgetChildNodes()Return aNodeListthat contains all children of this node.NodegetFirstChild()Get the first child node of the elementNodegetLastChild()Get the last child node of the elementStringgetNodeValue()Get the node value as defined in the DOM.protected NodeImplgetNthChild(int n)Get the nth child node of the element (numbering from 0)protected longgetSequenceNumber()Get the node sequence number (in document order).StringgetStringValue()Return the string-value of the node, that is, the concatenation of the character content of all descendent elements and text nodes.booleanhasChildNodes()Determine if the node has any children.protected NodeHandlermakeHandler(String className)Load a named node handler and check it is OK.voidpreprocess()Preprocess: this registers the node handler with the controllervoidprocess(Context context)Process saxon:handler element.voidremoveChild(int index)Remove node at given index.voidrenumberChildren()Renumber the children of a given parent node.voiduseChildrenArray(NodeImpl[] array)Supply an array to be used for the array of children.voidvalidate()Check that the element is valid.-
Methods inherited from class com.icl.saxon.style.XSLTemplate
bindVariable, getMinImportPrecedence, getProcedure, getTemplateFingerprint, mayContainTemplateBody, needsStackFrame, prepareAttributes, start, traceExpand
-
Methods inherited from class com.icl.saxon.style.StyleElement
checkEmpty, checkNotTopLevel, checkTopLevel, checkWithinTemplate, compileError, compileError, definesExcludedNamespace, definesExtensionElement, doesPostProcessing, fallbackProcessing, findAttributeSets, forwardsCompatibleModeIsEnabled, getContainingStyleSheet, getPrecedence, getPreparedStyleSheet, getPrincipalStyleSheet, getStandardNames, getStyleSheetFunction, getVariableBinding, getVariableNames, getVersion, handleSortKeys, isExcludedNamespace, isExtensionNamespace, isInstruction, isTopLevel, makeAttributeValueTemplate, makeExpression, makePattern, processAllAttributes, processAttributes, processAttributeSets, processChildren, processExcludedNamespaces, processExtensionElementAttribute, processVersionAttribute, reportAbsence, setValidationError, styleError, styleError, substituteFor, validateChildren, validateSubtree
-
Methods inherited from class com.icl.saxon.tree.ElementWithAttributes
addNamespaceNodes, copy, getAttribute, getAttributeList, getAttributeNode, getAttributeNodeNS, getAttributeNS, getAttributes, getAttributeValue, getAttributeValue, 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 com.icl.saxon.tree.ElementImpl
copy, generateId, getBaseURI, getDocumentRoot, getLineNumber, getNameCode, getNodeType, getSystemId, makeNameCode, setLineNumber, setNameCode, setSystemId
-
Methods inherited from class com.icl.saxon.tree.NodeImpl
compareOrder, getDisplayName, getDocumentElement, getEnumeration, getFingerprint, getLocalName, getNamePool, getNextInDocument, getNextSibling, getOriginatingNode, getParent, getPrefix, getPreviousInDocument, getPreviousSibling, getURI, isSameNodeInfo, removeNode
-
Methods inherited from class com.icl.saxon.om.AbstractNode
appendChild, appendData, cloneNode, compareDocumentPosition, createAttribute, createAttributeNS, createCDATASection, createComment, createDocumentFragment, createElement, createElementNS, createEntityReference, createProcessingInstruction, createTextNode, deleteData, disallowUpdate, getColumnNumber, getData, getDoctype, getElementById, getElementsByTagName, getElementsByTagNameNS, getFeature, getImplementation, getName, getNamespaceURI, getNodeName, getOwnerDocument, getOwnerElement, getParentNode, getPublicId, getSchemaTypeInfo, getSpecified, getTagName, getTextContent, getUserData, getValue, getWholeText, importNode, insertBefore, insertData, isDefaultNamespace, isElementContentWhitespace, isEqualNode, isId, isSameNode, isSupported, lookupNamespaceURI, lookupPrefix, normalize, removeChild, replaceChild, replaceData, replaceWholeText, setData, setIdAttribute, setIdAttributeNode, setIdAttributeNS, setNodeValue, setPrefix, setTextContent, setUserData, 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.w3c.dom.Element
getElementsByTagName, getElementsByTagNameNS, getSchemaTypeInfo, getTagName, setIdAttribute, setIdAttributeNode, setIdAttributeNS
-
Methods inherited from interface org.xml.sax.Locator
getColumnNumber, getLineNumber, getPublicId, getSystemId
-
Methods inherited from interface org.w3c.dom.Node
appendChild, cloneNode, compareDocumentPosition, getBaseURI, getChildNodes, getFeature, getFirstChild, getLastChild, getLocalName, getNamespaceURI, getNextSibling, getNodeName, getNodeType, getNodeValue, getOwnerDocument, getParentNode, getPrefix, getPreviousSibling, getTextContent, getUserData, hasChildNodes, insertBefore, isDefaultNamespace, isEqualNode, isSameNode, isSupported, lookupNamespaceURI, lookupPrefix, normalize, removeChild, replaceChild, setNodeValue, setPrefix, setTextContent, setUserData
-
-
-
-
Method Detail
-
checkUnknownAttribute
public void checkUnknownAttribute(int nc) throws TransformerConfigurationExceptionDescription copied from class:StyleElementCheck whether an unknown attribute is permitted.- Overrides:
checkUnknownAttributein classStyleElement- Parameters:
nc- The name code of the attribute name- Throws:
TransformerConfigurationException
-
validate
public void validate() throws TransformerConfigurationExceptionDescription copied from class:StyleElementCheck that the 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:
validatein classXSLTemplate- Throws:
TransformerConfigurationException
-
preprocess
public void preprocess() throws TransformerConfigurationExceptionPreprocess: this registers the node handler with the controller- Overrides:
preprocessin classXSLTemplate- Throws:
TransformerConfigurationException
-
process
public void process(Context context) throws TransformerException
Process saxon:handler element. This is called while all the top-level nodes are being processed in order, so it does nothing.- Overrides:
processin classXSLTemplate- Parameters:
context- The context in the source XML document, giving access to the current node, the current variables, etc.- Throws:
TransformerException
-
expand
public void expand(Context context) throws TransformerException
Invoke the node handler. Called directly only when doing XSLCallTemplate- Overrides:
expandin classXSLTemplate- Throws:
TransformerException
-
makeHandler
protected NodeHandler makeHandler(String className) throws TransformerConfigurationException
Load a named node handler and check it is OK.
-
getSequenceNumber
protected final long getSequenceNumber()
Get the node sequence number (in document order). Sequence numbers are monotonic but not consecutive. In the current implementation, parent nodes (elements and roots) have a zero least-significant word, while namespaces, attributes, text nodes, comments, and PIs have the top word the same as their owner and the bottom half reflecting their relative position.- Overrides:
getSequenceNumberin classNodeImpl
-
hasChildNodes
public final boolean hasChildNodes()
Determine if the node has any children.- Specified by:
hasChildNodesin interfaceNode- Specified by:
hasChildNodesin interfaceNodeInfo- Overrides:
hasChildNodesin classNodeImpl- Returns:
trueif the node has any children,falseif the node has no children.
-
enumerateChildren
public final AxisEnumeration enumerateChildren(NodeTest test)
Get an enumeration of the children of this node
-
getFirstChild
public final Node getFirstChild()
Get the first child node of the element- Specified by:
getFirstChildin interfaceNode- Overrides:
getFirstChildin classNodeImpl- Returns:
- the first child node of the required type, or null if there are no children
-
getLastChild
public final Node getLastChild()
Get the last child node of the element- Specified by:
getLastChildin interfaceNode- Overrides:
getLastChildin classNodeImpl- Returns:
- the last child of the element, or null if there are no children
-
getChildNodes
public final NodeList getChildNodes()
Return aNodeListthat contains all children of this node. If there are no children, this is aNodeListcontaining no nodes.- Specified by:
getChildNodesin interfaceNode- Overrides:
getChildNodesin classNodeImpl
-
getNthChild
protected final NodeImpl getNthChild(int n)
Get the nth child node of the element (numbering from 0)- Returns:
- the last child of the element, or null if there is no n'th child
-
getStringValue
public String getStringValue()
Return the string-value of the node, that is, the concatenation of the character content of all descendent elements and text nodes.- Returns:
- the accumulated character content of the element, including descendant elements.
-
copyStringValue
public void copyStringValue(Outputter out) throws TransformerException
Copy the string-value of this node to a given outputter- Specified by:
copyStringValuein interfaceNodeInfo- Overrides:
copyStringValuein classAbstractNode- Throws:
TransformerException
-
useChildrenArray
public void useChildrenArray(NodeImpl[] array)
Supply an array to be used for the array of children. For system use only.
-
addChild
public void addChild(NodeImpl node, int index)
Add a child node to this node. For system use only. Note: normalizing adjacent text nodes is the responsibility of the caller.
-
removeChild
public void removeChild(int index)
Remove node at given index. Will always be followed by a renumberChildren().
-
renumberChildren
public void renumberChildren()
Renumber the children of a given parent node. For system use only
-
dropChildren
public void dropChildren()
Drop a branch of the tree. The target element remains in the tree, but its children are disconnected from the parent. Unless there are other references to the children (e.g. in a variable) they will be deleted from memory next time the garbage collector comes round.
-
compact
public void compact(int size)
Compact the space used by this node
-
getNodeValue
public String getNodeValue()
Get the node value as defined in the DOM. This is not the same as the XPath string-value.- Specified by:
getNodeValuein interfaceNode- Overrides:
getNodeValuein classAbstractNode
-
-