com.saxonica.functions.extfn
Class AnalyzeStringFunction

java.lang.Object
  extended by net.sf.saxon.lib.ExtensionFunctionDefinition
      extended by com.saxonica.functions.extfn.AnalyzeStringFunction
All Implemented Interfaces:
Serializable

public class AnalyzeStringFunction
extends ExtensionFunctionDefinition

This class implements the extension function saxon:analyze-string(). This is a higher order function that provides functionality similar to the XSLT 2.0 xsl:analyze-string instruction, but it works also in XQuery. The first argument is the string to be analyzed; the second is a string containing the regex. The third argument is a function to be invoked once for each matching substring; the fourth argument is a function to be invoked once for each non-matching substring. The fifth optional argument is the regular expression flags.

See Also:
Serialized Form

Constructor Summary
AnalyzeStringFunction()
           
 
Method Summary
 SequenceType[] getArgumentTypes()
          Get the required types for the arguments of this function, counting from zero
 StructuredQName getFunctionQName()
          Get the function name, as a QName
 int getMaximumNumberOfArguments()
          Get the maximum number of arguments allowed by the function
 int getMinimumNumberOfArguments()
          Get the minimum number of arguments required by the function
 SequenceType getResultType(SequenceType[] suppliedArgumentTypes)
          Get the type of the result of the function
 ExtensionFunctionCall makeCallExpression()
          Create a call on this function.
 
Methods inherited from class net.sf.saxon.lib.ExtensionFunctionDefinition
dependsOnFocus, hasSideEffects, trustResultType
 
Methods inherited from class java.lang.Object
clone, equals, finalize, getClass, hashCode, notify, notifyAll, toString, wait, wait, wait
 

Constructor Detail

AnalyzeStringFunction

public AnalyzeStringFunction()
Method Detail

getFunctionQName

public StructuredQName getFunctionQName()
Get the function name, as a QName

Specified by:
getFunctionQName in class ExtensionFunctionDefinition
Returns:
the QName of the function

getMinimumNumberOfArguments

public int getMinimumNumberOfArguments()
Get the minimum number of arguments required by the function

Overrides:
getMinimumNumberOfArguments in class ExtensionFunctionDefinition
Returns:
the minimum number of arguments that must be supplied in a call to this function

getMaximumNumberOfArguments

public int getMaximumNumberOfArguments()
Get the maximum number of arguments allowed by the function

Overrides:
getMaximumNumberOfArguments in class ExtensionFunctionDefinition
Returns:
the maximum number of arguments that may be supplied in a call to this function

getArgumentTypes

public SequenceType[] getArgumentTypes()
Get the required types for the arguments of this function, counting from zero

Specified by:
getArgumentTypes in class ExtensionFunctionDefinition
Returns:
the required types of the argument, as defined by the function signature. Normally this should be an array of size getMaximumNumberOfArguments(); however for functions that allow a variable number of arguments, the array can be smaller than this, with the last entry in the array providing the required type for all the remaining arguments.

getResultType

public SequenceType getResultType(SequenceType[] suppliedArgumentTypes)
Get the type of the result of the function

Specified by:
getResultType in class ExtensionFunctionDefinition
Parameters:
suppliedArgumentTypes - the static types of the arguments to the function. This is provided so that a more precise result type can be returned in the common case where the type of the result depends on the type of the first argument. The value will be null if the function call has no arguments.
Returns:
the return type of the function, as defined by its function signature

makeCallExpression

public ExtensionFunctionCall makeCallExpression()
Create a call on this function. This method is called by the compiler when it identifies a function call that calls this function.

Specified by:
makeCallExpression in class ExtensionFunctionDefinition
Returns:
an expression representing a call of this extension function


Copyright (c) 2004-2011 Saxonica Limited. All rights reserved.