Package net.sf.saxon.style
Class XSLFunction
java.lang.Object
net.sf.saxon.tree.NodeImpl
net.sf.saxon.tree.ElementImpl
net.sf.saxon.style.StyleElement
net.sf.saxon.style.XSLFunction
- All Implemented Interfaces:
Serializable
,Source
,SourceLocator
,LocationProvider
,SaxonLocator
,PullEvent
,Container
,FingerprintedNode
,Item
,MutableNodeInfo
,NamespaceResolver
,NodeInfo
,SiblingCountingNode
,ValueRepresentation
,StylesheetProcedure
,InstructionInfo
,Locator
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.
Attributes:
name gives the name of the function saxon:memo-function=yes|no indicates whether it acts as a memo function.
- See Also:
-
Field Summary
FieldsFields inherited from class net.sf.saxon.style.StyleElement
defaultCollationName, defaultXPathNamespace, extensionNamespaces, REPORT_ALWAYS, REPORT_IF_INSTANTIATED, REPORT_UNLESS_FALLBACK_AVAILABLE, REPORT_UNLESS_FORWARDS_COMPATIBLE, reportingCircumstances, staticContext, validationError, version
Fields inherited from class net.sf.saxon.tree.ElementImpl
attributeList, nameCode, namespaceList, typeCode
Fields inherited from class net.sf.saxon.tree.NodeImpl
index, NODE_LETTER, parent
Fields inherited from interface net.sf.saxon.om.NodeInfo
ALL_NAMESPACES, EMPTY_NAMESPACE_LIST, IS_DTD_TYPE, IS_NILLED, LOCAL_NAMESPACES, NO_NAMESPACES
Fields inherited from interface net.sf.saxon.om.ValueRepresentation
EMPTY_VALUE_ARRAY
-
Constructor Summary
Constructors -
Method Summary
Modifier and TypeMethodDescriptionvoid
Add a child node to this node.void
compact
(int size) Compact the space used by this nodecompile
(Executable exec) Compile the function definition to create an executable representationprotected final AxisIterator
enumerateChildren
(NodeTest test) Get an enumeration of the children of this nodevoid
Notify all references to this function of the data type.Get the compiled functionint
Get the type of construct.final NodeInfo
Get the first child node of the elementfinal NodeInfo
Get the last child node of the elementprotected final NodeImpl
getNthChild
(int n) Get the nth child node of the element (numbering from 0)int
Get the number of arguments declared by this function (that is, its arity).int
Determine how many children the node hasGet a name identifying the object of the expression, for example a function name, template name, variable name, key name, element name, etc.Get the type of value returned by this functionprotected final long
Get the node sequence number (in document order).Get associated Procedure (for details of stack frame).Return the string-value of the node, that is, the concatenation of the character content of all descendent elements and text nodes.Get the value of the item as a CharSequence.final boolean
Determine if the node has any children.void
insertChildren
(NodeInfo[] source, boolean atStart, boolean inherit) Insert copies of a sequence of nodes as children of this node.protected void
insertChildrenAt
(NodeInfo[] source, int index, boolean inherit) Insert children before or after a given existing childboolean
Is override="yes"?.protected boolean
isPermittedChild
(StyleElement child) Specify that xsl:param is a permitted childprotected boolean
Determine whether this type of element is allowed to contain an xsl:param elementboolean
Determine whether this type of element is allowed to contain a template-body.void
Set the attribute list for the element.void
Method called by UserFunctionCall to register the function call for subsequent fixup.protected void
removeChild
(NodeImpl child) Remove a given childprotected void
replaceChildrenAt
(NodeInfo[] source, int index, boolean inherit) Replace child at a given index by new childrenvoid
Set the definitions of the parameters in the compiled function, as an array.protected void
useChildrenArray
(NodeImpl[] array) Supply an array to be used for the array of children.void
validate()
Check that the stylesheet element is valid.Methods inherited from class net.sf.saxon.style.StyleElement
allocateLocationId, allocatePatternSlots, allocateSlots, backwardsCompatibleModeIsEnabled, bindVariable, checkEmpty, checkSortComesFirst, checkTopLevel, checkUnknownAttribute, checkWithinTemplate, compileError, compileError, compileError, compileSequenceConstructor, compileWarning, definesExcludedNamespace, definesExtensionElement, fallbackProcessing, forwardsCompatibleModeIsEnabled, getAllStylesheetFunctions, getAttributeSets, getAttributeValue, getColumnNumber, getCommonChildItemType, getContainingSlotManager, getContainingStylesheet, getDefaultCollationName, getDefaultXPathNamespace, getExecutable, getHostLanguage, getLastChildInstruction, getLineNumber, getLocationProvider, getNamespaceResolver, getPrecedence, getPreparedStylesheet, getPrincipalStylesheet, getProperties, getProperty, getReturnedItemType, getSchemaType, getStaticContext, getStylesheetFunction, getSystemId, getTypeAnnotation, getVersion, getWithParamInstructions, isExcludedNamespace, isExplaining, isExtensionNamespace, isInstruction, issueWarning, issueWarning, isTopLevel, makeAttributeValueTemplate, makeExpression, makeExpressionVisitor, makeNamespaceContext, makePattern, makeQName, makeSequenceType, makeSortKeys, makeTraceInstruction, markTailCalls, mayContainFallback, postValidate, processAllAttributes, processAttributes, processDefaultCollationAttribute, processDefaultXPathNamespaceAttribute, processExcludedNamespaces, processExtensionElementAttribute, processVersionAttribute, replaceSubExpression, reportAbsence, setObjectName, setValidationError, substituteFor, typeCheck, typeCheck, undeclaredNamespaceError, validateChildren, validateSubtree
Methods inherited from class net.sf.saxon.tree.ElementImpl
addNamespace, copy, delete, fixupInsertedNamespaces, generateId, getAttributeList, getAttributeValue, getAttributeValue, getBaseURI, getColumnNumber, getDeclaredNamespaces, getDocumentRoot, getInScopeNamespaceCodes, getLineNumber, getNameCode, getNodeKind, getPrefixForURI, getRoot, getSystemId, getTypeAnnotation, getURICodeForPrefix, getURICodeForPrefixCode, getURIForPrefix, initialise, isNilled, iteratePrefixes, putAttribute, removeAttribute, removeTypeAnnotation, rename, replaceStringValue, setLineAndColumn, setLocation, setNameCode, setNamespaceDeclarations, setSystemId, setTypeAnnotation
Methods inherited from class net.sf.saxon.tree.NodeImpl
atomize, compareOrder, equals, getConfiguration, getDisplayName, getDocumentNumber, getFingerprint, getLocalPart, getNamePool, getNextInDocument, getNextSibling, getParent, getPhysicalRoot, getPrefix, getPreviousInDocument, getPreviousSibling, getPublicId, getSiblingPosition, getTypedValue, getURI, insertSiblings, isId, isIdref, isSameNodeInfo, iterateAxis, iterateAxis, newBuilder, replace
Methods inherited from class java.lang.Object
clone, finalize, getClass, hashCode, notify, notifyAll, toString, wait, wait, wait
Methods inherited from interface net.sf.saxon.trace.InstructionInfo
getLineNumber, getSystemId
Methods inherited from interface org.xml.sax.Locator
getColumnNumber, getPublicId
Methods inherited from interface javax.xml.transform.SourceLocator
getColumnNumber, getLineNumber, getPublicId, getSystemId
-
Field Details
-
children
-
sequence
protected int sequence
-
-
Constructor Details
-
XSLFunction
public XSLFunction()
-
-
Method Details
-
registerReference
Method called by UserFunctionCall to register the function call for subsequent fixup.- Parameters:
ref
- the UserFunctionCall to be registered
-
prepareAttributes
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 classStyleElement
- Throws:
XPathException
-
getObjectName
Get a name identifying the object of the expression, for example a function name, template name, variable name, key name, element name, etc. This is used only where the name is known statically. If there is no name, the value will be -1.- Specified by:
getObjectName
in interfaceInstructionInfo
- Overrides:
getObjectName
in classStyleElement
- Returns:
- the name of the object declared in this element, if any
-
mayContainSequenceConstructor
public boolean mayContainSequenceConstructor()Determine whether this type of element is allowed to contain a template-body.- Overrides:
mayContainSequenceConstructor
in classStyleElement
- Returns:
- true: yes, it may contain a general template-body
-
mayContainParam
protected boolean mayContainParam()Description copied from class:StyleElement
Determine whether this type of element is allowed to contain an xsl:param element- Overrides:
mayContainParam
in classStyleElement
- Returns:
- true if this element is allowed to contain an xsl:param
-
isPermittedChild
Specify that xsl:param is a permitted child- Overrides:
isPermittedChild
in classStyleElement
- Parameters:
child
- the child that may or may not be permitted- Returns:
- true if the child is permitted.
-
isOverriding
public boolean isOverriding()Is override="yes"?.- Returns:
- true if override="yes" was specified, otherwise false
-
fixupReferences
Notify all references to this function of the data type.- Overrides:
fixupReferences
in classStyleElement
- Throws:
XPathException
-
validate
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 classStyleElement
- Throws:
XPathException
-
compile
Compile the function definition to create an executable representation- Specified by:
compile
in classStyleElement
- Parameters:
exec
- the Executable- 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 (a UserFunction object)
- Throws:
XPathException
-
getSlotManager
Get associated Procedure (for details of stack frame).- Specified by:
getSlotManager
in interfaceStylesheetProcedure
- Returns:
- the associated Procedure object
-
getResultType
Get the type of value returned by this function- 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).- Returns:
- the arity of the function
-
setParameterDefinitions
Set the definitions of the parameters in the compiled function, as an array.- Parameters:
fn
- the compiled object representing the user-written function
-
getCompiledFunction
Get the compiled function- Returns:
- the object representing the compiled user-written function
-
getConstructType
public int getConstructType()Get the type of construct. This will be a constant in classLocation
. This method is part of theInstructionInfo
interface- Specified by:
getConstructType
in interfaceInstructionInfo
- Overrides:
getConstructType
in classStyleElement
- Returns:
- an integer identifying the kind of construct
-
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 document nodes) 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. For nodes added by XQUery Update, the sequence number is -1L- Overrides:
getSequenceNumber
in classNodeImpl
- Returns:
- the sequence number if there is one, or -1L otherwise.
-
hasChildNodes
public final boolean hasChildNodes()Determine if the node has any children.- Specified by:
hasChildNodes
in interfaceNodeInfo
- Overrides:
hasChildNodes
in classNodeImpl
- Returns:
true
if the node has any children,false
if the node has no children.
-
getNumberOfChildren
public int getNumberOfChildren()Determine how many children the node has- Returns:
- the number of children of this parent node
-
enumerateChildren
Get an enumeration of the children of this node- Parameters:
test
- A NodeTest to be satisfied by the child nodes, or null if all child node are to be returned- Returns:
- an iterator over the children of this node
-
getFirstChild
Get the first child node of the element- Overrides:
getFirstChild
in classNodeImpl
- Returns:
- the first child node of the required type, or null if there are no children
-
getLastChild
Get the last child node of the element- Overrides:
getLastChild
in classNodeImpl
- Returns:
- the last child of the element, or null if there are no children
-
getNthChild
Get the nth child node of the element (numbering from 0)- Parameters:
n
- identifies the required child- Returns:
- the last child of the element, or null if there is no n'th child
-
removeChild
Remove a given child- Parameters:
child
- the child to be removed
-
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.
- See Also:
-
getStringValueCS
Description copied from class:NodeImpl
Get the value of the item as a CharSequence. This is in some cases more efficient than the version of the method that returns a String.- Specified by:
getStringValueCS
in interfaceItem
- Specified by:
getStringValueCS
in interfaceValueRepresentation
- Overrides:
getStringValueCS
in classNodeImpl
- Returns:
- the string value of the item
- See Also:
-
useChildrenArray
Supply an array to be used for the array of children. For system use only.- Parameters:
array
- the array to be used
-
addChild
Add a child node to this node. For system use only. Note: normalizing adjacent text nodes is the responsibility of the caller.- Parameters:
node
- the node to be added as a child of this nodeindex
- the position where the child is to be added
-
insertChildren
Insert copies of a sequence of nodes as children of this node.This method takes no action unless the target node is a document node or element node. It also takes no action in respect of any supplied nodes that are not elements, text nodes, comments, or processing instructions.
The supplied nodes will be copied to form the new children. Adjacent text nodes will be merged, and zero-length text nodes removed.
- Specified by:
insertChildren
in interfaceMutableNodeInfo
- Overrides:
insertChildren
in classNodeImpl
- Parameters:
source
- the nodes to be insertedatStart
- true if the new nodes are to be inserted before existing children; false if they areinherit
- true if the inserted nodes are to inherit the namespaces that are in-scope for their new parent; false if such namespaces should be undeclared on the children
-
insertChildrenAt
Insert children before or after a given existing child- Parameters:
source
- the children to be insertedindex
- the position before which they are to be inserted: 0 indicates insertion before the first child, 1 insertion before the second child, and so on.inherit
- true if the inserted nodes are to inherit the namespaces that are in-scope for their new parent; false if such namespaces should be undeclared on the children
-
replaceChildrenAt
Replace child at a given index by new children- Parameters:
source
- the children to be insertedindex
- the position at which they are to be inserted: 0 indicates replacement of the first child, replacement of the second child, and so on. The effect is undefined if index is out of rangeinherit
- set to true if the new child elements are to inherit the in-scope namespaces of their new parent- Throws:
IllegalArgumentException
- if any of the replacement nodes is not an element, text, comment, or processing instruction node
-
compact
public void compact(int size) Compact the space used by this node- Parameters:
size
- the number of actual children
-