Package net.sf.saxon.query
Class XQueryFunction
java.lang.Object
net.sf.saxon.query.XQueryFunction
- All Implemented Interfaces:
Serializable
,SourceLocator
,LocationProvider
,SaxonLocator
,Container
,Declaration
,InstructionInfo
,Locator
- See Also:
-
Constructor Summary
Constructors -
Method Summary
Modifier and TypeMethodDescriptionprotected void
addArgument
(UserFunctionParameter argument) Add an argument to the list of argumentsvoid
checkReferences
(ExpressionVisitor visitor) Type-check references to this functionvoid
compile()
Compile this function to create a run-time definition that can be interpreted (note, this has nothing to do with Java code generation)void
Produce diagnostic output showing the compiled and optimized expression tree for a functionvoid
Fix up references to this functionGet the declared types of the arguments of this functiongetBody()
Get the body of the functionint
Return the column numberint
getColumnNumber
(long locationId) Get the column number within the document or module containing a particular locationint
Get the type of construct.Get the name of the function for display in error messagesGet the executable in which this function is containedGet the name of the function as a structured QNameint
Get the host language (XSLT, XQuery, XPath) used to implement the code in this containerGet an identifying key for this function, which incorporates the URI and local part of the function name plus the aritystatic String
getIdentificationKey
(String uri, String localName, int arity) Construct what the identification key would be for a function with given URI, local name, and aritystatic String
getIdentificationKey
(StructuredQName qName, int arity) Construct what the identification key would be for a function with given URI, local name, and arityint
Get the line number of the instruction in the source stylesheet module.int
getLineNumber
(long locationId) Get the line number within the document or module containing a particular locationGet the LocationProvider allowing location identifiers to be resolved.Get the namespace context of the instruction.int
Get the arity of the functionGet a name identifying the object of the expression, for example a function name, template name, variable name, key name, element name, etc.Get the definitions of the arguments to this functionGet an iterator over all the properties available.getProperty
(String name) Get the value of a particular property of the instruction.Return the public identifier for the current document event.Get the result type of the functionGet the static context for this functionGet the system identifier (URI) of the source module containing the instruction.getSystemId
(long locationId) Get the URI of the document or module containing a particular locationGet the callable compiled function contained within this XQueryFunction definition.boolean
Find out whether this is a memo functionboolean
Ask whether this is an updating function (as defined in XQuery Update)void
optimize()
Optimize the body of this functionvoid
Register a call on this functionboolean
replaceSubExpression
(Expression original, Expression replacement) Replace one subexpression by a replacement subexpressionprotected void
setBody
(Expression body) Set the body of the functionprotected void
setColumnNumber
(int column) Set the column number of the function declarationvoid
setExecutable
(Executable exec) Set the executable in which this function is containedprotected void
Set the name of the functionprotected void
setLineNumber
(int line) Set the line number of the function declaration within its modulevoid
setMemoFunction
(boolean isMemoFunction) Set that this is, or is not, a memo function.protected void
setResultType
(SequenceType resultType) Set the required result type of the functionvoid
Set the static context for this functionprotected void
setSystemId
(String systemId) Set the system ID of the module containing the functionvoid
setUpdating
(boolean isUpdating) Set whether this is an updating function (as defined in XQuery Update)
-
Constructor Details
-
XQueryFunction
public XQueryFunction()Create an XQuery function
-
-
Method Details
-
setFunctionName
Set the name of the function- Parameters:
name
- the name of the function as a StructuredQName object
-
addArgument
Add an argument to the list of arguments- Parameters:
argument
- the formal declaration of the argument to be added
-
setResultType
Set the required result type of the function- Parameters:
resultType
- the declared result type of the function
-
setBody
Set the body of the function- Parameters:
body
- the expression forming the body of the function
-
getBody
Get the body of the function- Returns:
- the expression making up the body of the function
-
setSystemId
Set the system ID of the module containing the function- Parameters:
systemId
- the system ID (= base URI) of the module containing the function
-
setLineNumber
protected void setLineNumber(int line) Set the line number of the function declaration within its module- Parameters:
line
- the line number of the function declaration
-
setColumnNumber
protected void setColumnNumber(int column) Set the column number of the function declaration- Parameters:
column
- the column number of the function declaration
-
getFunctionName
Get the name of the function as a structured QName- Returns:
- the name of the function as a structured QName
-
getDisplayName
Get the name of the function for display in error messages- Returns:
- the name of the function as a lexical QName
-
getIdentificationKey
Get an identifying key for this function, which incorporates the URI and local part of the function name plus the arity- Returns:
- an identifying key
-
getIdentificationKey
Construct what the identification key would be for a function with given URI, local name, and arity- Parameters:
uri
- the URI part of the function namelocalName
- the local part of the function namearity
- the number of arguments in the function- Returns:
- an identifying key
-
getIdentificationKey
Construct what the identification key would be for a function with given URI, local name, and arity- Parameters:
qName
- the name of the functionarity
- the number of arguments- Returns:
- an identifying key
-
getResultType
Get the result type of the function- Returns:
- the declared result type
-
setExecutable
Set the executable in which this function is contained- Parameters:
exec
- the executable
-
getExecutable
Get the executable in which this function is contained- Specified by:
getExecutable
in interfaceContainer
- Returns:
- the executable
-
getLocationProvider
Get the LocationProvider allowing location identifiers to be resolved.- Specified by:
getLocationProvider
in interfaceContainer
- Returns:
- the location provider
-
setStaticContext
Set the static context for this function- Parameters:
env
- the static context for the module in which the function is declared
-
getStaticContext
Get the static context for this function- Returns:
- the static context for the module in which the function is declared
-
getArgumentTypes
Get the declared types of the arguments of this function- Returns:
- an array, holding the types of the arguments in order
-
getParameterDefinitions
Get the definitions of the arguments to this function- Returns:
- an array of UserFunctionParameter objects, one for each argument
-
getNumberOfArguments
public int getNumberOfArguments()Get the arity of the function- Returns:
- the arity (the number of arguments)
-
registerReference
Register a call on this function- Parameters:
ufc
- a user function call that references this function.
-
setMemoFunction
public void setMemoFunction(boolean isMemoFunction) Set that this is, or is not, a memo function. A memo function remembers the results of calls on the function so that the a subsequent call with the same arguments simply look up the result- Parameters:
isMemoFunction
- true if this is a memo function.
-
isMemoFunction
public boolean isMemoFunction()Find out whether this is a memo function- Returns:
- true if this is a memo function
-
setUpdating
public void setUpdating(boolean isUpdating) Set whether this is an updating function (as defined in XQuery Update)- Parameters:
isUpdating
- true if this is an updating function
-
isUpdating
public boolean isUpdating()Ask whether this is an updating function (as defined in XQuery Update)- Returns:
- true if this is an updating function
-
compile
Compile this function to create a run-time definition that can be interpreted (note, this has nothing to do with Java code generation)- Throws:
XPathException
- if errors are found
-
optimize
Optimize the body of this function- Throws:
XPathException
-
fixupReferences
Fix up references to this function- Parameters:
env
- the static context- Throws:
XPathException
-
checkReferences
Type-check references to this function- Parameters:
visitor
- the expression visitor- Throws:
XPathException
-
explain
Produce diagnostic output showing the compiled and optimized expression tree for a function- Parameters:
out
- the destination to be used
-
getUserFunction
Get the callable compiled function contained within this XQueryFunction definition.- Returns:
- the compiled function object
-
getConstructType
public int getConstructType()Get the type of construct. This will be a constant in classLocation
.- Specified by:
getConstructType
in interfaceInstructionInfo
- Returns:
- an integer identifying the kind of construct
-
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.- Specified by:
getObjectName
in interfaceInstructionInfo
- Returns:
- the QName of the object declared or manipulated by this instruction or expression
-
getSystemId
Get the system identifier (URI) of the source module containing the instruction. This will generally be an absolute URI. If the system identifier is not known, the method may return null. In some cases, for example where XML external entities are used, the correct system identifier is not always retained.- Specified by:
getSystemId
in interfaceInstructionInfo
- Specified by:
getSystemId
in interfaceLocator
- Specified by:
getSystemId
in interfaceSourceLocator
- Returns:
- the URI of the containing module
-
getLineNumber
public int getLineNumber()Get the line number of the instruction in the source stylesheet module. If this is not known, or if the instruction is an artificial one that does not relate to anything in the source code, the value returned may be -1.- Specified by:
getLineNumber
in interfaceInstructionInfo
- Specified by:
getLineNumber
in interfaceLocator
- Specified by:
getLineNumber
in interfaceSourceLocator
- Returns:
- the line number of the expression within the containing module
-
getPublicId
Return the public identifier for the current document event.- Specified by:
getPublicId
in interfaceLocator
- Specified by:
getPublicId
in interfaceSourceLocator
- Returns:
- A string containing the public identifier, or null if none is available.
- See Also:
-
getColumnNumber
public int getColumnNumber()Return the column number- Specified by:
getColumnNumber
in interfaceLocator
- Specified by:
getColumnNumber
in interfaceSourceLocator
- Returns:
- The column number, or -1 if none is available.
- See Also:
-
getSystemId
Description copied from interface:LocationProvider
Get the URI of the document or module containing a particular location- Specified by:
getSystemId
in interfaceLocationProvider
- Parameters:
locationId
- identifier of the location in question (as passed down the Receiver pipeline)- Returns:
- the URI of the document or module.
-
getLineNumber
public int getLineNumber(long locationId) Description copied from interface:LocationProvider
Get the line number within the document or module containing a particular location- Specified by:
getLineNumber
in interfaceLocationProvider
- Parameters:
locationId
- identifier of the location in question (as passed down the Receiver pipeline)- Returns:
- the line number within the document or module.
-
getColumnNumber
public int getColumnNumber(long locationId) Description copied from interface:LocationProvider
Get the column number within the document or module containing a particular location- Specified by:
getColumnNumber
in interfaceLocationProvider
- Parameters:
locationId
- identifier of the location in question (as passed down the Receiver pipeline)- Returns:
- the column number within the document or module, or -1 if this is not available
-
getNamespaceResolver
Get the namespace context of the instruction. This will not always be available, in which case the method returns null. -
getProperty
Get the value of a particular property of the instruction. Properties of XSLT instructions are generally known by the name of the stylesheet attribute that defines them.- Specified by:
getProperty
in interfaceInstructionInfo
- Parameters:
name
- The name of the required property- Returns:
- The value of the requested property, or null if the property is not available
-
getProperties
Get an iterator over all the properties available. The values returned by the iterator will be of type String, and each string can be supplied as input to the getProperty() method to retrieve the value of the property.- Specified by:
getProperties
in interfaceInstructionInfo
- Returns:
- an iterator over the properties.
-
getHostLanguage
public int getHostLanguage()Get the host language (XSLT, XQuery, XPath) used to implement the code in this container- Specified by:
getHostLanguage
in interfaceContainer
- Returns:
- typically
Configuration.XSLT
orConfiguration.XQUERY
-
replaceSubExpression
Replace one subexpression by a replacement subexpression- Specified by:
replaceSubExpression
in interfaceContainer
- Parameters:
original
- the original subexpressionreplacement
- the replacement subexpression- Returns:
- true if the original subexpression is found
-