fr.paris.lutece.util.sql

Class DAOUtil

java.lang.Object

fr.paris.lutece.util.sql.DAOUtil

public class DAOUtil
extends Object

Prepared statement util class

Since:

version 1.3

Field Summary

Fields

Modifier and Type	Field and Description
static String	MSG_EXCEPTION_SELECT_ERROR

Constructor Summary

Constructors

Constructor and Description
DAOUtil(String sql) Creates a new DAOUtil object.
DAOUtil(String strSQL, Plugin plugin) Creates a new DAOUtil object.

Method Summary

Methods

Modifier and Type	Method and Description
void	executeQuery() Executes a query
void	executeUpdate() Executes the update request and throws an error if the result is not 1
protected void	finalize()
boolean	first() Deprecated. Use next() instead
void	free() Free connection
InputStream	getBinaryStream(int nIndex) Gets a binary stream from a resultSet
Blob	getBlob(int nIndex) Gets a blob from a resultset
Blob	getBlob(String strColumnName) Gets a blob from a resultset
boolean	getBoolean(int nIndex) Gets the value of the designated column in the current row of this ResultSet object as a Boolean
boolean	getBoolean(String strColumnName) Gets the value of the designated column in the current row of this ResultSet object as a Boolean
byte[]	getBytes(int nIndex) Gets a byte array from a resultset
byte[]	getBytes(String strColumnName) Gets a byte array from a resultset
Date	getDate(int nIndex) Gets the value of the designated column in the current row of this ResultSet object as a java.sql.Date object in the Java programming language.
Date	getDate(String strColumnName) Gets the value of the designated column in the current row of this ResultSet object as a java.sql.Date object in the Java programming language.
double	getDouble(int nIndex) Gets the value of the designated column in the current row of this ResultSet object as a double
double	getDouble(String strColumnName) Gets the value of the designated column in the current row of this ResultSet object as a double
int	getInt(int nIndex) Gets the value of the designated column in the current row of this ResultSet object as a int
int	getInt(String strColumnName) Gets the value of the designated column in the current row of this ResultSet object as a int
long	getLong(int nIndex) Gets the long value
long	getLong(String strColumnName) Gets the long value
Object	getObject(int nIndex) Gets the value of the designated column in the current row of this ResultSet object as a Object
Object	getObject(String strColumnName) Gets the value of the designated column in the current row of this ResultSet object as an Object
ResultSet	getResultSet() Get the ResultSet
String	getString(int nIndex) Gets the value of the designated column in the current row of this ResultSet object as a string
String	getString(String strColumnName) Gets the value of the designated column in the current row of this ResultSet object as a string
Time	getTime(int nIndex) Gets the value of the designated column in the current row of this ResultSet object as a java.sql.Time object in the Java programming language.
Time	getTime(String strColumnName) Gets the value of the designated column in the current row of this ResultSet object as a java.sql.Time object in the Java programming language.
Timestamp	getTimestamp(int nIndex) Gets the value of the designated column in the current row of this ResultSet object as a timestamp
Timestamp	getTimestamp(String strColumnName) Gets the value of the designated column in the current row of this ResultSet object as a Timestamp
boolean	isLast() Indicates whether the cursor is on the last row of this ResultSet object.
boolean	next() Moves the cursor down one row from its current position in the ResultSet.
void	setBinaryStream(int nIndex, InputStream iStream, int nBlength) Fills the prepared statement with a binary value stream
void	setBoolean(int nIndex, boolean bValue) Fills the prepared statement with a Boolean value
void	setBytes(int nIndex, byte[] tbValue) Fills the prepared statement with a byte array value
void	setDate(int nIndex, Date date) Fills the prepared statement with a date value
void	setDouble(int nIndex, double dValue) Fills the prepared statement with a double value
void	setDoubleNull(int nIndex) Sets null value for a "double" column
void	setInt(int nIndex, int nValue) Fills the prepared statement with a int value
void	setIntNull(int nIndex) Fills the prepared statement with a int null value
void	setLong(int nIndex, long lValue) Sets a long value
void	setLongNull(int nIndex) Sets null value for a "long" column
void	setString(int nIndex, String strValue) Fills the prepared statement with a string value
void	setTime(int nIndex, Time time) Fills the prepared statement with a time value
void	setTimestamp(int nIndex, Timestamp ts) Fills the prepared statement with a timestamp value

Methods inherited from class java.lang.Object

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

Field Detail

MSG_EXCEPTION_SELECT_ERROR

public static final String MSG_EXCEPTION_SELECT_ERROR

See Also:

Constant Field Values

Constructor Detail

DAOUtil

public DAOUtil(String sql)

Creates a new DAOUtil object.

Parameters:

sql - Sql Query for prepared Statement

DAOUtil

public DAOUtil(String strSQL,
       Plugin plugin)

Creates a new DAOUtil object.

Parameters:

strSQL - sql query for prepared Statement

plugin - The plugin using this database access

Method Detail

executeUpdate

public void executeUpdate()

Executes the update request and throws an error if the result is not 1

executeQuery

public void executeQuery()

Executes a query

free

public final void free()

Free connection

first

@Deprecated
public boolean first()

Deprecated. Use next() instead

Moves the cursor to the first row in this ResultSet object.

Returns:

true if the cursor is on a valid row; false if there are no rows in the result set

isLast

public boolean isLast()

Indicates whether the cursor is on the last row of this ResultSet object.

Returns:

true if the cursor is on the last row; false otherwise

setDate

public void setDate(int nIndex,
           Date date)

Fills the prepared statement with a date value

Parameters:

nIndex - parameter index

date - date value

setTime

public void setTime(int nIndex,
           Time time)

Fills the prepared statement with a time value

Parameters:

nIndex - parameter index

time - time value

setBinaryStream

public void setBinaryStream(int nIndex,
                   InputStream iStream,
                   int nBlength)

Fills the prepared statement with a binary value stream

Parameters:

nIndex - parameter index

iStream - the java input stream which contains the binary parameter value

nBlength - the number of bytes in the stream

getBinaryStream

public InputStream getBinaryStream(int nIndex)

Gets a binary stream from a resultSet

Parameters:

nIndex - column index

Returns:

InputStream instance

getBlob

public Blob getBlob(int nIndex)

Gets a blob from a resultset

Parameters:

nIndex - column index

Returns:

Blob instance

getBlob

public Blob getBlob(String strColumnName)

Gets a blob from a resultset

Parameters:

strColumnName - column name

Returns:

Blob instance

getBytes

public byte[] getBytes(int nIndex)

Gets a byte array from a resultset

Parameters:

nIndex - column index

Returns:

byte[] instance

getBytes

public byte[] getBytes(String strColumnName)

Gets a byte array from a resultset

Parameters:

strColumnName - column name

Returns:

byte[] instance

setInt

public void setInt(int nIndex,
          int nValue)

Fills the prepared statement with a int value

Parameters:

nIndex - parameter index in the prepared statement

nValue - int value

setBoolean

public void setBoolean(int nIndex,
              boolean bValue)

Fills the prepared statement with a Boolean value

Parameters:

nIndex - parameter index in the prepared statement

bValue - Boolean value

setBytes

public void setBytes(int nIndex,
            byte[] tbValue)

Fills the prepared statement with a byte array value

Parameters:

nIndex - parameter index in the prepared statement

tbValue - byte array value

setString

public void setString(int nIndex,
             String strValue)

Fills the prepared statement with a string value

Parameters:

nIndex - parameter index in the prepared statement

strValue - string value

setTimestamp

public void setTimestamp(int nIndex,
                Timestamp ts)

Fills the prepared statement with a timestamp value

Parameters:

nIndex - parameter index in the prepared statement

ts - timestamp value

setDouble

public void setDouble(int nIndex,
             double dValue)

Fills the prepared statement with a double value

Parameters:

nIndex - parameter index in the prepared statement

dValue - The value

setDoubleNull

public void setDoubleNull(int nIndex)

Sets null value for a "double" column

Parameters:

nIndex - the index

getDate

public Date getDate(int nIndex)

Gets the value of the designated column in the current row of this ResultSet object as a java.sql.Date object in the Java programming language.

Parameters:

nIndex - the first column is 1, the second is 2, ...

Returns:

the column value; if the value is SQL NULL, the value returned is null

getDate

public Date getDate(String strColumnName)

Gets the value of the designated column in the current row of this ResultSet object as a java.sql.Date object in the Java programming language.

Parameters:

strColumnName - name of the column, ...

Returns:

the column value; if the value is SQL NULL, the value returned is null

getTime

public Time getTime(int nIndex)

Gets the value of the designated column in the current row of this ResultSet object as a java.sql.Time object in the Java programming language.

Parameters:

nIndex - the first column is 1, the second is 2, ...

Returns:

the column value; if the value is SQL NULL, the value returned is null

getTime

public Time getTime(String strColumnName)

Gets the value of the designated column in the current row of this ResultSet object as a java.sql.Time object in the Java programming language.

Parameters:

strColumnName - name of the column, ...

Returns:

the column value; if the value is SQL NULL, the value returned is null

getInt

public int getInt(int nIndex)

Gets the value of the designated column in the current row of this ResultSet object as a int

Parameters:

nIndex - the first column is 1, the second is 2, ...

Returns:

the column value; if the value is SQL NULL, the value returned is 0

getInt

public int getInt(String strColumnName)

Gets the value of the designated column in the current row of this ResultSet object as a int

Parameters:

strColumnName - column name

Returns:

the column value; if the value is SQL NULL, the value returned is 0

getBoolean

public boolean getBoolean(int nIndex)

Gets the value of the designated column in the current row of this ResultSet object as a Boolean

Parameters:

nIndex - the first column is 1, the second is 2, ...

Returns:

the column value; if the value is SQL NULL, the value returned is FALSE

getBoolean

public boolean getBoolean(String strColumnName)

Gets the value of the designated column in the current row of this ResultSet object as a Boolean

Parameters:

strColumnName - column name

Returns:

the column value; if the value is SQL NULL, the value returned is FALSE

getString

public String getString(int nIndex)

Gets the value of the designated column in the current row of this ResultSet object as a string

Parameters:

nIndex - the first column is 1, the second is 2, ...

Returns:

the column value; if the value is SQL NULL, the value returned is NULL

getString

public String getString(String strColumnName)

Gets the value of the designated column in the current row of this ResultSet object as a string

Parameters:

strColumnName - column name

Returns:

the column value; if the value is SQL NULL, the value returned is NULL

getTimestamp

public Timestamp getTimestamp(int nIndex)

Gets the value of the designated column in the current row of this ResultSet object as a timestamp

Parameters:

nIndex - the first column is 1, the second is 2, ...

Returns:

the column value; if the value is SQL NULL, the value returned is NULL

getTimestamp

public Timestamp getTimestamp(String strColumnName)

Gets the value of the designated column in the current row of this ResultSet object as a Timestamp

Parameters:

strColumnName - column name

Returns:

the column value; if the value is SQL NULL, the value returned is NULL

getDouble

public double getDouble(String strColumnName)

Gets the value of the designated column in the current row of this ResultSet object as a double

Parameters:

strColumnName - column name

Returns:

the column value; if the value is SQL NULL, the value returned is NULL

getDouble

public double getDouble(int nIndex)

Gets the value of the designated column in the current row of this ResultSet object as a double

Parameters:

nIndex - the first column is 1, the second is 2, ...

Returns:

the column value; if the value is SQL NULL, the value returned is 0

getObject

public Object getObject(int nIndex)

Gets the value of the designated column in the current row of this ResultSet object as a Object

Parameters:

nIndex - the first column is 1, the second is 2, ...

Returns:

the column value; if the value is SQL NULL, the value returned is NULL

getResultSet

public ResultSet getResultSet()

Get the ResultSet

Returns:

the resultSet

getObject

public Object getObject(String strColumnName)

Gets the value of the designated column in the current row of this ResultSet object as an Object

Parameters:

strColumnName - column name

Returns:

the column value; if the value is SQL NULL, the value returned is NULL

next

public boolean next()

Moves the cursor down one row from its current position in the ResultSet.

Returns:

true if the new current row is valid; false if there are no more rows

setIntNull

public void setIntNull(int nIndex)

Fills the prepared statement with a int null value

Parameters:

nIndex - parameter index

setLongNull

public void setLongNull(int nIndex)

Sets null value for a "long" column

Parameters:

nIndex - the index

setLong

public void setLong(int nIndex,
           long lValue)

Sets a long value

Parameters:

nIndex - the index

lValue - the value

getLong

public long getLong(int nIndex)

Gets the long value

Parameters:

nIndex - the index

Returns:

the long value

getLong

public long getLong(String strColumnName)

Gets the long value

Parameters:

strColumnName - the column name

Returns:

the long value

finalize

protected void finalize()
                 throws Throwable

Overrides:

finalize in class Object

Throws:

Throwable