gudusoft.gsqlparser.dlineage.routine

Class RoutineDeclaration

Object

gudusoft.gsqlparser.dlineage.routine.RoutineDeclaration

public final class RoutineDeclaration
extends Object

One declared routine: its name as written (one interpretation), its kind, its parameters, and the scope it is declared in when it is local to another routine.

Its identity is the routine it declares: the name's keys, the namespace it lives in, and the parameters as far as the vendor tells routines of one name apart by them (RoutineDeclaration.Signature). Two declarations with one identity are one routine declared twice (CREATE OR REPLACE, a package specification and its body); where the vendor overloads, a same-named declaration with other parameters is another routine. Parameter counts are only lookup aliases: a call supplies arguments, not types, and matches a declaration when the number of arguments lies between its required inputs and its inputs, or equals its parameter count.

Nested Class Summary

Nested Classes

Modifier and Type	Class and Description
static class	RoutineDeclaration.Identity The identity of a declared routine.
static class	RoutineDeclaration.Signature How much of its parameter list a vendor identifies a routine by.

Method Summary

Modifier and Type	Method and Description
boolean	acceptsCount(int count) Whether a call with count arguments can be this routine: any count for a routine keyed by its name alone, else its parameter count, or a count from its required inputs up to its inputs (no upper bound with a VARIADIC parameter).
static boolean	callsCounted(EDbVendor vendor) Whether a call site keys its lookup with the argument count: some routine of the vendor uses count aliases.
RoutineName	getName()
CatalogObjectKind	getNamespace()
Object	getOrigin() The statement or node this occurrence was declared by.
Object	getRepresentative() The first occurrence of this declaration's identity: the one a later occurrence replaced keeps its place.
int	getTotalCount()
List<ArgumentTypeKey>	getTypes()
boolean	hasSignatureAliases() Whether the declaration is keyed with its signature (a lookup by name only reaches it by the fallback).
RoutineDeclaration.Identity	identity()
static boolean	identityOverloads(EDbVendor vendor, CatalogObjectKind kind, boolean memberOrLocal) Whether the vendor tells routines of this kind apart by their parameters (their identity is not the name alone).
static RoutineDeclaration	of(Object model, Object origin, RoutineName name, TParameterDeclarationList parameters, EDbVendor vendor, IdentifierService service) of(Object, RoutineName, TParameterDeclarationList, Object, EDbVendor, IdentifierService) for a top-level routine; model is not kept (the typed registry holds declarations, not legacy models).
static RoutineDeclaration	of(Object origin, RoutineName name, TParameterDeclarationList parameters, Object scope, EDbVendor vendor, IdentifierService service) A declaration from its AST: scope the routine it is local to (null for a top-level or package routine).
static RoutineDeclaration	ofCall(Object origin, RoutineName name, Integer argumentCount, EDbVendor vendor) A routine known only from a call or an EXEC of a module never defined here: a name and a count.
static RoutineDeclaration.Signature	signatureOf(EDbVendor vendor, CatalogObjectKind kind, boolean memberOrLocal) The signature a vendor identifies a routine of this kind by.
String	toString()
static boolean	usesCountAliases(EDbVendor vendor, CatalogObjectKind kind, boolean memberOrLocal) Whether declarations of this kind are keyed with their argument counts, so a call is looked up by its argument count: where the vendor overloads routines of the kind, and wherever the legacy registry keyed them so (standalone Oracle routines, MySQL, HANA).

Methods inherited from class Object

clone, equals, finalize, getClass, hashCode, notify, notifyAll, wait, wait, wait

Method Detail

signatureOf

public static RoutineDeclaration.Signature signatureOf(EDbVendor vendor,
                                                       CatalogObjectKind kind,
                                                       boolean memberOrLocal)

The signature a vendor identifies a routine of this kind by.

identityOverloads

public static boolean identityOverloads(EDbVendor vendor,
                                        CatalogObjectKind kind,
                                        boolean memberOrLocal)

Whether the vendor tells routines of this kind apart by their parameters (their identity is not the name alone).

usesCountAliases

public static boolean usesCountAliases(EDbVendor vendor,
                                       CatalogObjectKind kind,
                                       boolean memberOrLocal)

Whether declarations of this kind are keyed with their argument counts, so a call is looked up by its argument count: where the vendor overloads routines of the kind, and wherever the legacy registry keyed them so (standalone Oracle routines, MySQL, HANA). A count alias on a routine alone under its name finds nothing it should not; the identity stays the name alone.

callsCounted

public static boolean callsCounted(EDbVendor vendor)

Whether a call site keys its lookup with the argument count: some routine of the vendor uses count aliases.

of

public static RoutineDeclaration of(Object origin,
                                    RoutineName name,
                                    TParameterDeclarationList parameters,
                                    Object scope,
                                    EDbVendor vendor,
                                    IdentifierService service)

A declaration from its AST: scope the routine it is local to (null for a top-level or package routine). A statement with no parameter list (parameters null: Oracle CREATE PROCEDURE p IS, DB2 CREATE FUNCTION f ()) declares a routine with no parameters.

of

public static RoutineDeclaration of(Object model,
                                    Object origin,
                                    RoutineName name,
                                    TParameterDeclarationList parameters,
                                    EDbVendor vendor,
                                    IdentifierService service)

of(Object, RoutineName, TParameterDeclarationList, Object, EDbVendor, IdentifierService) for a top-level routine; model is not kept (the typed registry holds declarations, not legacy models).

ofCall

public static RoutineDeclaration ofCall(Object origin,
                                        RoutineName name,
                                        Integer argumentCount,
                                        EDbVendor vendor)

A routine known only from a call or an EXEC of a module never defined here: a name and a count.

getOrigin

public Object getOrigin()

The statement or node this occurrence was declared by.

getRepresentative

public Object getRepresentative()

The first occurrence of this declaration's identity: the one a later occurrence replaced keeps its place.

getName

public RoutineName getName()

getNamespace

public CatalogObjectKind getNamespace()

getTypes

public List<ArgumentTypeKey> getTypes()

getTotalCount

public int getTotalCount()

hasSignatureAliases

public boolean hasSignatureAliases()

Whether the declaration is keyed with its signature (a lookup by name only reaches it by the fallback).

acceptsCount

public boolean acceptsCount(int count)

Whether a call with count arguments can be this routine: any count for a routine keyed by its name alone, else its parameter count, or a count from its required inputs up to its inputs (no upper bound with a VARIADIC parameter).

identity

public RoutineDeclaration.Identity identity()

toString

public String toString()

Overrides:

toString in class Object