Overview  Package   Class  Use  Deprecated  Index
Home >> All >> org >> apache >> derby >> catalog >> [ types overview ]	PREV CLASS  NEXT CLASS
SUMMARY:  JAVADOC |  SOURCE |  DOWNLOAD | NESTED | FIELD | CONSTR | METHOD	DETAIL: FIELD | CONSTR | METHOD

---

org.apache.derby.catalog.types
Class RoutineAliasInfo  

java.lang.Object
  org.apache.derby.catalog.types.MethodAliasInfo
      org.apache.derby.catalog.types.RoutineAliasInfo

All Implemented Interfaces:

org.apache.derby.catalog.AliasInfo, java.io.Externalizable, org.apache.derby.iapi.services.io.Formatable, java.io.Serializable, org.apache.derby.iapi.services.io.TypedFormat

---

public class RoutineAliasInfo

extends MethodAliasInfo

Describe a r (procedure or function) alias.

---

Field Summary
private  char	aliasType
private  boolean	calledOnNullInput           True if the routine is called on null input.
static short	CONTAINS_SQL
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
private  short	parameterStyle           Parameter style - always PS_JAVA at the moment.
private  org.apache.derby.catalog.TypeDescriptor[]	parameterTypes
static short	PS_JAVA           PARAMETER STYLE JAVA
static short	READS_SQL_DATA
private  org.apache.derby.catalog.TypeDescriptor	returnType           Return type for functions.
private  java.lang.String	specificName           SQL Specific name (future)
private static java.lang.String[]	SQL_CONTROL
private  short	sqlAllowed           What SQL is allowed by this procedure.

 

Fields inherited from class org.apache.derby.catalog.types.MethodAliasInfo

 

Fields inherited from interface org.apache.derby.catalog.AliasInfo

ALIAS_NAME_SPACE_FUNCTION_AS_CHAR, ALIAS_NAME_SPACE_FUNCTION_AS_STRING, ALIAS_NAME_SPACE_PROCEDURE_AS_CHAR, ALIAS_NAME_SPACE_PROCEDURE_AS_STRING, ALIAS_NAME_SPACE_SYNONYM_AS_CHAR, ALIAS_NAME_SPACE_SYNONYM_AS_STRING, ALIAS_TYPE_FUNCTION_AS_CHAR, ALIAS_TYPE_FUNCTION_AS_STRING, ALIAS_TYPE_PROCEDURE_AS_CHAR, ALIAS_TYPE_PROCEDURE_AS_STRING, ALIAS_TYPE_SYNONYM_AS_CHAR, ALIAS_TYPE_SYNONYM_AS_STRING

 

Constructor Summary

RoutineAliasInfo()

RoutineAliasInfo(java.lang.String methodName, int parameterCount, java.lang.String[] parameterNames, org.apache.derby.catalog.TypeDescriptor[] parameterTypes, int[] parameterModes, int dynamicResultSets, short parameterStyle, short sqlAllowed)           Create a RoutineAliasInfo for an internal PROCEDURE.

RoutineAliasInfo(java.lang.String methodName, int parameterCount, java.lang.String[] parameterNames, org.apache.derby.catalog.TypeDescriptor[] parameterTypes, int[] parameterModes, int dynamicResultSets, short parameterStyle, short sqlAllowed, boolean calledOnNullInput, org.apache.derby.catalog.TypeDescriptor returnType)           Create a RoutineAliasInfo for a PROCEDURE or FUNCTION

 

Method Summary
boolean	calledOnNullInput()
int	getMaxDynamicResultSets()
int	getParameterCount()
int[]	getParameterModes()
java.lang.String[]	getParameterNames()
short	getParameterStyle()
org.apache.derby.catalog.TypeDescriptor[]	getParameterTypes()
org.apache.derby.catalog.TypeDescriptor	getReturnType()
short	getSQLAllowed()
int	getTypeFormatId()           Get the formatID which corresponds to this class.
static java.lang.String	parameterMode(int parameterMode)
void	readExternal(java.io.ObjectInput in)           Read this object from a stream of stored objects.
private  void	setAliasType()           Set the type of this alias based on whether or not the returnType is null.
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, getTargetClassName, getTargetMethodName

 

Methods inherited from class java.lang.Object

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

 

Field Detail

SQL_CONTROL

private static final java.lang.String[] SQL_CONTROL

---

MODIFIES_SQL_DATA

public static final short MODIFIES_SQL_DATA

See Also:

Constant Field Values

---

READS_SQL_DATA

public static final short READS_SQL_DATA

See Also:

Constant Field Values

---

CONTAINS_SQL

public static final short CONTAINS_SQL

See Also:

Constant Field Values

---

NO_SQL

public static final short NO_SQL

See Also:

Constant Field Values

---

PS_JAVA

public static final short PS_JAVA

PARAMETER STYLE JAVA

See Also:

Constant Field Values

---

parameterCount

private int parameterCount

---

parameterTypes

private org.apache.derby.catalog.TypeDescriptor[] parameterTypes

---

parameterNames

private java.lang.String[] parameterNames

---

parameterModes

private int[] parameterModes

IN, OUT, INOUT

---

dynamicResultSets

private int dynamicResultSets

---

returnType

private org.apache.derby.catalog.TypeDescriptor returnType

Return type for functions. Null for procedures.

---

parameterStyle

private short parameterStyle

Parameter style - always PS_JAVA at the moment.

---

sqlAllowed

private short sqlAllowed

What SQL is allowed by this procedure.

---

specificName

private java.lang.String specificName

SQL Specific name (future)

---

calledOnNullInput

private boolean calledOnNullInput

True if the routine is called on null input. (always true for procedures).

---

aliasType

private transient char aliasType

Constructor Detail

RoutineAliasInfo

public RoutineAliasInfo()

---

RoutineAliasInfo

public RoutineAliasInfo(java.lang.String methodName,
                        int parameterCount,
                        java.lang.String[] parameterNames,
                        org.apache.derby.catalog.TypeDescriptor[] parameterTypes,
                        int[] parameterModes,
                        int dynamicResultSets,
                        short parameterStyle,
                        short sqlAllowed)

Create a RoutineAliasInfo for an internal PROCEDURE.

---

RoutineAliasInfo

public RoutineAliasInfo(java.lang.String methodName,
                        int parameterCount,
                        java.lang.String[] parameterNames,
                        org.apache.derby.catalog.TypeDescriptor[] parameterTypes,
                        int[] parameterModes,
                        int dynamicResultSets,
                        short parameterStyle,
                        short sqlAllowed,
                        boolean calledOnNullInput,
                        org.apache.derby.catalog.TypeDescriptor returnType)

Create a RoutineAliasInfo for a PROCEDURE or FUNCTION

Method Detail

getParameterCount

public int getParameterCount()

---

getParameterTypes

public org.apache.derby.catalog.TypeDescriptor[] getParameterTypes()

---

getParameterModes

public int[] getParameterModes()

---

getParameterNames

public java.lang.String[] getParameterNames()

---

getMaxDynamicResultSets

public int getMaxDynamicResultSets()

---

getParameterStyle

public short getParameterStyle()

---

getSQLAllowed

public short getSQLAllowed()

---

calledOnNullInput

public boolean calledOnNullInput()

---

getReturnType

public org.apache.derby.catalog.TypeDescriptor getReturnType()

---

readExternal

public void readExternal(java.io.ObjectInput in)
                  throws java.io.IOException,
                         java.lang.ClassNotFoundException

Read this object from a stream of stored objects.

Specified by:

readExternal in interface java.io.Externalizable

Overrides:

readExternal in class MethodAliasInfo

---

writeExternal

public void writeExternal(java.io.ObjectOutput out)
                   throws java.io.IOException

Write this object to a stream of stored objects.

Specified by:

writeExternal in interface java.io.Externalizable

Overrides:

writeExternal in class MethodAliasInfo

---

getTypeFormatId

public int getTypeFormatId()

Get the formatID which corresponds to this class.

Specified by:

getTypeFormatId in interface org.apache.derby.iapi.services.io.TypedFormat

Overrides:

getTypeFormatId in class MethodAliasInfo

---

toString

public java.lang.String toString()

Get this alias info as a string. NOTE: The "ALIASINFO" column in the SYSALIASES table will return the result of this method on a ResultSet.getString() call. That said, since the dblook utility uses ResultSet.getString() to retrieve ALIASINFO and to generate the DDL, THIS METHOD MUST RETURN A STRING THAT IS SYNTACTICALLY VALID, or else the DDL generated by dblook will be incorrect.

Overrides:

toString in class MethodAliasInfo

---

parameterMode

public static java.lang.String parameterMode(int parameterMode)

---

setAliasType

private void setAliasType()

Set the type of this alias based on whether or not the returnType is null.

---

Overview  Package   Class  Use  Deprecated  Index
Home >> All >> org >> apache >> derby >> catalog >> [ types overview ]	PREV CLASS  NEXT CLASS
SUMMARY:  JAVADOC |  SOURCE |  DOWNLOAD | NESTED | FIELD | CONSTR | METHOD	DETAIL: FIELD | CONSTR | METHOD

---