Class StoredProcedureParameter
java.lang.Object
com.denodo.vdb.engine.storedprocedure.StoredProcedureParameter
- All Implemented Interfaces:
com.denodo.vdb.catalog.view.EquivalenceVerifiable
public class StoredProcedureParameter
extends Object
implements com.denodo.vdb.catalog.view.EquivalenceVerifiable
This class represents a parameter of a stored procedure.
-
Field Summary
FieldsModifier and TypeFieldDescriptionstatic final int
Input parameter.static final int
Input/output parameter.static final int
Output parameter. -
Constructor Summary
ConstructorsConstructorDescriptionStoredProcedureParameter
(String name, int type, int direction) Creates a new StoredProcedureParameter.StoredProcedureParameter
(String name, int type, int direction, boolean nullable) Creates a new StoredProcedureParameter.StoredProcedureParameter
(String name, int type, int direction, boolean nullable, StoredProcedureParameter[] columns) Creates a new StoredProcedureParameter.StoredProcedureParameter
(String name, int type, int direction, StoredProcedureParameter[] columns) Creates a new StoredProcedureParameter. -
Method Summary
Modifier and TypeMethodDescriptionboolean
equivalent
(com.denodo.vdb.catalog.view.EquivalenceVerifiable obj) Obtains the columns of the parameter.int
Obtains the direction of the parameter, indicating if the value must be provided or it is generated by the procedure.getName()
Obtains the name of the parameter.int
getType()
Obtains the type of the parameter.boolean
Determines if the parameter is nullable.toString()
-
Field Details
-
DIRECTION_IN
public static final int DIRECTION_INInput parameter. The parameter must be provided to the procedure.- See Also:
-
DIRECTION_OUT
public static final int DIRECTION_OUTOutput parameter. The value is generated by the stored procedure.- See Also:
-
DIRECTION_INOUT
public static final int DIRECTION_INOUTInput/output parameter. The parameter value must be provided to the procedure, which also can modify it.- See Also:
-
-
Constructor Details
-
StoredProcedureParameter
Creates a new StoredProcedureParameter.- Parameters:
name
- the name of the parameter.type
- the type of the parameter, fromTypes
.direction
- the direction of the parameter, indicating if the value must be provided or it is generated by the procedure. Should be one of these:DIRECTION_IN
,DIRECTION_OUT
orDIRECTION_INOUT
-
StoredProcedureParameter
Creates a new StoredProcedureParameter.- Parameters:
name
- the name of the parameter.type
- the type of the parameter, fromTypes
.direction
- the direction of the parameter, indicating if the value must be provided or it is generated by the procedure. Should be one of these:DIRECTION_IN
,DIRECTION_OUT
orDIRECTION_INOUT
nullable
- indicates if a NULL value can be specified for this parameter
-
StoredProcedureParameter
public StoredProcedureParameter(String name, int type, int direction, StoredProcedureParameter[] columns) Creates a new StoredProcedureParameter.- Parameters:
name
- the name of the parameter.type
- the type of the parameter, fromTypes
.direction
- the direction of the parameter, indicating if the value must be provided or it is generated by the procedure. Should be one of these:DIRECTION_IN
,DIRECTION_OUT
orDIRECTION_INOUT
columns
- if the parameter is register or array, specifies its subfields.
-
StoredProcedureParameter
public StoredProcedureParameter(String name, int type, int direction, boolean nullable, StoredProcedureParameter[] columns) Creates a new StoredProcedureParameter.- Parameters:
name
- the name of the parameter.type
- the type of the parameter, fromTypes
.direction
- the direction of the parameter, indicating if the value must be provided or it is generated by the procedure. Should be one of these:DIRECTION_IN
,DIRECTION_OUT
orDIRECTION_INOUT
nullable
- indicates if a NULL value can be specified for this parametercolumns
- if the parameter is register or array, specifies its subfields.
-
-
Method Details
-
getColumns
Obtains the columns of the parameter.- Returns:
- the columns of the parameter.
-
getDirection
public int getDirection()Obtains the direction of the parameter, indicating if the value must be provided or it is generated by the procedure.- Returns:
- one of these values:
DIRECTION_IN
,DIRECTION_OUT
orDIRECTION_INOUT
-
getName
Obtains the name of the parameter.- Returns:
- the name of the parameter.
-
getType
public int getType()Obtains the type of the parameter.- Returns:
- a value from
Types
-
isNullable
public boolean isNullable()Determines if the parameter is nullable.- Returns:
true
if the parameter is nullable,false
otherwise.- Since:
- 4.6
-
toString
-
equivalent
public boolean equivalent(com.denodo.vdb.catalog.view.EquivalenceVerifiable obj) - Specified by:
equivalent
in interfacecom.denodo.vdb.catalog.view.EquivalenceVerifiable
-