public class XQueryFunction extends java.lang.Object implements InstructionInfo, Container, Declaration
?????? |
---|
XQueryFunction()
Create an XQuery function
|
?????? | ????? |
---|---|
protected void |
addArgument(UserFunctionParameter argument)
Add an argument to the list of arguments
|
void |
checkReferences(ExpressionVisitor visitor)
Type-check references to this function
|
void |
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 |
explain(ExpressionPresenter out)
Produce diagnostic output showing the compiled and optimized expression tree for a function
|
void |
fixupReferences(StaticContext env)
Fix up references to this function
|
SequenceType[] |
getArgumentTypes()
Get the declared types of the arguments of this function
|
Expression |
getBody()
Get the body of the function
|
int |
getColumnNumber()
Return the column number
|
int |
getColumnNumber(long locationId)
Get the column number within the document or module containing a particular location
|
int |
getConstructType()
Get the type of construct.
|
java.lang.String |
getDisplayName()
Get the name of the function for display in error messages
|
Executable |
getExecutable()
Get the executable in which this function is contained
|
StructuredQName |
getFunctionName()
Get the name of the function as a structured QName
|
int |
getHostLanguage()
Get the host language (XSLT, XQuery, XPath) used to implement the code in this container
|
java.lang.String |
getIdentificationKey()
Get an identifying key for this function, which incorporates the URI and local part of the
function name plus the arity
|
static java.lang.String |
getIdentificationKey(java.lang.String uri,
java.lang.String localName,
int arity)
Construct what the identification key would be for a function with given URI, local name, and arity
|
static java.lang.String |
getIdentificationKey(StructuredQName qName,
int arity)
Construct what the identification key would be for a function with given URI, local name, and arity
|
int |
getLineNumber()
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 location
|
LocationProvider |
getLocationProvider()
Get the LocationProvider allowing location identifiers to be resolved.
|
NamespaceResolver |
getNamespaceResolver()
Get the namespace context of the instruction.
|
int |
getNumberOfArguments()
Get the arity of the function
|
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.
|
UserFunctionParameter[] |
getParameterDefinitions()
Get the definitions of the arguments to this function
|
java.util.Iterator |
getProperties()
Get an iterator over all the properties available.
|
java.lang.Object |
getProperty(java.lang.String name)
Get the value of a particular property of the instruction.
|
java.lang.String |
getPublicId()
Return the public identifier for the current document event.
|
SequenceType |
getResultType()
Get the result type of the function
|
StaticContext |
getStaticContext()
Get the static context for this function
|
java.lang.String |
getSystemId()
Get the system identifier (URI) of the source module containing
the instruction.
|
java.lang.String |
getSystemId(long locationId)
Get the URI of the document or module containing a particular location
|
UserFunction |
getUserFunction()
Get the callable compiled function contained within this XQueryFunction definition.
|
boolean |
isMemoFunction()
Find out whether this is a memo function
|
boolean |
isUpdating()
Ask whether this is an updating function (as defined in XQuery Update)
|
void |
optimize()
Optimize the body of this function
|
void |
registerReference(UserFunctionCall ufc)
Register a call on this function
|
boolean |
replaceSubExpression(Expression original,
Expression replacement)
Replace one subexpression by a replacement subexpression
|
protected void |
setBody(Expression body)
Set the body of the function
|
protected void |
setColumnNumber(int column)
Set the column number of the function declaration
|
void |
setExecutable(Executable exec)
Set the executable in which this function is contained
|
protected void |
setFunctionName(StructuredQName name)
Set the name of the function
|
protected void |
setLineNumber(int line)
Set the line number of the function declaration within its module
|
void |
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 function
|
void |
setStaticContext(QueryModule env)
Set the static context for this function
|
protected void |
setSystemId(java.lang.String systemId)
Set the system ID of the module containing the function
|
void |
setUpdating(boolean isUpdating)
Set whether this is an updating function (as defined in XQuery Update)
|
protected void setFunctionName(StructuredQName name)
name
- the name of the function as a StructuredQName objectprotected void addArgument(UserFunctionParameter argument)
argument
- the formal declaration of the argument to be addedprotected void setResultType(SequenceType resultType)
resultType
- the declared result type of the functionprotected void setBody(Expression body)
body
- the expression forming the body of the functionpublic Expression getBody()
protected void setSystemId(java.lang.String systemId)
systemId
- the system ID (= base URI) of the module containing the functionprotected void setLineNumber(int line)
line
- the line number of the function declarationprotected void setColumnNumber(int column)
column
- the column number of the function declarationpublic StructuredQName getFunctionName()
public java.lang.String getDisplayName()
public java.lang.String getIdentificationKey()
public static java.lang.String getIdentificationKey(java.lang.String uri, java.lang.String localName, int arity)
uri
- the URI part of the function namelocalName
- the local part of the function namearity
- the number of arguments in the functionpublic static java.lang.String getIdentificationKey(StructuredQName qName, int arity)
qName
- the name of the functionarity
- the number of argumentspublic SequenceType getResultType()
public void setExecutable(Executable exec)
exec
- the executablepublic Executable getExecutable()
getExecutable
???? Container
public LocationProvider getLocationProvider()
getLocationProvider
???? Container
public void setStaticContext(QueryModule env)
env
- the static context for the module in which the function is declaredpublic StaticContext getStaticContext()
public SequenceType[] getArgumentTypes()
public UserFunctionParameter[] getParameterDefinitions()
public int getNumberOfArguments()
public void registerReference(UserFunctionCall ufc)
ufc
- a user function call that references this function.public void setMemoFunction(boolean isMemoFunction)
isMemoFunction
- true if this is a memo function.public boolean isMemoFunction()
public void setUpdating(boolean isUpdating)
isUpdating
- true if this is an updating functionpublic boolean isUpdating()
public void compile() throws XPathException
XPathException
- if errors are foundpublic void optimize() throws XPathException
XPathException
public void fixupReferences(StaticContext env) throws XPathException
env
- the static contextXPathException
public void checkReferences(ExpressionVisitor visitor) throws XPathException
visitor
- the expression visitorXPathException
public void explain(ExpressionPresenter out)
out
- the destination to be usedpublic UserFunction getUserFunction()
public int getConstructType()
Location
.getConstructType
???? InstructionInfo
public StructuredQName getObjectName()
getObjectName
???? InstructionInfo
public java.lang.String getSystemId()
getSystemId
???? javax.xml.transform.SourceLocator
getSystemId
???? InstructionInfo
getSystemId
???? org.xml.sax.Locator
public int getLineNumber()
getLineNumber
???? javax.xml.transform.SourceLocator
getLineNumber
???? InstructionInfo
getLineNumber
???? org.xml.sax.Locator
public java.lang.String getPublicId()
getPublicId
???? javax.xml.transform.SourceLocator
getPublicId
???? org.xml.sax.Locator
getSystemId()
public int getColumnNumber()
getColumnNumber
???? javax.xml.transform.SourceLocator
getColumnNumber
???? org.xml.sax.Locator
getLineNumber()
public java.lang.String getSystemId(long locationId)
LocationProvider
getSystemId
???? LocationProvider
locationId
- identifier of the location in question (as passed down the Receiver pipeline)public int getLineNumber(long locationId)
LocationProvider
getLineNumber
???? LocationProvider
locationId
- identifier of the location in question (as passed down the Receiver pipeline)public int getColumnNumber(long locationId)
LocationProvider
getColumnNumber
???? LocationProvider
locationId
- identifier of the location in question (as passed down the Receiver pipeline)public NamespaceResolver getNamespaceResolver()
public java.lang.Object getProperty(java.lang.String name)
getProperty
???? InstructionInfo
name
- The name of the required propertypublic java.util.Iterator getProperties()
getProperties
???? InstructionInfo
public int getHostLanguage()
getHostLanguage
???? Container
Configuration.XSLT
or Configuration.XQUERY
public boolean replaceSubExpression(Expression original, Expression replacement)
replaceSubExpression
???? Container
original
- the original subexpressionreplacement
- the replacement subexpression