org.brains2b.data.sql

Class SqlCondition

java.lang.Object

org.brains2b.data.Condition

org.brains2b.data.sql.SqlCondition

All Implemented Interfaces:

java.lang.Cloneable

Direct Known Subclasses:

OracleCondition

public class SqlCondition
extends Condition
implements java.lang.Cloneable

SqlCondition is a specific implementation of Condition for SQL databases.

Version:

0.24.1 [15-03-2008]

Author:

dennis@brains2b.nl

See Also:

Condition

Field Summary

Fields inherited from class org.brains2b.data.Condition

m_filter, m_orderBy

Constructor Summary

Constructors

Constructor and Description
SqlCondition() Default Constructor
SqlCondition(java.lang.String orderBy) Constructor for SqlCondition
SqlCondition(java.lang.String field, java.lang.Object value) Constructor for SqlCondition
SqlCondition(java.lang.String field, java.lang.Object value, java.lang.String orderBy) Constructor for SqlCondition

Method Summary

Modifier and Type	Method and Description
void	addCondition(java.lang.String field, java.lang.Object value) Implementation of addCondition which checks for null values and makes them absolute so the condition will have a condition FIELD IS NULL in the query.
void	addOrderBy(java.lang.String field, boolean descending) adds an Order By statement with the option to sort it descending
void	addParameter(int idx, int i) adds a integer value for the given placeholder position in the prepared statement.
void	addParameter(int idx, java.lang.Object o) adds a value for the given placeholder position in the prepared statement.
java.lang.Object	clone()
boolean	equals(java.lang.Object o)
int	getLastParameter()
java.util.ArrayList	getParameters() get a List of the parameter values which were added.
java.lang.String	getPreparedQuery() get the SQL WHERE clause
java.sql.PreparedStatement	getPreparedStatement(java.sql.Connection con, java.lang.String select) returns a prepared statement build from the prepared query set, the parameters added, the conditions set and the order by supplied.
java.sql.PreparedStatement	getScrollabeStatement(java.sql.Connection con, java.lang.String select)
int	hashCode()
void	setPreparedQuery(java.lang.String preparedQuery) set the SQL WHERE clause for this condition.
void	setRecordLimit(int records)

Methods inherited from class org.brains2b.data.Condition

addCondition, addCondition, addOrderBy, clearOrderBy, getConditions, getFilter, getFilterByKey, getOrderBy, removeCondition, removeFilter, setFilter

Methods inherited from class java.lang.Object

finalize, getClass, notify, notifyAll, toString, wait, wait, wait

Constructor Detail

SqlCondition

public SqlCondition()

Default Constructor

SqlCondition

public SqlCondition(java.lang.String orderBy)

Constructor for SqlCondition

SqlCondition

public SqlCondition(java.lang.String field,
                    java.lang.Object value)

Constructor for SqlCondition

SqlCondition

public SqlCondition(java.lang.String field,
                    java.lang.Object value,
                    java.lang.String orderBy)

Constructor for SqlCondition

Method Detail

getPreparedStatement

public java.sql.PreparedStatement getPreparedStatement(java.sql.Connection con,
                                                       java.lang.String select)
                                                throws java.sql.SQLException

returns a prepared statement build from the prepared query set, the parameters added, the conditions set and the order by supplied.

If a prepared query has placeholders, the addParameters must be called for every placeholder supplied.

Parameters:

con - Connection, the connection for which to prepare the query

select - String, the select containing the fields to retrieve and the table

This should be a valid ANSI-SQL `SELECT` statement without any conditions.

Returns:

PreparedStatement, the PreparedStatement created for execution

Throws:

java.sql.SQLException - throws the Exception if generated by the prepareStatement command in java.sql.Connection()

See Also:

Connection, PreparedStatement

getScrollabeStatement

public java.sql.PreparedStatement getScrollabeStatement(java.sql.Connection con,
                                                        java.lang.String select)
                                                 throws java.sql.SQLException

Throws:

java.sql.SQLException

getParameters

public java.util.ArrayList getParameters()
                                  throws java.sql.SQLException

get a List of the parameter values which were added.

The index of the list -1 corresponds to the index of the parameter added

Returns:

ArrayList, a List of Objects containing the value for the parameter

Throws:

java.sql.SQLException

See Also:

addParameter(int, int), addParameter(int, Object)

setPreparedQuery

public void setPreparedQuery(java.lang.String preparedQuery)

set the SQL WHERE clause for this condition. Could be used in conjunction with placeholder character ? to later set parameters to.

A prepared query is a query containing only the query for a table, with or without the "WHERE" keyword.

Parameters:

preparedQuery - The preparedQuery to set

getPreparedQuery

public java.lang.String getPreparedQuery()

get the SQL WHERE clause

Returns:

String, the query String generated from supplied condtions and prepared queries.

addParameter

public void addParameter(int idx,
                         java.lang.Object o)

adds a value for the given placeholder position in the prepared statement.

Parameters:

idx - int, the placeholder position

o - Object, the value to set in the prepared statement.

addParameter

public void addParameter(int idx,
                         int i)

adds a integer value for the given placeholder position in the prepared statement.

Parameters:

idx - int, the placeholder position

i - int, The value to set in the prepared statement

addCondition

public void addCondition(java.lang.String field,
                         java.lang.Object value)

Implementation of addCondition which checks for null values and makes them absolute so the condition will have a condition FIELD IS NULL in the query.

The normal addCondition(String, Object) does not do this by default and implementations can differ from data storage to data storage

converts java.util.Date to java.sql.Timestamp which is appropriate for Oracle

Overrides:

addCondition in class Condition

Parameters:

field - String, the identifier

value - Object, the value

See Also:

addCondition(String, Object)

addOrderBy

public void addOrderBy(java.lang.String field,
                       boolean descending)

adds an Order By statement with the option to sort it descending

Parameters:

field - String, the field name as it occurs in the table

descending - boolean, true if you want to sort descending.

Since:

DataC 0.23

equals

public boolean equals(java.lang.Object o)

Overrides:

equals in class Condition

See Also:

Object.equals(Object), Object.hashCode()

hashCode

public int hashCode()

Overrides:

hashCode in class Condition

clone

public java.lang.Object clone()

Overrides:

clone in class java.lang.Object

getLastParameter

public int getLastParameter()

setRecordLimit

public void setRecordLimit(int records)