Top Description Fields Constructors Methods
org.hsqldb

public Class Routine

extends Object
implements SchemaObject, RangeGroup, Cloneable
Class Inheritance
All Implemented Interfaces
java.lang.Cloneable, org.hsqldb.RangeGroup, org.hsqldb.SchemaObject
Imports
java.lang.reflect.InvocationTargetException, .Method, .Modifier, java.sql.ResultSet, org.hsqldb.HsqlNameManager.HsqlName, .HsqlNameManager.SimpleName, .ParserBase.Recorder, org.hsqldb.error.Error, .ErrorCode, org.hsqldb.jdbc.JDBCResultSet, org.hsqldb.lib.HsqlArrayList, .OrderedHashMap, .OrderedHashSet, org.hsqldb.map.BitMap, .ValuePool, org.hsqldb.persist.HsqlDatabaseProperties, org.hsqldb.result.Result, org.hsqldb.rights.Grantee, org.hsqldb.types.RowType, .Type, .Types

Implementation of specific routine
Author
Fred Toussi (fredt@users dot sourceforge.net)
Since
1.9.0
Version
2.7.3

Field Summary

Modifier and TypeField and Description
public static final int
pack-priv int
pack-priv int
pack-priv static final Routine[]
pack-priv boolean
pack-priv boolean
pack-priv boolean
private boolean
pack-priv boolean
pack-priv boolean
pack-priv boolean
pack-priv boolean
pack-priv Method
pack-priv boolean
pack-priv int
public static final int
public static final int
pack-priv int
private String
public static final int
private HsqlNameManager.HsqlName
public static final int
public static final int
public static final int
pack-priv OrderedHashMap<String, ColumnSchema>
pack-priv int
pack-priv Type[]
pack-priv RangeVariable[]
public static final int
pack-priv OrderedHashSet<HsqlNameManager.HsqlName>
pack-priv boolean
pack-priv Table
pack-priv Type
pack-priv RoutineSchema
pack-priv final int
private HsqlNameManager.HsqlName
pack-priv Statement
pack-priv int
pack-priv Table
pack-priv int
pack-priv int
pack-priv int

Constructor Summary

AccessConstructor and Description
public
Routine(int type)

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

Method Summary

Modifier and TypeMethod and Description
public void
pack-priv void
public void
compile(Session session, SchemaObject parentObject)

Overrides default org.hsqldb.SchemaObject.compile.

pack-priv Object[]
convertArgsToJava(Session session, Object[] callArguments)

pack-priv void
convertArgsToSQL(Session session, Object[] callArguments, Object[] data)

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

simply named function only - requires return type

public Routine
public HsqlNameManager.HsqlName
public long
public int
public int
public String
private String
getDefinitionSQL(boolean withBody)

public String
public int
public int
public Method
pack-priv static Method
getMethod(String name, Routine routine, boolean[] hasConnection, boolean returnsTable)

pack-priv static Method[]
public HsqlNameManager.HsqlName
public Grantee
public ColumnSchema
getParameter(int i)

public int
public int
public int
pack-priv int
pack-priv Type[]
public Statement
public RangeVariable[]
public OrderedHashSet<HsqlNameManager.HsqlName>
public Type
public HsqlNameManager.HsqlName
public HsqlNameManager.HsqlName
public String
public String
public String
public String
public Table
public HsqlNameManager.HsqlName[]
public HsqlNameManager.HsqlName[]
public int
public int
public Result
invoke(Session session, Object[] data, Object[] aggregateData, boolean push)

pack-priv Result
invokeJavaMethod(Session session, Object[] data)

public Result
public boolean
public boolean
public boolean
public boolean
public boolean
public boolean
pack-priv boolean
public boolean
public boolean
public static Routine
newRoutine(Session session, Method method)

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

public static Routine[]
newRoutines(Session session, Method[] methods)

public void
public void
resolve(Session session)

pack-priv void
public boolean
public void
setAggregate(boolean isAggregate)

public void
public void
public void
setDataImpact(int impact)

public void
setDeterministic(boolean value)

public void
setLanguage(int lang)

public void
public void
setMethod(Method method)

public void
public void
public void
setNewSavepointLevel(boolean value)

public void
setNullInputOutput(boolean value)

public void
setParameterStyle(int style)

public void
private void
public void
public void
public void
Inherited from java.lang.Object:
cloneequalsfinalizegetClasshashCodenotifynotifyAlltoStringwaitwaitwait

Field Detail

CONTAINS_SQLback to summary
public static final int CONTAINS_SQL
cursorCountback to summary
pack-priv int cursorCount
dataImpactback to summary
pack-priv int dataImpact
emptyArrayback to summary
pack-priv static final Routine[] emptyArray

Hides org.hsqldb.SchemaObject.emptyArray, org.hsqldb.RangeGroup.emptyArray.

isAggregateback to summary
pack-priv boolean isAggregate
isDeterministicback to summary
pack-priv boolean isDeterministic
isIndexback to summary
pack-priv boolean isIndex
isLibraryRoutineback to summary
private boolean isLibraryRoutine
isNewSavepointLevelback to summary
pack-priv boolean isNewSavepointLevel
isNullInputOutputback to summary
pack-priv boolean isNullInputOutput
isRecursiveback to summary
pack-priv boolean isRecursive
isSearchback to summary
pack-priv boolean isSearch
javaMethodback to summary
pack-priv Method javaMethod
javaMethodWithConnectionback to summary
pack-priv boolean javaMethodWithConnection
languageback to summary
pack-priv int language
LANGUAGE_JAVAback to summary
public static final int LANGUAGE_JAVA
LANGUAGE_SQLback to summary
public static final int LANGUAGE_SQL
maxDynamicResultsback to summary
pack-priv int maxDynamicResults
methodNameback to summary
private String methodName
MODIFIES_SQLback to summary
public static final int MODIFIES_SQL
nameback to summary
private HsqlNameManager.HsqlName name
NO_SQLback to summary
public static final int NO_SQL
PARAM_STYLE_JAVAback to summary
public static final int PARAM_STYLE_JAVA
PARAM_STYLE_SQLback to summary
public static final int PARAM_STYLE_SQL
parameterListback to summary
pack-priv OrderedHashMap<String, ColumnSchema> parameterList
parameterStyleback to summary
pack-priv int parameterStyle
parameterTypesback to summary
pack-priv Type[] parameterTypes
rangesback to summary
pack-priv RangeVariable[] ranges
READS_SQLback to summary
public static final int READS_SQL
referencesback to summary
pack-priv OrderedHashSet<HsqlNameManager.HsqlName> references
returnsTableback to summary
pack-priv boolean returnsTable
returnTableback to summary
pack-priv Table returnTable
returnTypeback to summary
pack-priv Type returnType
routineSchemaback to summary
pack-priv RoutineSchema routineSchema
routineTypeback to summary
pack-priv final int routineType
specificNameback to summary
private HsqlNameManager.HsqlName specificName
statementback to summary
pack-priv Statement statement
triggerOperationback to summary
pack-priv int triggerOperation
triggerTableback to summary
pack-priv Table triggerTable
triggerTypeback to summary
pack-priv int triggerType
typeGroupsback to summary
pack-priv int typeGroups
variableCountback to summary
pack-priv int variableCount

Constructor Detail

Routineback to summary
public Routine(int type)
Routineback to summary
public Routine(Table table, RangeVariable[] ranges, int impact, int triggerType, int operationType)

Method Detail

addParameterback to summary
public void addParameter(ColumnSchema param)
checkSQLDataback to summary
pack-priv void checkSQLData(Session session)
compileback to summary
public void compile(Session session, SchemaObject parentObject)

Overrides default org.hsqldb.SchemaObject.compile.

convertArgsToJavaback to summary
pack-priv Object[] convertArgsToJava(Session session, Object[] callArguments)
convertArgsToSQLback to summary
pack-priv void convertArgsToSQL(Session session, Object[] callArguments, Object[] data)
createRoutinesback to summary
public static void createRoutines(Session session, HsqlNameManager.HsqlName schema, String name)

simply named function only - requires return type

duplicateback to summary
public Routine duplicate()
getCatalogNameback to summary
public HsqlNameManager.HsqlName getCatalogName()

Implements org.hsqldb.SchemaObject.getCatalogName.

getChangeTimestampback to summary
public long getChangeTimestamp()

Implements org.hsqldb.SchemaObject.getChangeTimestamp.

getCursorCountback to summary
public int getCursorCount()
getDataImpactback to summary
public int getDataImpact()
getDataImpactStringback to summary
public String getDataImpactString()
getDefinitionSQLback to summary
private String getDefinitionSQL(boolean withBody)
getExternalNameback to summary
public String getExternalName()
getLanguageback to summary
public int getLanguage()
getMaxDynamicResultsback to summary
public int getMaxDynamicResults()
getMethodback to summary
public Method getMethod()
getMethodback to summary
pack-priv static Method getMethod(String name, Routine routine, boolean[] hasConnection, boolean returnsTable)
getMethodsback to summary
pack-priv static Method[] getMethods(String name)
getNameback to summary
public HsqlNameManager.HsqlName getName()

Implements org.hsqldb.SchemaObject.getName.

getOwnerback to summary
public Grantee getOwner()

Implements org.hsqldb.SchemaObject.getOwner.

getParameterback to summary
public ColumnSchema getParameter(int i)
getParameterCountback to summary
public int getParameterCount()
getParameterCountback to summary
public int getParameterCount(int type)
getParameterIndexback to summary
public int getParameterIndex(String name)
getParameterSignatureback to summary
pack-priv int getParameterSignature()
getParameterTypesback to summary
pack-priv Type[] getParameterTypes()
getProcedureback to summary
public Statement getProcedure()
getRangeVariablesback to summary
public RangeVariable[] getRangeVariables()

Implements org.hsqldb.RangeGroup.getRangeVariables.

getReferencesback to summary
public OrderedHashSet<HsqlNameManager.HsqlName> getReferences()

Overrides default org.hsqldb.SchemaObject.getReferences.

getReturnTypeback to summary
public Type getReturnType()
getSchemaNameback to summary
public HsqlNameManager.HsqlName getSchemaName()

Implements org.hsqldb.SchemaObject.getSchemaName.

getSpecificNameback to summary
public HsqlNameManager.HsqlName getSpecificName()
getSQLback to summary
public String getSQL()

Implements org.hsqldb.SchemaObject.getSQL.

getSQLAlterback to summary
public String getSQLAlter()
getSQLBodyDefinitionback to summary
public String getSQLBodyDefinition()
getSQLDeclarationback to summary
public String getSQLDeclaration()
getTableback to summary
public Table getTable()
getTableNamesForReadback to summary
public HsqlNameManager.HsqlName[] getTableNamesForRead()
getTableNamesForWriteback to summary
public HsqlNameManager.HsqlName[] getTableNamesForWrite()
getTypeback to summary
public int getType()

Implements org.hsqldb.SchemaObject.getType.

getVariableCountback to summary
public int getVariableCount()
invokeback to summary
public Result invoke(Session session, Object[] data, Object[] aggregateData, boolean push)
invokeJavaMethodback to summary
pack-priv Result invokeJavaMethod(Session session, Object[] data)
invokeJavaMethodDirectback to summary
public Result invokeJavaMethodDirect(Object[] data)
isAggregateback to summary
public boolean isAggregate()
isDeterministicback to summary
public boolean isDeterministic()
isFunctionback to summary
public boolean isFunction()
isLibraryRoutineback to summary
public boolean isLibraryRoutine()
isNullInputOutputback to summary
public boolean isNullInputOutput()
isProcedureback to summary
public boolean isProcedure()
isPSMback to summary
pack-priv boolean isPSM()
isTriggerback to summary
public boolean isTrigger()
isVariableback to summary
public boolean isVariable()

Implements org.hsqldb.RangeGroup.isVariable.

newRoutineback to summary
public static Routine newRoutine(Session session, Method method)

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

newRoutinesback to summary
public static Routine[] newRoutines(Session session, Method[] methods)
resetAlteredRoutineSettingsback to summary
public void resetAlteredRoutineSettings()
resolveback to summary
public void resolve(Session session)
resolveReferencesback to summary
pack-priv void resolveReferences(Session session)
returnsTableback to summary
public boolean returnsTable()
setAggregateback to summary
public void setAggregate(boolean isAggregate)
setAsAlteredRoutineback to summary
public void setAsAlteredRoutine(Routine routine)
setCorrelatedback to summary
public void setCorrelated()

Implements org.hsqldb.RangeGroup.setCorrelated.

setDataImpactback to summary
public void setDataImpact(int impact)
setDeterministicback to summary
public void setDeterministic(boolean value)
setLanguageback to summary
public void setLanguage(int lang)
setMaxDynamicResultsback to summary
public void setMaxDynamicResults(int value)
setMethodback to summary
public void setMethod(Method method)
setMethodURLback to summary
public void setMethodURL(String url)
setNameback to summary
public void setName(HsqlNameManager.HsqlName name)
setNewSavepointLevelback to summary
public void setNewSavepointLevel(boolean value)
setNullInputOutputback to summary
public void setNullInputOutput(boolean value)
setParameterStyleback to summary
public void setParameterStyle(int style)
setProcedureback to summary
public void setProcedure(Statement statement)
setReferencesback to summary
private void setReferences()
setReturnTableback to summary
public void setReturnTable(TableDerived table)
setReturnTypeback to summary
public void setReturnType(Type type)
setSpecificNameback to summary
public void setSpecificName(HsqlNameManager.HsqlName name)