us.daveread.basicquery

Class StatementParameter

java.lang.Object

us.daveread.basicquery.StatementParameter

public class StatementParameter
extends java.lang.Object

Title: Statement parameter

Description: An individual parameter for a parameterized SQL statement

Copyright: Copyright (c) 2004-2014, David Read

This program is free software; you can redistribute it and/or modify it under the terms of the GNU General Public License as published by the Free Software Foundation; either version 2 of the License, or (at your option) any later version.

This program is distributed in the hope that it will be useful, but WITHOUT ANY WARRANTY; without even the implied warranty of MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE. See the GNU General Public License for more details.

You should have received a copy of the GNU General Public License along with this program; if not, write to the Free Software Foundation, Inc., 59 Temple Place, Suite 330, Boston, MA 02111-1307 USA

Author:

David Read

Field Summary

Fields

Modifier and Type	Field and Description
private java.lang.String	dataString Data value associated with an In or In-Out parameter
private int	dataType Parameter data type
static int	IN In parameter
static int	IN_OUT In-Out parameter
static int	OUT Out parameter
private int	type Parameter type (In, Out, In-Out)

Constructor Summary

Constructors

Constructor and Description
StatementParameter(int aType, int aDataType) Create a new StatementParameter instance.
StatementParameter(int aType, int aDataType, java.lang.String aDataString) Create a new StatementParameter instance.

Method Summary

Methods

Modifier and Type	Method and Description
java.lang.String	getDataString() Retrieve the value associated with this parameter.
int	getDataType() Retrieve the java.sql.Types value for this parameter
int	getType() Retrieve the direction (In/Out) of this parameter

Methods inherited from class java.lang.Object

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

Field Detail

IN

public static final int IN

In parameter

See Also:

Constant Field Values

OUT

public static final int OUT

Out parameter

See Also:

Constant Field Values

IN_OUT

public static final int IN_OUT

In-Out parameter

See Also:

Constant Field Values

type

private int type

Parameter type (In, Out, In-Out)

dataType

private int dataType

Parameter data type

dataString

private java.lang.String dataString

Data value associated with an In or In-Out parameter

Constructor Detail

StatementParameter

public StatementParameter(int aType,
                  int aDataType)

Create a new StatementParameter instance. This constructor is typically used for OUT parameters, which have no initial value.

Parameters:

aType - The direction (In/Out) of the parameter

aDataType - The java.sql.Types value for the parameter

StatementParameter

public StatementParameter(int aType,
                  int aDataType,
                  java.lang.String aDataString)

Create a new StatementParameter instance. This constructor is typically used for IN or IN_OUT parameters, which have an initial value.

Parameters:

aType - The direction (In/Out) of the parameter

aDataType - The java.sql.Types value for the parameter

aDataString - The data supplied for this parameter

Method Detail

getType

public int getType()

Retrieve the direction (In/Out) of this parameter

Returns:

The direction of the parameter - constants in this class define the meaning

getDataType

public int getDataType()

Retrieve the java.sql.Types value for this parameter

Returns:

The SQL data type

getDataString

public java.lang.String getDataString()

Retrieve the value associated with this parameter. Only valid for In or In-Out parameters. Note that all parameter values are treated as strings. They are converted as necessary when the SQL is executed.

Returns:

The value of the parameter