org.hsqldb

Class Routine

java.lang.Object

org.hsqldb.Routine

All Implemented Interfaces:

java.lang.Cloneable, RangeGroup, SchemaObject

public class Routine
extends java.lang.Object
implements SchemaObject, RangeGroup, java.lang.Cloneable

Implementation of specific routine

Since:

1.9.0

Nested Class Summary

Nested classes/interfaces inherited from interface org.hsqldb.SchemaObject

SchemaObject.ConstraintTypes, SchemaObject.Deferable, SchemaObject.Nullability, SchemaObject.ParameterModes, SchemaObject.ReferentialAction, SchemaObject.ViewCheckModes

Nested classes/interfaces inherited from interface org.hsqldb.RangeGroup

RangeGroup.RangeGroupEmpty, RangeGroup.RangeGroupSimple

Field Summary

Fields

Modifier and Type	Field and Description
static int	CONTAINS_SQL
static int	LANGUAGE_JAVA
static int	LANGUAGE_SQL
static int	MODIFIES_SQL
static int	NO_SQL
static int	PARAM_STYLE_JAVA
static int	PARAM_STYLE_SQL
static int	READS_SQL

Fields inherited from interface org.hsqldb.SchemaObject

ASSERTION, CATALOG, CHARSET, COLLATION, COLUMN, CONSTRAINT, CURSOR, DOMAIN, FUNCTION, GRANTEE, INDEX, LABEL, PARAMETER, PROCEDURE, ROUTINE, SCHEMA, SEARCH, SEQUENCE, SERVER, SPECIFIC_ROUTINE, SUBQUERY, TABLE, TRANSITION, TRIGGER, TYPE, VARIABLE, VIEW, WRAPPER

Fields inherited from interface org.hsqldb.RangeGroup

emptyGroup

Constructor Summary

Constructors

Constructor and Description
Routine(int type)
Routine(Table table, RangeVariable[] ranges, int impact, int triggerType, int operationType)

Method Summary

Modifier and Type	Method and Description
void	addParameter(ColumnSchema param)
void	compile(Session session, SchemaObject parentObject)
static void	createRoutines(Session session, HsqlNameManager.HsqlName schema, java.lang.String name)
Routine	duplicate()
HsqlNameManager.HsqlName	getCatalogName()
long	getChangeTimestamp()
OrderedHashSet	getComponents()
int	getDataImpact()
java.lang.String	getDataImpactString()
java.lang.String	getExternalName()
int	getLanguage()
int	getMaxDynamicResults()
java.lang.reflect.Method	getMethod()
HsqlNameManager.HsqlName	getName()
Grantee	getOwner()
ColumnSchema	getParameter(int i)
int	getParameterCount()
int	getParameterCount(int type)
int	getParameterIndex(java.lang.String name)
Statement	getProcedure()
RangeVariable[]	getRangeVariables()
OrderedHashSet	getReferences()
Type	getReturnType()
HsqlNameManager.HsqlName	getSchemaName()
HsqlNameManager.HsqlName	getSpecificName()
java.lang.String	getSQL()
java.lang.String	getSQLAlter()
java.lang.String	getSQLBodyDefinition()
java.lang.String	getSQLDeclaration()
Table	getTable()
HsqlNameManager.HsqlName[]	getTableNamesForRead()
HsqlNameManager.HsqlName[]	getTableNamesForWrite()
Type[]	getTableType()
int	getType()
int	getVariableCount()
Result	invoke(Session session, java.lang.Object[] data, java.lang.Object[] aggregateData, boolean push)
Result	invokeJavaMethodDirect(java.lang.Object[] data)
boolean	isAggregate()
boolean	isDeterministic()
boolean	isFunction()
boolean	isLibraryRoutine()
boolean	isNullInputOutput()
boolean	isProcedure()
boolean	isTrigger()
boolean	isVariable()
static Routine	newRoutine(Session session, java.lang.reflect.Method method) Returns a new function Routine object based solely on a Java Method object.
static Routine[]	newRoutines(Session session, java.lang.reflect.Method[] methods)
void	resetAlteredRoutineSettings()
void	resolve(Session session)
boolean	returnsTable()
void	setAggregate(boolean isAggregate)
void	setAsAlteredRoutine(Routine routine)
void	setCorrelated()
void	setDataImpact(int impact)
void	setDeterministic(boolean value)
void	setLanguage(int lang)
void	setMaxDynamicResults(int value)
void	setMethod(java.lang.reflect.Method method)
void	setMethodURL(java.lang.String url)
void	setName(HsqlNameManager.HsqlName name)
void	setNewSavepointLevel(boolean value)
void	setNullInputOutput(boolean value)
void	setParameterStyle(int style)
void	setProcedure(Statement statement)
void	setReturnTable(TableDerived table)
void	setReturnType(Type type)
void	setSpecificName(HsqlNameManager.HsqlName name)
void	setTableType(Type[] types)

Methods inherited from class java.lang.Object

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

Field Detail

NO_SQL

public static final int NO_SQL

See Also:

Constant Field Values

CONTAINS_SQL

public static final int CONTAINS_SQL

See Also:

Constant Field Values

READS_SQL

public static final int READS_SQL

See Also:

Constant Field Values

MODIFIES_SQL

public static final int MODIFIES_SQL

See Also:

Constant Field Values

LANGUAGE_JAVA

public static final int LANGUAGE_JAVA

See Also:

Constant Field Values

LANGUAGE_SQL

public static final int LANGUAGE_SQL

See Also:

Constant Field Values

PARAM_STYLE_JAVA

public static final int PARAM_STYLE_JAVA

See Also:

Constant Field Values

PARAM_STYLE_SQL

public static final int PARAM_STYLE_SQL

See Also:

Constant Field Values

Constructor Detail

Routine

public Routine(int type)

Routine

public Routine(Table table,
               RangeVariable[] ranges,
               int impact,
               int triggerType,
               int operationType)

Method Detail

getType

public int getType()

Specified by:

getType in interface SchemaObject

getName

public HsqlNameManager.HsqlName getName()

Specified by:

getName in interface SchemaObject

getSchemaName

public HsqlNameManager.HsqlName getSchemaName()

Specified by:

getSchemaName in interface SchemaObject

getCatalogName

public HsqlNameManager.HsqlName getCatalogName()

Specified by:

getCatalogName in interface SchemaObject

getOwner

public Grantee getOwner()

Specified by:

getOwner in interface SchemaObject

getReferences

public OrderedHashSet getReferences()

Specified by:

getReferences in interface SchemaObject

getComponents

public OrderedHashSet getComponents()

Specified by:

getComponents in interface SchemaObject

compile

public void compile(Session session,
                    SchemaObject parentObject)

Specified by:

compile in interface SchemaObject

getSQL

public java.lang.String getSQL()

Specified by:

getSQL in interface SchemaObject

getSQLAlter

public java.lang.String getSQLAlter()

getSQLDeclaration

public java.lang.String getSQLDeclaration()

getSQLBodyDefinition

public java.lang.String getSQLBodyDefinition()

getExternalName

public java.lang.String getExternalName()

getChangeTimestamp

public long getChangeTimestamp()

Specified by:

getChangeTimestamp in interface SchemaObject

addParameter

public void addParameter(ColumnSchema param)

setLanguage

public void setLanguage(int lang)

getLanguage

public int getLanguage()

setDataImpact

public void setDataImpact(int impact)

getDataImpact

public int getDataImpact()

getDataImpactString

public java.lang.String getDataImpactString()

setReturnType

public void setReturnType(Type type)

getReturnType

public Type getReturnType()

setTableType

public void setTableType(Type[] types)

getTableType

public Type[] getTableType()

getTable

public Table getTable()

setProcedure

public void setProcedure(Statement statement)

getProcedure

public Statement getProcedure()

setSpecificName

public void setSpecificName(HsqlNameManager.HsqlName name)

getMaxDynamicResults

public int getMaxDynamicResults()

setName

public void setName(HsqlNameManager.HsqlName name)

getSpecificName

public HsqlNameManager.HsqlName getSpecificName()

setDeterministic

public void setDeterministic(boolean value)

isDeterministic

public boolean isDeterministic()

setNullInputOutput

public void setNullInputOutput(boolean value)

isNullInputOutput

public boolean isNullInputOutput()

setNewSavepointLevel

public void setNewSavepointLevel(boolean value)

setMaxDynamicResults

public void setMaxDynamicResults(int value)

setParameterStyle

public void setParameterStyle(int style)

setMethodURL

public void setMethodURL(java.lang.String url)

getMethod

public java.lang.reflect.Method getMethod()

setMethod

public void setMethod(java.lang.reflect.Method method)

setReturnTable

public void setReturnTable(TableDerived table)

returnsTable

public boolean returnsTable()

setAggregate

public void setAggregate(boolean isAggregate)

isAggregate

public boolean isAggregate()

resolve

public void resolve(Session session)

isTrigger

public boolean isTrigger()

isProcedure

public boolean isProcedure()

isFunction

public boolean isFunction()

getParameter

public ColumnSchema getParameter(int i)

getParameterCount

public int getParameterCount()

getParameterCount

public int getParameterCount(int type)

getParameterIndex

public int getParameterIndex(java.lang.String name)

getRangeVariables

public RangeVariable[] getRangeVariables()

Specified by:

getRangeVariables in interface RangeGroup

setCorrelated

public void setCorrelated()

Specified by:

setCorrelated in interface RangeGroup

isVariable

public boolean isVariable()

Specified by:

isVariable in interface RangeGroup

getVariableCount

public int getVariableCount()

isLibraryRoutine

public boolean isLibraryRoutine()

getTableNamesForRead

public HsqlNameManager.HsqlName[] getTableNamesForRead()

getTableNamesForWrite

public HsqlNameManager.HsqlName[] getTableNamesForWrite()

resetAlteredRoutineSettings

public void resetAlteredRoutineSettings()

setAsAlteredRoutine

public void setAsAlteredRoutine(Routine routine)

invokeJavaMethodDirect

public Result invokeJavaMethodDirect(java.lang.Object[] data)

invoke

public Result invoke(Session session,
                     java.lang.Object[] data,
                     java.lang.Object[] aggregateData,
                     boolean push)

duplicate

public Routine duplicate()

newRoutines

public static Routine[] newRoutines(Session session,
                                    java.lang.reflect.Method[] methods)

newRoutine

public static Routine newRoutine(Session session,
                                 java.lang.reflect.Method method)

Returns a new function Routine object based solely on a Java Method object.

createRoutines

public static void createRoutines(Session session,
                                  HsqlNameManager.HsqlName schema,
                                  java.lang.String name)