com.scooterframework.orm.sqldataexpress.object
Class Parameter

java.lang.Object
  extended by com.scooterframework.orm.sqldataexpress.object.Parameter
Direct Known Subclasses:
JdbcStatementParameter, OracleParameter

public class Parameter
extends java.lang.Object

Parameter class.


Field Summary
protected  boolean bIsCursorType
           
protected  java.lang.String catalog
           
static java.lang.String FUNCTION_RETURN
           
protected  int index
           
protected  java.lang.String javaClassName
           
protected  java.lang.String mode
           
static java.lang.String MODE_IN
           
static java.lang.String MODE_INOUT
           
static java.lang.String MODE_OUT
           
static java.lang.String MODE_RETURN
           
static java.lang.String MODE_UNKONWN
           
protected  java.lang.String name
           
protected  java.lang.String schema
           
protected  int sqlDataType
           
protected  java.lang.String sqlDataTypeName
           
static java.lang.String UNDEFINED
           
static int UNKNOWN_SQL_DATA_TYPE
           
protected  java.lang.String vendor
           
 
Constructor Summary
Parameter()
           
Parameter(int index, java.lang.String name, java.lang.String mode, int sqlDataType, java.lang.String sqlDataTypeName)
           
 
Method Summary
 java.lang.String getCatalog()
          returns catalog
 int getIndex()
          returns index
 java.lang.String getJavaClassName()
          returns javaClassName
 java.lang.String getJavaType(int sqlDataType)
          Retrieves the the Java class type of the type of SQL type passed in.
 java.lang.String getMode()
          returns mode
 java.lang.String getName()
          returns name
 java.lang.String getSchema()
          returns schema
 int getSqlDataType()
          returns sqlDataType
 java.lang.String getSqlDataTypeName()
          returns sqlDataTypeName
 java.lang.String getVendor()
          returns vendor
 boolean isCursorType()
          checks if is cursor type
 void setCatalog(java.lang.String catalog)
          sets catalog
 void setIndex(int index)
          sets index
 void setJavaClassName(java.lang.String javaClassName)
          sets javaClassName
 void setMode(java.lang.String mode)
          sets mode
 void setName(java.lang.String name)
          sets name
 void setSchema(java.lang.String schema)
          sets schema
 void setSqlDataType(int sqlDataType)
          sets sqlDataType
 void setSqlDataTypeName(java.lang.String sqlDataTypeName)
          sets sqlDataTypeName
 void setVendor(java.lang.String vendor)
          sets vendor
 java.lang.String toString()
          Returns a string representation of the object.
 
Methods inherited from class java.lang.Object
clone, equals, finalize, getClass, hashCode, notify, notifyAll, wait, wait, wait
 

Field Detail

MODE_UNKONWN

public static final java.lang.String MODE_UNKONWN
See Also:
Constant Field Values

MODE_IN

public static final java.lang.String MODE_IN
See Also:
Constant Field Values

MODE_INOUT

public static final java.lang.String MODE_INOUT
See Also:
Constant Field Values

MODE_OUT

public static final java.lang.String MODE_OUT
See Also:
Constant Field Values

MODE_RETURN

public static final java.lang.String MODE_RETURN
See Also:
Constant Field Values

UNKNOWN_SQL_DATA_TYPE

public static final int UNKNOWN_SQL_DATA_TYPE
See Also:
Constant Field Values

UNDEFINED

public static final java.lang.String UNDEFINED
See Also:
Constant Field Values

FUNCTION_RETURN

public static final java.lang.String FUNCTION_RETURN
See Also:
Constant Field Values

index

protected int index

catalog

protected java.lang.String catalog

schema

protected java.lang.String schema

name

protected java.lang.String name

mode

protected java.lang.String mode

sqlDataType

protected int sqlDataType

sqlDataTypeName

protected java.lang.String sqlDataTypeName

javaClassName

protected java.lang.String javaClassName

bIsCursorType

protected boolean bIsCursorType

vendor

protected java.lang.String vendor
Constructor Detail

Parameter

public Parameter()

Parameter

public Parameter(int index,
                 java.lang.String name,
                 java.lang.String mode,
                 int sqlDataType,
                 java.lang.String sqlDataTypeName)
Method Detail

getIndex

public int getIndex()
returns index


setIndex

public void setIndex(int index)
sets index


getName

public java.lang.String getName()
returns name


setName

public void setName(java.lang.String name)
sets name


getCatalog

public java.lang.String getCatalog()
returns catalog


setCatalog

public void setCatalog(java.lang.String catalog)
sets catalog


getSchema

public java.lang.String getSchema()
returns schema


setSchema

public void setSchema(java.lang.String schema)
sets schema


getMode

public java.lang.String getMode()
returns mode


setMode

public void setMode(java.lang.String mode)
sets mode


getSqlDataType

public int getSqlDataType()
returns sqlDataType


setSqlDataType

public void setSqlDataType(int sqlDataType)
sets sqlDataType


getSqlDataTypeName

public java.lang.String getSqlDataTypeName()
returns sqlDataTypeName


setSqlDataTypeName

public void setSqlDataTypeName(java.lang.String sqlDataTypeName)
sets sqlDataTypeName


isCursorType

public boolean isCursorType()
checks if is cursor type


getJavaClassName

public java.lang.String getJavaClassName()
returns javaClassName


setJavaClassName

public void setJavaClassName(java.lang.String javaClassName)
sets javaClassName


getJavaType

public java.lang.String getJavaType(int sqlDataType)
Retrieves the the Java class type of the type of SQL type passed in.

Parameters:
sqlDataType - sql data type
Returns:
The Java class type name.

getVendor

public java.lang.String getVendor()
returns vendor


setVendor

public void setVendor(java.lang.String vendor)
sets vendor


toString

public java.lang.String toString()
Returns a string representation of the object.

Overrides:
toString in class java.lang.Object
Returns:
String