org.xmlactions.db

Class DBSQL

java.lang.Object

org.xmlactions.db.DBSQL

public class DBSQL
extends java.lang.Object

Nested Class Summary

Nested Classes

Modifier and Type	Class and Description
protected static class	DBSQL.JavaToSqlType

Field Summary

Fields

Modifier and Type	Field and Description
static java.lang.String	NUM_ROWS Attribute name for the number of rows returned from a query
static java.lang.String	ROOT Name of root element for a query result

Constructor Summary

Constructors

Constructor and Description
DBSQL()

Method Summary

Modifier and Type	Method and Description
int[]	batch(java.sql.Connection dbConnection, java.lang.String[] batch) Executes a batch of commands
static java.lang.String	clobToString(java.sql.Clob clob) Converts an Oracle clob to a string.
static java.lang.String	escCharacters(java.lang.String input) This will escape all non-database friendly characters by appendiing the escape character "\" before them.
static int	insert(java.sql.Connection dbConnection, java.lang.String sql) insert to database
static int	insert(java.sql.Connection dbConnection, java.lang.String sql, java.util.List<SqlField> params) Insert to database
static int	insertAndReturnKey(java.sql.Connection dbConnection, java.lang.String sql) Insert to database using JDBC 3.0 which will return the key of the new row.
static int	insertAndReturnKey(java.sql.Connection dbConnection, java.lang.String sql, java.util.List<SqlField> params) Insert to database using JDBC 3.0 which will return the key of the new row.
static int	insertAndReturnKey(java.sql.Connection dbConnection, java.lang.String sql, java.util.List<SqlField> params, ISqlTable sqlTable) Insert to database using JDBC 3.0 which will return the key of the new row.
boolean	isIncludeIndex()
java.lang.String	query(java.sql.Connection connection, java.lang.String sql) Retrieve a query from the db.
java.lang.String	query(java.sql.ResultSet rs) Retrieve a query from the db.
XMLObject	query2XMLObject(java.sql.Connection connection, java.lang.String sql, java.lang.String rootName, java.lang.String[] elementNames, java.lang.String dateFormat, java.util.List<SqlField> params) This will get all the rows from the ResultSet and store these into an xmlObject.
XMLObject	query2XMLObject(java.sql.ResultSet rs, java.lang.String rootName, java.lang.String[] elementNames, java.lang.String dateFormat) This will get all the rows from the ResultSet and store these into an xmlObject.
static java.lang.String	queryOne(java.sql.Connection connection, java.lang.String sql, java.util.List<SqlField> params) this gets the result of a count or max etc
static java.lang.String	queryOne(java.sql.ResultSet rs) this gets the result of a count or max etc
java.lang.String	queryXML(java.sql.Connection connection, java.lang.String sql, java.lang.String rootName) Retrieve a query from the db.
java.lang.String	queryXML(java.sql.ResultSet rs, java.lang.String rootName)
java.lang.String	queryXMLLong(java.sql.ResultSet rs, java.lang.String[] elementNames, java.lang.String rootName, java.lang.String dateFormat) builds the result set as <elementName>resultset.value</elementName>
java.lang.String	queryXMLShort(java.sql.Connection connection, java.lang.String sql, java.lang.String rootName) Sends a query to the database and maps the resultset to an xml string.
java.lang.String	queryXMLShort(java.sql.Connection connection, java.lang.String sql, java.lang.String rootName, java.util.List<SqlField> params) Sends a query to the database and maps the resultset to an xml string.
java.lang.String	queryXMLShort(java.sql.ResultSet rs, java.lang.String rootName) builds the result set as <row index="x" attribute=value ...> where attribute name is the name of the table column.
java.lang.String	queryXMLShort(java.sql.ResultSet rs, java.lang.String[] elementNames, java.lang.String rootName, java.lang.String dateFormat) builds the result set as <row index="x" attribute=value ...> where attribute name is the name of the table column.
java.lang.String	queryXMLShort(java.sql.ResultSet rs, java.lang.String rootName, java.lang.String dateFormat) builds the result set as <row index="x" attribute=value ...> where attribute name is the name of the table column.
void	setIncludeIndex(boolean includeIndex)
static int	update(java.sql.Connection connection, java.lang.String sql) update to database
static int	update(java.sql.Connection dbConnection, java.lang.String sql, java.util.List<SqlField> params) Update to database.

Methods inherited from class java.lang.Object

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

Field Detail

ROOT

public static final java.lang.String ROOT

Name of root element for a query result

See Also:

Constant Field Values

NUM_ROWS

public static final java.lang.String NUM_ROWS

Attribute name for the number of rows returned from a query

See Also:

Constant Field Values

Constructor Detail

DBSQL

public DBSQL()

Method Detail

clobToString

public static java.lang.String clobToString(java.sql.Clob clob)
                                     throws DBSQLException,
                                            java.sql.SQLException

Converts an Oracle clob to a string.

Returns:

A string containing the clob data or null if an empty clob.

Throws:

DBSQLException

java.sql.SQLException

update

public static int update(java.sql.Connection connection,
                         java.lang.String sql)
                  throws DBSQLException

update to database

Parameters:

sql - is the sql update to send to the database

Throws:

DBSQLException

update

public static int update(java.sql.Connection dbConnection,
                         java.lang.String sql,
                         java.util.List<SqlField> params)
                  throws DBSQLException

Update to database.

Parameters:

sql - is the sql update query to send to the database

Returns:

number of rows updated.

Throws:

DBSQLException

insert

public static int insert(java.sql.Connection dbConnection,
                         java.lang.String sql)
                  throws DBSQLException

insert to database

Parameters:

dbConnection - an open database connection

sql - is the sql insert query to send to the database

Throws:

DBSQLException

insertAndReturnKey

public static int insertAndReturnKey(java.sql.Connection dbConnection,
                                     java.lang.String sql)
                              throws DBSQLException

Insert to database using JDBC 3.0 which will return the key of the new row.

Parameters:

sql - is the sql insert query to send to the database

Returns:

the key for the inserted row

Throws:

DBSQLException

insertAndReturnKey

public static int insertAndReturnKey(java.sql.Connection dbConnection,
                                     java.lang.String sql,
                                     java.util.List<SqlField> params)
                              throws DBSQLException

Insert to database using JDBC 3.0 which will return the key of the new row.

Parameters:

sql - is the sql insert query to send to the database

Returns:

the key for the inserted row

Throws:

DBSQLException

insertAndReturnKey

public static int insertAndReturnKey(java.sql.Connection dbConnection,
                                     java.lang.String sql,
                                     java.util.List<SqlField> params,
                                     ISqlTable sqlTable)
                              throws DBSQLException

Insert to database using JDBC 3.0 which will return the key of the new row.

Parameters:

sql - is the sql insert query to send to the database

params - - these will be used as paramaters in a PreparedStatement

sqlTable - - if not null the pk value will be used in the prepared statement constructior to ne specific about which field is the PK.

Returns:

the key for the inserted row

Throws:

DBSQLException

insert

public static int insert(java.sql.Connection dbConnection,
                         java.lang.String sql,
                         java.util.List<SqlField> params)
                  throws DBSQLException

Insert to database

Parameters:

sql - is the sql insert query to send to the database

Returns:

the result of executeUpdate

Throws:

DBSQLException

batch

public int[] batch(java.sql.Connection dbConnection,
                   java.lang.String[] batch)
            throws java.sql.SQLException

Executes a batch of commands

Parameters:

dbConnection - is the open database connection

batch - is an array of sql commands usually update and or insert

Returns:

an int array of each sql execution result

Throws:

java.sql.SQLException

query

public java.lang.String query(java.sql.Connection connection,
                              java.lang.String sql)
                       throws java.sql.SQLException

Retrieve a query from the db. The result is the column names followed by each row. All columns are separated by the '|' character.

Parameters:

connection - the db connection

sql - is the sql query to send to the database

Throws:

java.sql.SQLException

query

public java.lang.String query(java.sql.ResultSet rs)
                       throws java.sql.SQLException

Retrieve a query from the db. The result is the column names followed by each row. All columns are separated by the '|' character.

Parameters:

rs - is the resultSet from the query

Throws:

java.sql.SQLException

queryOne

public static java.lang.String queryOne(java.sql.Connection connection,
                                        java.lang.String sql,
                                        java.util.List<SqlField> params)
                                 throws DBSQLException

this gets the result of a count or max etc

Parameters:

connection - an open database connection

sql - is the query.

Returns:

the response number as a string or null

Throws:

DBSQLException

queryOne

public static java.lang.String queryOne(java.sql.ResultSet rs)
                                 throws DBSQLException,
                                        java.sql.SQLException

this gets the result of a count or max etc

Parameters:

rs - is the resultSet with the executed query.

Returns:

the response number as a string or null

Throws:

DBSQLException

java.sql.SQLException

queryXML

public java.lang.String queryXML(java.sql.Connection connection,
                                 java.lang.String sql,
                                 java.lang.String rootName)
                          throws DBSQLException

Retrieve a query from the db. The result is an XML String containing each column name followed by each row.

Parameters:

connection - an open db connection

sql - is the sql query to send to the database

Throws:

DBSQLException

queryXML

public java.lang.String queryXML(java.sql.ResultSet rs,
                                 java.lang.String rootName)
                          throws DBSQLException,
                                 java.sql.SQLException

Throws:

DBSQLException

java.sql.SQLException

queryXMLShort

public java.lang.String queryXMLShort(java.sql.Connection connection,
                                      java.lang.String sql,
                                      java.lang.String rootName)
                               throws DBSQLException

Sends a query to the database and maps the resultset to an xml string. This 'short' version is aimed at making the xml as short as it can using attributes in place of content.

Parameters:

connection - an open database connection

sql - is the database query to execute

rootName - is an optional root element name used to wrap the resultant xml rows.

Returns:

an xml containing the query results.

Throws:

DBSQLException

queryXMLShort

public java.lang.String queryXMLShort(java.sql.Connection connection,
                                      java.lang.String sql,
                                      java.lang.String rootName,
                                      java.util.List<SqlField> params)
                               throws DBSQLException

Sends a query to the database and maps the resultset to an xml string. This 'short' version is aimed at making the xml as short as it can using attributes in place of content.

Parameters:

connection - an open database connection

sql - is the database query to execute

rootName - is an optional root element name used to wrap the resultant xml rows.

Returns:

an xml containing the query results.

Throws:

DBSQLException

queryXMLShort

public java.lang.String queryXMLShort(java.sql.ResultSet rs,
                                      java.lang.String rootName)
                               throws java.sql.SQLException,
                                      DBSQLException

builds the result set as <row index="x" attribute=value ...> where attribute name is the name of the table column.

Parameters:

rs - is the ResultSet we use to retrieve the data a row at a time

rootName - is the root element name

Throws:

java.sql.SQLException

DBSQLException

queryXMLShort

public java.lang.String queryXMLShort(java.sql.ResultSet rs,
                                      java.lang.String rootName,
                                      java.lang.String dateFormat)
                               throws DBSQLException,
                                      java.sql.SQLException

builds the result set as <row index="x" attribute=value ...> where attribute name is the name of the table column.

Parameters:

rs - is the ResultSet we use to retrieve the data a row at a time

rootName - is the root element name

dateFormat - is the date format we want for all dates, default is "dd-MM-yyyy"

Throws:

DBSQLException

java.sql.SQLException

queryXMLShort

public java.lang.String queryXMLShort(java.sql.ResultSet rs,
                                      java.lang.String[] elementNames,
                                      java.lang.String rootName,
                                      java.lang.String dateFormat)
                               throws java.sql.SQLException

builds the result set as <row index="x" attribute=value ...> where attribute name is the name of the table column.

Parameters:

rs - is the ResultSet we use to retrieve the data a row at a time

elementNames - is a corresponding name for each attribute

rootName - is the root element name

dateFormat - is the date format we want for all dates, default is "dd-MM-yyyy"

Throws:

java.sql.SQLException

queryXMLLong

public java.lang.String queryXMLLong(java.sql.ResultSet rs,
                                     java.lang.String[] elementNames,
                                     java.lang.String rootName,
                                     java.lang.String dateFormat)
                              throws java.sql.SQLException

builds the result set as <elementName>resultset.value</elementName>

Parameters:

rs - is the ResultSet we use to retrieve the data a row at a time

elementNames - is a corresponding name for each element

rootName - is the root element name

dateFormat - is the date format we want for all dates, default is "dd-MM-yyyy"

Throws:

java.sql.SQLException

query2XMLObject

public XMLObject query2XMLObject(java.sql.Connection connection,
                                 java.lang.String sql,
                                 java.lang.String rootName,
                                 java.lang.String[] elementNames,
                                 java.lang.String dateFormat,
                                 java.util.List<SqlField> params)
                          throws DBSQLException

This will get all the rows from the ResultSet and store these into an xmlObject. The XMLObject can then be added to or converted to an xml String.

Parameters:

connection - is the database connection

sql - is the sql query

rootName - is the root element name. this is mandatory

elementNames - is a corresponding name for each element, if this is null then the label names will be used instead.

dateFormat - is the date format we want for all dates, if this is null then the default is "dd-MM-yyyy"

Returns:

an XMLObject containing the rows

Throws:

DBSQLException

DBSQLException

query2XMLObject

public XMLObject query2XMLObject(java.sql.ResultSet rs,
                                 java.lang.String rootName,
                                 java.lang.String[] elementNames,
                                 java.lang.String dateFormat)
                          throws java.sql.SQLException

This will get all the rows from the ResultSet and store these into an xmlObject. The XMLObject can then be added to or converted to an xml String.

Parameters:

rs - is the ResultSet we use to retrieve the data a row at a time

elementNames - is a corresponding name for each element, if this is null then the label names will be used instead.

rootName - is the root element name. this is mandatory

dateFormat - is the date format we want for all dates, if this is null then the defaultDateFormat is used. @see defaultDateFormat

Returns:

an XMLObject containing the rows

Throws:

java.sql.SQLException

escCharacters

public static java.lang.String escCharacters(java.lang.String input)

This will escape all non-database friendly characters by appendiing the escape character "\" before them. i.e. ' = \' and " = \"

Parameters:

input - string for storage into a database

Returns:

the escaped input string.

setIncludeIndex

public void setIncludeIndex(boolean includeIndex)

isIncludeIndex

public boolean isIncludeIndex()