net.sf.saxon.style
Class XSLFunction

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.XSLFunction
All Implemented Interfaces:
DOMLocator, Element, FunctionSignature, Item, Locator, NamedNodeMap, Node, NodeInfo, Source, SourceLocator

public class XSLFunction
extends StyleElement
implements FunctionSignature

Handler for xsl:function elements in stylesheet (XSLT 2.0).
Attributes:
name gives the name of the function saxon:memo-function=yes|no indicates whether it acts as a memo function.


Field Summary
(package private)  List references
           
 
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
XSLFunction()
           
 
Method Summary
 Instruction compile()
          Compile the function definition to create an executable representation
 void fixupReferences()
          Notify all references to this function of the data type.
 SequenceType[] getArgumentTypes()
          Get the required types of the arguments
 ItemType getContextItemType()
          Get the type of the context item within this instruction
 int getFunctionFingerprint()
          Get the fingerprint of the name of this function.
 int getNumberOfArguments()
          Get the number of arguments declared by this function (that is, its arity).
 Procedure getProcedure()
          Get associated Procedure (for details of stack frame).
 SequenceType getResultType()
          Get the type of value returned by this function
 boolean isOverriding()
          Is override="yes"?.
 boolean mayContainTemplateBody()
          Determine whether this type of element is allowed to contain a template-body.
 void prepareAttributes()
          Set the attribute list for the element.
 void registerReference(UserFunctionCall ref)
          Method called by UserFunctionCall to register the function call for subsequent fixup.
 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, forwardsCompatibleModeIsEnabled, getAttributeSets, getAttributeValue, getCommonChildItemType, getConfiguration, getContainingStyleSheet, 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, 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

references

List references
Constructor Detail

XSLFunction

public XSLFunction()
Method Detail

registerReference

public void registerReference(UserFunctionCall ref)
Method called by UserFunctionCall to register the function call for subsequent fixup.

Parameters:
ref - the UserFunctionCall to be registered

prepareAttributes

public void prepareAttributes()
                       throws TransformerConfigurationException
Description copied from class: StyleElement
Set the attribute list for the element. This is called to process the attributes (note the distinction from processAttributes in the superclass). Must be supplied in a subclass

Specified by:
prepareAttributes in class StyleElement
Throws:
TransformerConfigurationException

mayContainTemplateBody

public boolean mayContainTemplateBody()
Determine whether this type of element is allowed to contain a template-body.

Overrides:
mayContainTemplateBody in class StyleElement
Returns:
true: yes, it may contain a general template-body

isOverriding

public boolean isOverriding()
Is override="yes"?.

Returns:
true if override="yes" was specified, otherwise false

fixupReferences

public void fixupReferences()
                     throws TransformerConfigurationException
Notify all references to this function of the data type.

Overrides:
fixupReferences in class StyleElement
Throws:
TransformerConfigurationException

validate

public void validate()
              throws 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:
TransformerConfigurationException

getContextItemType

public ItemType getContextItemType()
Get the type of the context item within this instruction

Overrides:
getContextItemType in class StyleElement
Returns:
the static type of the context item, or Type.EMPTY if it is known that there will be no context item

compile

public Instruction compile()
                    throws TransformerConfigurationException
Compile the function definition to create an executable representation

Specified by:
compile in class StyleElement
Returns:
an Instruction, or null. The instruction returned is actually rather irrelevant; the compile() method has the side-effect of binding all references to the function to the executable representation. This may be a FunctionInstr or a UserFunction depending on the complexity of the function body.
Throws:
TransformerConfigurationException

getProcedure

public Procedure getProcedure()
Get associated Procedure (for details of stack frame).

Returns:
the associated Procedure object

getFunctionFingerprint

public int getFunctionFingerprint()
Get the fingerprint of the name of this function.

Specified by:
getFunctionFingerprint in interface FunctionSignature
Returns:
the fingerprint of the name

getResultType

public SequenceType getResultType()
Get the type of value returned by this function

Specified by:
getResultType in interface FunctionSignature
Returns:
the declared result type, or the inferred result type if this is more precise

getNumberOfArguments

public int getNumberOfArguments()
Get the number of arguments declared by this function (that is, its arity).

Specified by:
getNumberOfArguments in interface FunctionSignature
Returns:
the arity of the function

getArgumentTypes

public SequenceType[] getArgumentTypes()
Get the required types of the arguments

Specified by:
getArgumentTypes in interface FunctionSignature
Returns:
an array of SequenceType objects, representing the required types of each of the formal arguments