|
|||||||||
PREV CLASS NEXT CLASS | FRAMES NO FRAMES | ||||||||
SUMMARY: NESTED | FIELD | CONSTR | METHOD | DETAIL: FIELD | CONSTR | METHOD |
java.lang.Objectorg.apache.derby.catalog.types.MethodAliasInfo
org.apache.derby.catalog.types.RoutineAliasInfo
public class RoutineAliasInfo
Describe a routine (procedure or function) alias.
AliasInfo
,
Serialized FormField Summary | |
---|---|
private char |
aliasType
|
private boolean |
calledOnNullInput
True if the routine is called on null input. |
static short |
CONTAINS_SQL
|
private static short |
DETERMINISTIC_MASK
|
private int |
dynamicResultSets
|
static short |
MODIFIES_SQL_DATA
|
static short |
NO_SQL
|
private int |
parameterCount
|
private int[] |
parameterModes
IN, OUT, INOUT |
private java.lang.String[] |
parameterNames
Name of each parameter. |
private short |
parameterStyle
Parameter style - always PS_JAVA at the moment. |
private TypeDescriptor[] |
parameterTypes
Types of the parameters. |
static short |
PS_DERBY_JDBC_RESULT_SET
PARAMETER STYLE DERBY_JDBC_RESULT_SET |
static short |
PS_JAVA
PARAMETER STYLE JAVA |
static short |
READS_SQL_DATA
|
private TypeDescriptor |
returnType
Return type for functions. |
private java.lang.String |
specificName
SQL Specific name (future) |
private static short |
SQL_ALLOWED_MASK
Masks for the sqlOptions field |
private static java.lang.String[] |
SQL_CONTROL
|
private short |
sqlOptions
This field contains several pieces of information: bits 0-3 sqlAllowed = MODIFIES_SQL_DATA, READS_SQL_DATA,CONTAINS_SQL, or NO_SQL bit 4 on if function is DETERMINISTIC, off otherwise |
Constructor Summary | |
---|---|
RoutineAliasInfo()
|
|
RoutineAliasInfo(java.lang.String methodName,
int parameterCount,
java.lang.String[] parameterNames,
TypeDescriptor[] parameterTypes,
int[] parameterModes,
int dynamicResultSets,
short parameterStyle,
short sqlAllowed,
boolean isDeterministic)
Create a RoutineAliasInfo for an internal PROCEDURE. |
|
RoutineAliasInfo(java.lang.String methodName,
int parameterCount,
java.lang.String[] parameterNames,
TypeDescriptor[] parameterTypes,
int[] parameterModes,
int dynamicResultSets,
short parameterStyle,
short sqlAllowed,
boolean isDeterministic,
boolean calledOnNullInput,
TypeDescriptor returnType)
Create a RoutineAliasInfo for a PROCEDURE or FUNCTION |
Method Summary | |
---|---|
boolean |
calledOnNullInput()
|
int |
getMaxDynamicResultSets()
|
int |
getParameterCount()
|
int[] |
getParameterModes()
|
java.lang.String[] |
getParameterNames()
Returns an array containing the names of the parameters. |
short |
getParameterStyle()
|
TypeDescriptor[] |
getParameterTypes()
Types of the parameters. |
TypeDescriptor |
getReturnType()
|
short |
getSQLAllowed()
|
private static TypeDescriptor |
getStoredType(java.lang.Object onDiskType)
Old releases (10.3 and before) wrote out the runtime DataTypeDescriptor for routine parameter and return types. 10.4 onwards (DERBY-2775) always writes out the catalog type TypeDescriptor. |
int |
getTypeFormatId()
Get the formatID which corresponds to this class. |
boolean |
isDeterministic()
|
boolean |
isTableFunction()
Return true if this alias is a Table Function. |
static java.lang.String |
parameterMode(int parameterMode)
|
void |
readExternal(java.io.ObjectInput in)
Read this object from a stream of stored objects. |
void |
setCollationTypeForAllStringTypes(int collationType)
Set the collation type of all string types declared for use in this routine to the given collation type. |
java.lang.String |
toString()
Get this alias info as a string. |
void |
writeExternal(java.io.ObjectOutput out)
Write this object to a stream of stored objects. |
Methods inherited from class org.apache.derby.catalog.types.MethodAliasInfo |
---|
getMethodName |
Methods inherited from class java.lang.Object |
---|
clone, equals, finalize, getClass, hashCode, notify, notifyAll, wait, wait, wait |
Field Detail |
---|
private static final java.lang.String[] SQL_CONTROL
public static final short MODIFIES_SQL_DATA
public static final short READS_SQL_DATA
public static final short CONTAINS_SQL
public static final short NO_SQL
public static final short PS_JAVA
public static final short PS_DERBY_JDBC_RESULT_SET
private static final short SQL_ALLOWED_MASK
private static final short DETERMINISTIC_MASK
private int parameterCount
private TypeDescriptor[] parameterTypes
private java.lang.String[] parameterNames
private int[] parameterModes
private int dynamicResultSets
private TypeDescriptor returnType
private short parameterStyle
private short sqlOptions
private java.lang.String specificName
private boolean calledOnNullInput
private transient char aliasType
Constructor Detail |
---|
public RoutineAliasInfo()
public RoutineAliasInfo(java.lang.String methodName, int parameterCount, java.lang.String[] parameterNames, TypeDescriptor[] parameterTypes, int[] parameterModes, int dynamicResultSets, short parameterStyle, short sqlAllowed, boolean isDeterministic)
public RoutineAliasInfo(java.lang.String methodName, int parameterCount, java.lang.String[] parameterNames, TypeDescriptor[] parameterTypes, int[] parameterModes, int dynamicResultSets, short parameterStyle, short sqlAllowed, boolean isDeterministic, boolean calledOnNullInput, TypeDescriptor returnType)
Method Detail |
---|
public int getParameterCount()
public TypeDescriptor[] getParameterTypes()
public int[] getParameterModes()
public java.lang.String[] getParameterNames()
public int getMaxDynamicResultSets()
public short getParameterStyle()
public short getSQLAllowed()
public boolean isDeterministic()
public boolean calledOnNullInput()
public TypeDescriptor getReturnType()
public boolean isTableFunction()
AliasInfo
isTableFunction
in interface AliasInfo
isTableFunction
in class MethodAliasInfo
public void readExternal(java.io.ObjectInput in) throws java.io.IOException, java.lang.ClassNotFoundException
readExternal
in interface java.io.Externalizable
readExternal
in class MethodAliasInfo
in
- read this.
java.io.IOException
- thrown on error
java.lang.ClassNotFoundException
- thrown on errorprivate static TypeDescriptor getStoredType(java.lang.Object onDiskType)
onDiskType
- The object read that represents the type.
public void writeExternal(java.io.ObjectOutput out) throws java.io.IOException
writeExternal
in interface java.io.Externalizable
writeExternal
in class MethodAliasInfo
out
- write bytes here.
java.io.IOException
- thrown on errorpublic int getTypeFormatId()
getTypeFormatId
in interface TypedFormat
getTypeFormatId
in class MethodAliasInfo
public java.lang.String toString()
toString
in class MethodAliasInfo
Object.toString()
public static java.lang.String parameterMode(int parameterMode)
public void setCollationTypeForAllStringTypes(int collationType)
collationType
-
|
Built on Thu 2012-03-29 21:53:33+0000, from revision ??? | ||||||||
PREV CLASS NEXT CLASS | FRAMES NO FRAMES | ||||||||
SUMMARY: NESTED | FIELD | CONSTR | METHOD | DETAIL: FIELD | CONSTR | METHOD |