net.sf.saxon.style

Class XSLFunction

java.lang.Object

net.sf.saxon.tree.linked.NodeImpl

net.sf.saxon.tree.linked.ElementImpl

net.sf.saxon.style.StyleElement

net.sf.saxon.style.XSLFunction

All Implemented Interfaces:

javax.xml.transform.Source, javax.xml.transform.SourceLocator, Location, Item, MutableNodeInfo, NamespaceResolver, NodeInfo, Sequence, StylesheetComponent, SteppingNode<NodeImpl>, SiblingCountingNode, org.xml.sax.Locator

public class XSLFunction
extends StyleElement
implements StylesheetComponent

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

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

ALL_NAMESPACES, IS_DTD_TYPE, IS_NILLED, LOCAL_NAMESPACES, NO_NAMESPACES

Constructor Summary

Constructors

Constructor and Description
XSLFunction()

Method Summary

Modifier and Type	Method and Description
protected void	addChild(NodeImpl node, int index) Add a child node to this node.
void	checkCompatibility(Component component) Check the compatibility of this component with another component that it is overriding
void	compact(int size) Compact the space used by this node
void	compileDeclaration(Compilation compilation, ComponentDeclaration decl) Compile the function definition to create an executable representation The compileDeclaration() method has the side-effect of binding all references to the function to the executable representation (a UserFunction object)
void	fixupReferences() Notify all references to this function of the data type.
void	generateByteCode(Optimizer opt) Generate byte code if appropriate
UserFunction	getActor() Get the corresponding Procedure object that results from the compilation of this StylesheetProcedure
SequenceType[]	getArgumentTypes() Get the argument types
UserFunction	getCompiledFunction() Get the compiled function
int	getConstructType() Get the type of construct.
NodeImpl	getFirstChild() Get the first child node of the element
NodeImpl	getLastChild() Get the last child node of the element
protected NodeImpl	getNthChild(int n) Get the nth child node of the element (numbering from 0)
int	getNumberOfArguments() Get the number of arguments declared by this function (that is, its arity).
int	getNumberOfChildren() Determine how many children the node has
StructuredQName	getObjectName() Get a name identifying the object of the expression, for example a function name, template name, variable name, key name, element name, etc.
protected int	getRawSequenceNumber()
SequenceType	getResultType() Get the type of value returned by this function
protected long	getSequenceNumber() Get the node sequence number (in document order).
SlotManager	getSlotManager() Get associated stack frame details.
java.lang.String	getStringValue() Return the string-value of the node, that is, the concatenation of the character content of all descendent elements and text nodes.
java.lang.CharSequence	getStringValueCS() Get the value of the item as a CharSequence.
SymbolicName.F	getSymbolicName() Get the symbolic name of the component, that is, the combination of the component kind and the qualified name
Visibility	getVisibility() Get the visibility of the component.
boolean	hasChildNodes() Determine if the node has any children.
void	index(ComponentDeclaration decl, PrincipalStylesheetModule top) Method supplied by declaration elements to add themselves to a stylesheet-level index
void	insertChildren(NodeInfo[] source, boolean atStart, boolean inherit) Insert 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 child
boolean	isDeclaration() Ask whether this node is a declaration, that is, a permitted child of xsl:stylesheet (including xsl:include and xsl:import).
boolean	isOverrideExtensionFunction() Is override-extension-function="yes"?.
protected boolean	isPermittedChild(StyleElement child) Specify that xsl:param is a permitted child
protected AxisIterator	iterateChildren(NodeTest test) Get an enumeration of the children of this node
protected boolean	mayContainParam(java.lang.String attName) Determine whether this type of element is allowed to contain an xsl:param element
boolean	mayContainSequenceConstructor() Determine whether this type of element is allowed to contain a template-body.
void	optimize(ComponentDeclaration declaration) Optimize the stylesheet construct
void	prepareAttributes() Set the attribute list for the element.
protected void	removeChild(NodeImpl child) Remove a given child
protected void	replaceChildrenAt(NodeInfo[] source, int index, boolean inherit) Replace child at a given index by new children
protected void	setChildren(java.lang.Object children) Set the children of this node
void	setParameterDefinitions(UserFunction fn) Set the definitions of the parameters in the compiled function, as an array.
protected void	setRawSequenceNumber(int seq)
void	validate(ComponentDeclaration decl) Check that the stylesheet element is valid.

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

addXSLOverrideFunctionLibrary, allocateLocalSlots, allocateLocation, bindLocalVariable, bindVariable, changesRetainedStaticContext, check30attribute, checkAttributeValue, checkEmpty, checkSortComesFirst, checkTopLevel, checkUnknownAttribute, compile, compileContentValueTemplate, compileError, compileError, compileError, compileError, compileErrorInAttribute, compileSequenceConstructor, compileSequenceConstructor, compileWarning, compileWarning, definesExcludedNamespace, definesExtensionElement, fallbackProcessing, findAncestorElement, findCollation, forwardsCompatibleModeIsEnabled, generateId, getAttributeValue, getBaseURI, getBindingInformation, getCompilation, getContainingPackage, getContainingSlotManager, getContainingStylesheet, getDeclaredVisibility, getDefaultCollationName, getDefaultMode, getDefaultValidation, getDefaultXPathNamespace, getEffectiveVersion, getEffectiveVersionAsString, getHostLanguage, getLastChildInstruction, getNamespaceResolver, getOverriddenComponent, getPackageData, getPrincipalStylesheetModule, getProperties, getProperty, getSchemaType, getStaticContext, getStaticContext, getTypeAnnotation, getUsedAttributeSets, getUsedPackage, getWithParamInstructions, getXslOriginal, hasImplicitBinding, interpretVisibilityValue, invalidAttribute, isActionCompleted, isConstructingComplexContent, isExcludedNamespace, isExpandingText, isExplaining, isExtensionNamespace, isInstruction, isSchemaAware, issueWarning, issueWarning, isTopLevel, isWithinDeclaredStreamableConstruct, makeAttributeValueTemplate, makeExpression, makeExpressionVisitor, makeExtendedSequenceType, makeNamespaceContext, makePattern, makeQName, makeRetainedStaticContext, makeSequenceType, makeSortKeys, makeTraceInstruction, markTailCalls, mayContainFallback, postValidate, processAllAttributes, processAttributes, processBooleanAttribute, processDefaultCollationAttribute, processDefaultMode, processDefaultValidationAttribute, processDefaultXPathNamespaceAttribute, processExcludedNamespaces, processExpandTextAttribute, processExtensionElementAttribute, processStandardAttributes, 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, isInScopeNamespace, isNilled, iteratePrefixes, removeAttribute, removeTypeAnnotation, rename, replaceStringValue, setAttributeList, setLocation, setNamespaceDeclarations, setNamespaceList, setNilled, setNodeName, setSystemId, setTypeAnnotation

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

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

Methods inherited from class java.lang.Object

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

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

hashCode

Constructor Detail

XSLFunction

public XSLFunction()

Method Detail

getActor

public UserFunction getActor()

Get the corresponding Procedure object that results from the compilation of this StylesheetProcedure

Specified by:

getActor in interface StylesheetComponent

Returns:

the compiled ComponentCode

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

prepareAttributes

public void prepareAttributes()
                       throws XPathException

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:

XPathException - if a static error is detected

getObjectName

public StructuredQName 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.

Overrides:

getObjectName in class StyleElement

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 class StyleElement

Returns:

true: yes, it may contain a general template-body

mayContainParam

protected boolean mayContainParam(java.lang.String attName)

Description copied from class: StyleElement

Determine whether this type of element is allowed to contain an xsl:param element

Overrides:

mayContainParam in class StyleElement

Parameters:

attName - if null, the method tests whether an xsl:param child is allowed. If non-null, it tests whether an xsl:param child with the given attribute name is allowed

Returns:

true if this element is allowed to contain an xsl:param

isPermittedChild

protected boolean isPermittedChild(StyleElement child)

Specify that xsl:param is a permitted child

Overrides:

isPermittedChild in class StyleElement

Parameters:

child - the child that may or may not be permitted

Returns:

true if the child is permitted.

getVisibility

public Visibility getVisibility()

Description copied from class: StyleElement

Get the visibility of the component. Returns the actual value of the visibility attribute, after validation, unless this is absent, in which case it returns the default value of PRIVATE.

Overrides:

getVisibility in class StyleElement

Returns:

the declared visibility of the component, or PRIVATE if the visibility attribute is absent.

getSymbolicName

public SymbolicName.F getSymbolicName()

Description copied from interface: StylesheetComponent

Get the symbolic name of the component, that is, the combination of the component kind and the qualified name

Specified by:

getSymbolicName in interface StylesheetComponent

Returns:

the component's symbolic name

checkCompatibility

public void checkCompatibility(Component component)
                        throws XPathException

Description copied from interface: StylesheetComponent

Check the compatibility of this component with another component that it is overriding

Specified by:

checkCompatibility in interface StylesheetComponent

Parameters:

component - the overridden component

Throws:

XPathException - if the components are not compatible (differing signatures)

isOverrideExtensionFunction

public boolean isOverrideExtensionFunction()

Is override-extension-function="yes"?.

Returns:

true if override-extension-function="yes" was specified, otherwise false

index

public void index(ComponentDeclaration decl,
                  PrincipalStylesheetModule top)
           throws XPathException

Description copied from class: StyleElement

Method supplied by declaration elements to add themselves to a stylesheet-level index

Overrides:

index in class StyleElement

Parameters:

decl - the Declaration being indexed. (This corresponds to the StyleElement object except in cases where one module is imported several times with different precedence.)

top - represents the outermost XSLStylesheet or XSLPackage element

Throws:

XPathException - if any error is encountered

fixupReferences

public void fixupReferences()
                     throws XPathException

Notify all references to this function of the data type.

Overrides:

fixupReferences 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

compileDeclaration

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

Compile the function definition to create an executable representation The compileDeclaration() method has the side-effect of binding all references to the function to the executable representation (a UserFunction object)

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

optimize

public void optimize(ComponentDeclaration declaration)
              throws XPathException

Description copied from interface: StylesheetComponent

Optimize the stylesheet construct

Specified by:

optimize in interface StylesheetComponent

Parameters:

declaration - the combination of the source XSLT element defining the component, and the module in which it appears

Throws:

XPathException

generateByteCode

public void generateByteCode(Optimizer opt)
                      throws XPathException

Generate byte code if appropriate

Specified by:

generateByteCode in interface StylesheetComponent

Parameters:

opt - the optimizer

Throws:

XPathException - if bytecode generation fails

getSlotManager

public SlotManager getSlotManager()

Get associated stack frame details.

Specified by:

getSlotManager in interface StylesheetComponent

Returns:

the associated SlotManager object

getResultType

public SequenceType 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

public void setParameterDefinitions(UserFunction fn)

Set the definitions of the parameters in the compiled function, as an array.

Parameters:

fn - the compiled object representing the user-written function

getArgumentTypes

public SequenceType[] getArgumentTypes()

Get the argument types

Returns:

the declared types of the arguments

getCompiledFunction

public UserFunction 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 class LocationKind. This method is part of the InstructionInfo interface

Overrides:

getConstructType in class StyleElement

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 class NodeImpl

Returns:

the sequence number if there is one, or -1L otherwise.

getRawSequenceNumber

protected final int getRawSequenceNumber()

setRawSequenceNumber

protected final void setRawSequenceNumber(int seq)

setChildren

protected final void setChildren(java.lang.Object children)

Set the children of this node

Parameters:

children - null if there are no children, a single NodeInfo if there is one child, an array of NodeInfo if there are multiple children

hasChildNodes

public final boolean hasChildNodes()

Determine if the node has any children.

Specified by:

hasChildNodes in interface NodeInfo

Overrides:

hasChildNodes in class NodeImpl

Returns:

true if the node has any children, false if the node has no children.

getNumberOfChildren

public final int getNumberOfChildren()

Determine how many children the node has

Returns:

the number of children of this parent node

iterateChildren

protected final AxisIterator iterateChildren(NodeTest test)

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

public final NodeImpl getFirstChild()

Get the first child node of the element

Specified by:

getFirstChild in interface SteppingNode<NodeImpl>

Overrides:

getFirstChild in class NodeImpl

Returns:

the first child node of the required type, or null if there are no children

getLastChild

public final NodeImpl getLastChild()

Get the last child node of the element

Overrides:

getLastChild in class NodeImpl

Returns:

the last child of the element, or null if there are no children

getNthChild

protected final NodeImpl getNthChild(int n)

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

protected void removeChild(NodeImpl child)

Remove a given child

Parameters:

child - the child to be removed

getStringValue

public java.lang.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.

See Also:

Item.getStringValueCS()

getStringValueCS

public java.lang.CharSequence 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 interface Item

Overrides:

getStringValueCS in class NodeImpl

Returns:

the string value of the item

See Also:

Item.getStringValue()

addChild

protected 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.

Parameters:

node - the node to be added as a child of this node. This must be an instance of NodeImpl. It will be modified as a result of this call (by setting its parent property and sibling position)

index - the position where the child is to be added

insertChildren

public void insertChildren(NodeInfo[] source,
                           boolean atStart,
                           boolean inherit)

Insert 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 form the new children. Adjacent text nodes will be merged, and zero-length text nodes removed. The supplied nodes may be modified in situ, for example to change their parent property and to add namespace bindings, or they may be copied, at the discretion of the implementation.

Specified by:

insertChildren in interface MutableNodeInfo

Overrides:

insertChildren in class NodeImpl

Parameters:

source - the nodes to be inserted. The implementation determines what implementation classes of node it will accept; this implementation will accept text, comment, and processing instruction nodes belonging to any implementation, but elements must be instances of ElementImpl. The supplied nodes will be modified in situ, for example to change their parent property and to add namespace bindings, if they are instances of ElementImpl; otherwise they will be copied. If the nodes are copied, then on return the supplied source array will contain the copy rather than the original.

atStart - true if the new nodes are to be inserted before existing children; false if they are to be inserted after existing children

inherit - true if the inserted nodes are to inherit the namespaces of their new parent; false if such namespaces are to be undeclared

Throws:

java.lang.IllegalArgumentException - if the supplied nodes use a node implementation that this implementation does not accept.

insertChildrenAt

protected void insertChildrenAt(NodeInfo[] source,
                                int index,
                                boolean inherit)

Insert children before or after a given existing child

Parameters:

source - the children to be inserted. We allow any kind of text, comment, or processing instruction node, but element nodes must be instances of this NodeInfo implementation.

index - 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

protected void replaceChildrenAt(NodeInfo[] source,
                                 int index,
                                 boolean inherit)

Replace child at a given index by new children

Parameters:

source - the children to be inserted

index - 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 range

inherit - set to true if the new child elements are to inherit the in-scope namespaces of their new parent

Throws:

java.lang.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