MXQuery 0.6.0 API Documentation - Copyright 2006-2009 ETH Zurich

ch.ethz.mxquery.functions
Class FunctionSignature

java.lang.Object
  extended by ch.ethz.mxquery.functions.FunctionSignature

public class FunctionSignature
extends java.lang.Object

Holds information on the signature (Name, parameters, classification) of an XQuery function


Field Summary
static int EXTERNAL_FUNCTION
           
static int SYSTEM_FUNCTION
           
static int USER_DEFINED_FUNCTION
           
 
Constructor Summary
FunctionSignature(QName qname, TypeInfo[] parameterType, int type, int exprType, boolean nondeterministic)
           
 
Method Summary
 FunctionSignature copy()
           
 boolean equals(java.lang.Object obj)
          Checks the equality of Function Signatures.
 int getArity()
          Returns the number of parameters (=arity) of this function
 int getExpressionCategory()
          What is the expression type of this function (as in XQUF, XQSF): SIMPLE, UPDATING, SCRIPTING, VACUOUS
 QName getName()
          Returns the name of this function as qualified QName
 TypeInfo[] getParameterTypes()
          Returns the type information for each of the parameters
 int hashCode()
          Computes the hash code of a Function Signature Only the name and number of parameters are considered, since the type of parameters is irrelevant
 boolean isNonDeterministic()
          Is this a deterministic or non-deterministic functions (as defined in XQuery 1.1)
 
Methods inherited from class java.lang.Object
getClass, notify, notifyAll, toString, wait, wait, wait
 

Field Detail

SYSTEM_FUNCTION

public static final int SYSTEM_FUNCTION
See Also:
Constant Field Values

USER_DEFINED_FUNCTION

public static final int USER_DEFINED_FUNCTION
See Also:
Constant Field Values

EXTERNAL_FUNCTION

public static final int EXTERNAL_FUNCTION
See Also:
Constant Field Values
Constructor Detail

FunctionSignature

public FunctionSignature(QName qname,
                         TypeInfo[] parameterType,
                         int type,
                         int exprType,
                         boolean nondeterministic)
Method Detail

equals

public boolean equals(java.lang.Object obj)
Checks the equality of Function Signatures. Function Signatures are equals if they have the same name and number of parameters The type of parameters is irrelevant, as no overloading on parameter types is possible

Overrides:
equals in class java.lang.Object

hashCode

public int hashCode()
Computes the hash code of a Function Signature Only the name and number of parameters are considered, since the type of parameters is irrelevant

Overrides:
hashCode in class java.lang.Object

getName

public QName getName()
Returns the name of this function as qualified QName

Returns:
the name of the function

getArity

public int getArity()
Returns the number of parameters (=arity) of this function

Returns:
The number of parameters

getParameterTypes

public TypeInfo[] getParameterTypes()
Returns the type information for each of the parameters

Returns:
A type information for each parameter

getExpressionCategory

public int getExpressionCategory()
What is the expression type of this function (as in XQUF, XQSF): SIMPLE, UPDATING, SCRIPTING, VACUOUS

Returns:
The expression type of this function

isNonDeterministic

public boolean isNonDeterministic()
Is this a deterministic or non-deterministic functions (as defined in XQuery 1.1)

Returns:
true if the function is non-deterministic

copy

public FunctionSignature copy()

MXQuery 0.6.0 API Documentation - Copyright 2006-2009 ETH Zurich

MXQuery 0.6.0 API Documentation - Copyright 2006-2009 ETH Zurich