Deveel.Data.Routines.FunctionInfo Class Reference

The function signature information that are used to resolve a function within a context. More...

Inheritance diagram for Deveel.Data.Routines.FunctionInfo:

Public Member Functions
	FunctionInfo (ObjectName routineName, FunctionType functionType)
	Constructs a FunctionInfo without arguments. More...
	FunctionInfo (ObjectName routineName, SqlType returnType)
	FunctionInfo (ObjectName routineName, SqlType returnType, FunctionType functionType)
	FunctionInfo (ObjectName routineName, RoutineParameter[] parameters)
	FunctionInfo (ObjectName routineName, RoutineParameter[] parameters, FunctionType functionType)
	FunctionInfo (ObjectName routineName, RoutineParameter[] parameters, SqlType returnType)
	FunctionInfo (ObjectName routineName, RoutineParameter[] parameters, SqlType returnType, FunctionType functionType)
Public Member Functions inherited from Deveel.Data.Routines.RoutineInfo
override string	ToString ()

Package Functions
override bool	MatchesInvoke (Invoke request, IQuery query)

Properties
override RoutineType	RoutineType [get]
SqlType	ReturnType [get, private set]
bool	HasUnboundParameter [get, set]
FunctionType	FunctionType [get, private set]
	Gets the kind of function. More...
Properties inherited from Deveel.Data.Routines.RoutineInfo
DbObjectType IObjectInfo.	ObjectType [get]
ObjectName IObjectInfo.	FullName [get]
ObjectName	RoutineName [get, private set]
	Gets the name of the routine that uniquely identifies it in a system context. More...
abstract RoutineType	RoutineType [get]
RoutineParameter[]	Parameters [get, private set]
	Gets an array of parameters for the routine. More...
string	ExternalMethodName [get, set]
Type	ExternalType [get, set]
Properties inherited from Deveel.Data.Sql.IObjectInfo
DbObjectType	ObjectType [get]
ObjectName	FullName [get]

Private Member Functions
void	AssertUnboundAtEnd ()

Additional Inherited Members
Protected Member Functions inherited from Deveel.Data.Routines.RoutineInfo
	RoutineInfo (ObjectName routineName)
	Constructs a routine info with the given name. More...
	RoutineInfo (ObjectName routineName, RoutineParameter[] parameters)
	Constructs the routine info with the given signature. More...

Detailed Description

The function signature information that are used to resolve a function within a context.

See also

RoutineInfo

Definition at line 30 of file FunctionInfo.cs.

Constructor & Destructor Documentation

Deveel.Data.Routines.FunctionInfo.FunctionInfo ( ObjectName  routineName, FunctionType  functionType  )

inline

Constructs a FunctionInfo without arguments.

Parameters

routineName	The name of the function.
functionType	The type of function this

Definition at line 36 of file FunctionInfo.cs.

            : this(routineName, (SqlType)null, functionType) {
        }

Deveel.Data.Routines.FunctionInfo.FunctionInfo ( ObjectName  routineName, SqlType  returnType  )

inline

Definition at line 40 of file FunctionInfo.cs.

            : this(routineName, returnType, FunctionType.Static) {
        }

Deveel.Data.Routines.FunctionInfo.FunctionInfo ( ObjectName  routineName, SqlType  returnType, FunctionType  functionType  )

inline

Definition at line 44 of file FunctionInfo.cs.

            : base(routineName) {
            ReturnType = returnType;
            FunctionType = functionType;
            AssertUnboundAtEnd();
        }

Deveel.Data.Routines.FunctionInfo.FunctionInfo ( ObjectName  routineName, RoutineParameter[]  parameters  )

inline

Definition at line 51 of file FunctionInfo.cs.

            : this(routineName, parameters, FunctionType.Static) {
        }

Deveel.Data.Routines.FunctionInfo.FunctionInfo ( ObjectName  routineName, RoutineParameter[]  parameters, FunctionType  functionType  )

inline

Definition at line 55 of file FunctionInfo.cs.

            : this(routineName, parameters, null, functionType) {
        }

Deveel.Data.Routines.FunctionInfo.FunctionInfo ( ObjectName  routineName, RoutineParameter[]  parameters, SqlType  returnType  )

inline

Definition at line 59 of file FunctionInfo.cs.

            : this(routineName, parameters, returnType, FunctionType.Static) {
        }

Deveel.Data.Routines.FunctionInfo.FunctionInfo ( ObjectName  routineName, RoutineParameter[]  parameters, SqlType  returnType, FunctionType  functionType  )

inline

Definition at line 63 of file FunctionInfo.cs.

            : base(routineName, parameters) {
            ReturnType = returnType;
            FunctionType = functionType;
            AssertUnboundAtEnd();
        }

Member Function Documentation

void Deveel.Data.Routines.FunctionInfo.AssertUnboundAtEnd ( )

inlineprivate

Definition at line 76 of file FunctionInfo.cs.

                                          {
            for (int i = 0; i < Parameters.Length; i++) {
                var param = Parameters[i];
                if (param.IsUnbounded) {
                    if (HasUnboundParameter)
                        throw new ArgumentException("Cannot specify more than one 'unbounded' argument for a function.");

                    if (i != Parameters.Length - 1)
                        throw new ArgumentException("An unbounded parameter must be present only at the end.");

                    HasUnboundParameter = true;
                }
            }
        }

override bool Deveel.Data.Routines.FunctionInfo.MatchesInvoke ( Invoke  request, IQuery  query  )

inlinepackagevirtual

Implements Deveel.Data.Routines.RoutineInfo.

Definition at line 98 of file FunctionInfo.cs.

                                                                           {
            if (request == null)
                return false;

            bool ignoreCase = true;
            if (query != null)
                ignoreCase = query.IgnoreIdentifiersCase();

            if (!RoutineName.Equals(request.RoutineName, ignoreCase))
                return false;

            // TODO: add a better resolution to obtain the final type of the argument
            //       and compare it to the parameter type definition
            bool unboundedSeen = false;
            for (int i = 0; i < request.Arguments.Length; i++) {
                var argType = request.Arguments[i].ReturnType(query, null);

                if (i + 1 > Parameters.Length) {
                    if (!unboundedSeen)
                        return false;

                    // TODO: verify the type of the argument (how to evaluate?)

                } else {
                    var param = Parameters[i];
                    unboundedSeen = param.IsUnbounded;

                    var paramType = param.Type;

                    if (!paramType.IsComparable(argType))
                        return false;
                }
            }

            if (!unboundedSeen &&
                request.Arguments.Length != Parameters.Length)
                return false;

            return true;
        }

Property Documentation

FunctionType Deveel.Data.Routines.FunctionInfo.FunctionType

getprivate set

Gets the kind of function.

Definition at line 96 of file FunctionInfo.cs.

bool Deveel.Data.Routines.FunctionInfo.HasUnboundParameter

getsetprivate

Definition at line 91 of file FunctionInfo.cs.

SqlType Deveel.Data.Routines.FunctionInfo.ReturnType

getprivate set

Definition at line 74 of file FunctionInfo.cs.

override RoutineType Deveel.Data.Routines.FunctionInfo.RoutineType

get

Definition at line 70 of file FunctionInfo.cs.

---

The documentation for this class was generated from the following file:

• /var/calculate/remote/distfiles/egit-src/deveeldb.git/src/deveeldb/Deveel.Data.Routines/FunctionInfo.cs