com.foundationdb.sql.types

Class RoutineAliasInfo

java.lang.Object

com.foundationdb.sql.types.MethodAliasInfo

com.foundationdb.sql.types.RoutineAliasInfo

All Implemented Interfaces:

AliasInfo

public class RoutineAliasInfo
extends MethodAliasInfo

Describe a routine (procedure or function) alias.

See Also:

AliasInfo

Nested Class Summary

Nested Classes

Modifier and Type	Class and Description
static class	RoutineAliasInfo.SQLAllowed

Nested classes/interfaces inherited from interface com.foundationdb.sql.types.AliasInfo

AliasInfo.Type

Constructor Summary

Constructors

Constructor and Description

RoutineAliasInfo(String methodName, int parameterCount, String[] parameterNames, DataTypeDescriptor[] parameterTypes, int[] parameterModes, int dynamicResultSets, String language, String parameterStyle, RoutineAliasInfo.SQLAllowed sqlAllowed, boolean deterministic, boolean definersRights, boolean calledOnNullInput, DataTypeDescriptor returnType) Create a RoutineAliasInfo for a PROCEDURE or FUNCTION

Method Summary

Methods

Modifier and Type	Method and Description
boolean	calledOnNullInput()
String	getLanguage()
int	getMaxDynamicResultSets()
int	getParameterCount()
int[]	getParameterModes()
String[]	getParameterNames() Returns an array containing the names of the parameters.
String	getParameterStyle()
DataTypeDescriptor[]	getParameterTypes() Types of the parameters.
DataTypeDescriptor	getReturnType()
RoutineAliasInfo.SQLAllowed	getSQLAllowed()
boolean	hasDefinersRights()
boolean	isDeterministic()
boolean	isFunction()
boolean	isTableFunction() Return true if this alias is a Table Function.
static String	parameterMode(int parameterMode)
String	toString() Get this alias info as a string.

Methods inherited from class com.foundationdb.sql.types.MethodAliasInfo

getMethodName

Methods inherited from class java.lang.Object

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

Constructor Detail

RoutineAliasInfo

public RoutineAliasInfo(String methodName,
                int parameterCount,
                String[] parameterNames,
                DataTypeDescriptor[] parameterTypes,
                int[] parameterModes,
                int dynamicResultSets,
                String language,
                String parameterStyle,
                RoutineAliasInfo.SQLAllowed sqlAllowed,
                boolean deterministic,
                boolean definersRights,
                boolean calledOnNullInput,
                DataTypeDescriptor returnType)

Create a RoutineAliasInfo for a PROCEDURE or FUNCTION

Method Detail

getParameterCount

public int getParameterCount()

getParameterTypes

public DataTypeDescriptor[] getParameterTypes()

Types of the parameters. If there are no parameters then this may return null (or a zero length array).

getParameterModes

public int[] getParameterModes()

getParameterNames

public String[] getParameterNames()

Returns an array containing the names of the parameters. As of DERBY 10.3, parameter names are optional (see DERBY-183 for more information). If the i-th parameter was unnamed, parameterNames[i] will contain a string of length 0.

getMaxDynamicResultSets

public int getMaxDynamicResultSets()

getLanguage

public String getLanguage()

getParameterStyle

public String getParameterStyle()

getSQLAllowed

public RoutineAliasInfo.SQLAllowed getSQLAllowed()

isDeterministic

public boolean isDeterministic()

hasDefinersRights

public boolean hasDefinersRights()

calledOnNullInput

public boolean calledOnNullInput()

getReturnType

public DataTypeDescriptor getReturnType()

isFunction

public boolean isFunction()

isTableFunction

public boolean isTableFunction()

Description copied from interface: AliasInfo

Return true if this alias is a Table Function.

Specified by:

isTableFunction in interface AliasInfo

Overrides:

isTableFunction in class MethodAliasInfo

toString

public String toString()

Get this alias info as a string. This method must return a string that is syntactically valid.

Overrides:

toString in class MethodAliasInfo

parameterMode

public static String parameterMode(int parameterMode)