gudusoft.gsqlparser.sqlenv

Class TSQLRoutine

Object

gudusoft.gsqlparser.sqlenv.TSQLObject

gudusoft.gsqlparser.sqlenv.TSQLSchemaObject

gudusoft.gsqlparser.sqlenv.TSQLRoutine

Direct Known Subclasses:

TSQLOraclePackage, TSQLProcedure

public abstract class TSQLRoutine
extends TSQLSchemaObject

Nested Class Summary

Nested Classes

Modifier and Type	Class and Description
static class	TSQLRoutine.PresetValue A value set in advance for a parameter of the routine (Mantis 4962): the dynamic SQL evaluation of the routine reads it as the parameter's value, ahead of the routine's call sites, as a caller passing it would.

Field Summary

Fields inherited from class gudusoft.gsqlparser.sqlenv.TSQLObject

dataObjectType, name, nameKeepCase, sqlEnv

Constructor Summary

Constructors

Constructor and Description
TSQLRoutine(TSQLSchema schema, String objectName, ESQLDataObjectType dataObjectType)

Method Summary

Modifier and Type	Method and Description
void	addParameter(int index, TTypeName parameterDataType)
void	addParameter(int index, TTypeName parameterDataType, String parameterName)
void	applyParameterBindings(Map<?,?> bindings, String origin) Sets the presets a metadata file gives the routine (procedures[].parameterBindings): each entry a parameter name and a JSON value, a string, a number, or null for SQL NULL.
String	getDefinition()
TSQLParameter	getParameter(int index, TTypeName datatype, String parameterName)
List<TSQLParameter>	getParameterList() column list
TSQLRoutine.PresetValue	getParameterPreset(String parameterName) The preset of the parameter named parameterName, or null when none is set.
Map<String,TSQLRoutine.PresetValue>	getParameterPresets() Every preset, by the name it was set under, in the order set.
void	mergeParameterPresets(TSQLRoutine from, String origin) Takes over from's presets; one it gives for a parameter replaces this routine's, logged.
boolean	searchParameter(int index, TTypeName datatype, String parameterName)
void	setDefinition(String definition)
void	setParameterPreset(String parameterName, TSQLRoutine.PresetValue value) Sets, or with a null value removes, the preset of the parameter named parameterName, as the procedure declares it (@pipeline_type); the name is compared as the vendor compares column names.

Methods inherited from class gudusoft.gsqlparser.sqlenv.TSQLSchemaObject

getPriority, getQualifiedName, getSchema, setPriority

Methods inherited from class gudusoft.gsqlparser.sqlenv.TSQLObject

compareTo, compareTo, compareTo, compareTo, getDataObjectType, getName, getNameKeepCase, getSqlEnv, isDelimitedIdentifier, isDelimitedIdentifier, normalizeIdentifier, setDataObjectType

Methods inherited from class Object

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

Constructor Detail

TSQLRoutine

public TSQLRoutine(TSQLSchema schema,
                   String objectName,
                   ESQLDataObjectType dataObjectType)

Method Detail

setDefinition

public void setDefinition(String definition)

getDefinition

public String getDefinition()

getParameterList

public List<TSQLParameter> getParameterList()

column list

Returns:

a column list

addParameter

public void addParameter(int index,
                         TTypeName parameterDataType)

addParameter

public void addParameter(int index,
                         TTypeName parameterDataType,
                         String parameterName)

searchParameter

public boolean searchParameter(int index,
                               TTypeName datatype,
                               String parameterName)

getParameter

public TSQLParameter getParameter(int index,
                                  TTypeName datatype,
                                  String parameterName)

setParameterPreset

public void setParameterPreset(String parameterName,
                               TSQLRoutine.PresetValue value)

Sets, or with a null value removes, the preset of the parameter named parameterName, as the procedure declares it (@pipeline_type); the name is compared as the vendor compares column names.

getParameterPreset

public TSQLRoutine.PresetValue getParameterPreset(String parameterName)

The preset of the parameter named parameterName, or null when none is set.

getParameterPresets

public Map<String,TSQLRoutine.PresetValue> getParameterPresets()

Every preset, by the name it was set under, in the order set.

applyParameterBindings

public void applyParameterBindings(Map<?,?> bindings,
                                   String origin)

Sets the presets a metadata file gives the routine (procedures[].parameterBindings): each entry a parameter name and a JSON value, a string, a number, or null for SQL NULL. A value of another kind (true, false, an object, an array) is not read and is logged with origin. A later file's preset of a parameter replaces an earlier one's.

mergeParameterPresets

public void mergeParameterPresets(TSQLRoutine from,
                                  String origin)

Takes over from's presets; one it gives for a parameter replaces this routine's, logged.