net.sf.saxon.style
Class XSLFunction

java.lang.Object
  net.sf.saxon.tree.NodeImpl
      net.sf.saxon.tree.ElementImpl
          net.sf.saxon.tree.ElementWithAttributes
              net.sf.saxon.style.StyleElement
                  net.sf.saxon.style.XSLFunction

All Implemented Interfaces:

Serializable, Source, SourceLocator, LocationProvider, SaxonLocator, PullEvent, Container, FingerprintedNode, Item, NamespaceResolver, NodeInfo, ValueRepresentation, StylesheetProcedure, InstructionInfo, Locator

public class XSLFunction
extends StyleElement
implements StylesheetProcedure

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.

See Also:

Serialized Form

Field Summary

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

REPORT_ALWAYS, REPORT_IF_INSTANTIATED, REPORT_UNLESS_FALLBACK_AVAILABLE, REPORT_UNLESS_FORWARDS_COMPATIBLE

Fields inherited from class net.sf.saxon.tree.NodeImpl

NODE_LETTER

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

XSLFunction()

Method Summary

void	addChild(NodeImpl node, int index) Add a child node to this node.
void	compact(int size) Compact the space used by this node
Expression	compile(Executable exec) Compile the function definition to create an executable representation
void	fixupReferences() Notify all references to this function of the data type.
UserFunction	getCompiledFunction() Get the compiled function
int	getConstructType() Get the type of construct.
NodeInfo	getFirstChild() Get the first child node of the element
NodeInfo	getLastChild() Get the last child node of the element
int	getNumberOfArguments() Get the number of arguments declared by this function (that is, its arity).
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.
SequenceType	getResultType() Get the type of value returned by this function
SlotManager	getSlotManager() Get associated Procedure (for details of stack frame).
String	getStringValue() Return the string-value of the node, that is, the concatenation of the character content of all descendent elements and text nodes.
CharSequence	getStringValueCS() Get the value of the item as a CharSequence.
boolean	hasChildNodes() Determine if the node has any children.
boolean	isOverriding() Is override="yes"?.
boolean	mayContainSequenceConstructor() 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	setParameterDefinitions(UserFunction fn) Set the definitions of the parameters in the compiled function, as an array.
void	validate() Check that the stylesheet element is valid.

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

allocatePatternSlots, allocateSlots, allocateSlots, backwardsCompatibleModeIsEnabled, bindVariable, checkEmpty, checkTopLevel, checkWithinTemplate, compileSequenceConstructor, forwardsCompatibleModeIsEnabled, getAllStylesheetFunctions, getAttributeValue, getContainingSlotManager, getContainingStylesheet, getExecutable, getHostLanguage, getLineNumber, getLineNumber, getLocationProvider, getNamespaceResolver, getObjectName, getPrecedence, getPreparedStylesheet, getPrincipalStylesheet, getProperties, getProperty, getSchemaType, getStaticContext, getStylesheetFunction, getSystemId, getTypeAnnotation, getVersion, isExcludedNamespace, isExtensionNamespace, isInstruction, isTopLevel, makeExpression, makeExpressionVisitor, makeNamespaceContext, makePattern, makeQName, makeSequenceType, postValidate, replaceSubExpression, reportAbsence, setLineNumber, setObjectName, substituteFor, typeCheck, typeCheck, validateSubtree

Methods inherited from class net.sf.saxon.tree.ElementWithAttributes

copy, getAttributeList, getAttributeValue, getDeclaredNamespaces, getInScopeNamespaceCodes, getPrefixForURI, getURICodeForPrefix, getURIForPrefix, initialise, iteratePrefixes, setNamespaceDeclarations

Methods inherited from class net.sf.saxon.tree.ElementImpl

generateId, getBaseURI, getDocumentRoot, getNameCode, getNodeKind, getRoot, getSystemId, setNameCode, setSystemId

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

atomize, compareOrder, equals, getColumnNumber, getConfiguration, getDisplayName, getDocumentNumber, getFingerprint, getLocalPart, getNamePool, getNextInDocument, getNextSibling, getParent, getPrefix, getPreviousInDocument, getPreviousSibling, getPublicId, getTypeAnnotation, getTypedValue, getURI, hashCode, isSameNodeInfo, iterateAxis, iterateAxis

Methods inherited from class java.lang.Object

getClass, notify, notifyAll, toString, wait, wait, wait

Methods inherited from interface net.sf.saxon.trace.InstructionInfo

getSystemId

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

Throws:

XPathException

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.

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 XPathException

Notify all references to this function of the data type.

Overrides:

fixupReferences in class StyleElement

Throws:

XPathException

validate

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

Throws:

XPathException

compile

public Expression compile(Executable exec)
                   throws XPathException

Compile the function definition to create an executable representation

Specified by:

compile in class StyleElement

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

public SlotManager getSlotManager()

Get associated Procedure (for details of stack frame).

Specified by:

getSlotManager in interface StylesheetProcedure

Returns:

the associated Procedure 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

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 Location. This method is part of the InstructionInfo interface

Specified by:

getConstructType in interface InstructionInfo

Overrides:

getConstructType in class StyleElement

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.

getFirstChild

public final NodeInfo getFirstChild()

Get the first child node of the element

Overrides:

getFirstChild in class NodeImpl

Returns:

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

getLastChild

public final NodeInfo 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

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.

See Also:

Item.getStringValueCS()

getStringValueCS

public 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

Specified by:

getStringValueCS in interface ValueRepresentation

Overrides:

getStringValueCS in class NodeImpl

Returns:

the string value of the item

See Also:

Item.getStringValue()

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.

Parameters:

node - the node to be added as a child of this node

index - the position where the child is to be added

compact

public void compact(int size)

Compact the space used by this node

Parameters:

size - the number of actual children