org.xmlactions.db.actions

Class Database

java.lang.Object

org.xmlactions.action.actions.BaseAction

org.xmlactions.db.actions.Database

public class Database
extends BaseAction

Field Summary

Fields

Modifier and Type	Field and Description
static java.lang.String	SQL_QUOTE

Fields inherited from class org.xmlactions.action.actions.BaseAction

CHILD, CONTENT

Constructor Summary

Constructors

Constructor and Description
Database()

Method Summary

Modifier and Type	Method and Description
java.lang.String[]	buildQuery(java.lang.String tableName, java.lang.String[] fields, java.lang.String leftJoin, java.lang.String whereClause, java.lang.String orderBy, int rowCount, int offset) Build both the sql count to retrieve the total number of rows and the sql query to retrieve all or a subset of these rows
java.lang.String[]	buildQuery(java.lang.String databaseName, java.lang.String tableName, java.lang.String[] fields, java.lang.String leftJoin, java.lang.String whereClause, java.lang.String orderBy, int rowCount, int offset) Build both the sql count to retrieve the total number of rows and the sql query to retrieve all or a subset of these rows
java.util.List<CommonStorageField>	buildTableAndFieldNames(java.lang.String tableName)
java.lang.String	execute(IExecContext execContext) Executes an action
Table	findTablePath(java.lang.String tableName1, java.lang.String tableName2)
java.lang.String	getDate_format()
java.lang.String	getDatetime_format()
DbSpecific	getdbSpecific()
DbSpecific	getDbSpecific(java.lang.String name) Get the named DbSpecific from the dbSpecifics list
DbSpecific	getDbSpecificQuietly(java.lang.String name) Get the named DbSpecific from the dbSpecifics list
java.util.List<DbSpecific>	getDbSpecifics()
Function	getFunction()
Function	getFunction(java.lang.String name) Get the named function from the functions list
Function	getFunction(java.lang.String dbSpecificName, java.lang.String name) Get the named function from the functions list
Function	getFunctionQuietly(java.lang.String name) Get the named function from the functions list
java.util.List<Function>	getFunctions()
DBInsert	getInsert()
java.util.List<DBInsert>	getInserts()
java.lang.String	getName()
PkCreate	getPk_create()
PkCreate	getPkCreate(java.lang.String name) Get the named pkCreate from the pkCreates list
PkCreate	getPkCreate(java.lang.String name, java.lang.String dbSpecificName) Get the named pkCreate from the pkCreates list
PkCreate	getPkCreateQuietly(java.lang.String name) Get the named pkCreate from the pkCreates list
java.util.List<PkCreate>	getPkCreates()
Sql	getSql()
Sql	getSql(java.lang.String name) Get the named sql from the sqls list
Sql	getSql(java.lang.String dbSpecificName, java.lang.String name) Get the named sql from the sqls list
Sql	getSqlQuietly(java.lang.String name) Get the named sql from the sqls list
java.util.List<Sql>	getSqls()
CommonStorageField	getStorageField(java.lang.String tableAndFieldName) Get a StorageField from the database .
CommonStorageField	getStorageField(java.lang.String tableName, java.lang.String fieldName) Get a StorageField from the database .
Table	getTable()
Table	getTable(java.lang.String name) Get the named table from the table list
Table	getTableQuietly(java.lang.String name) Get the named table from the table list
java.util.List<Table>	getTables()
java.lang.String	getTime_format()
java.lang.String	getUpdate_field_version_num()
protected void	processInserts(IExecContext execContext) A database may contain DBInserts that are used to insert databases from other files.
void	setDate_format(java.lang.String date_format)
void	setDatetime_format(java.lang.String datetime_format)
void	setDb_specific(DbSpecific dbSpecific)
void	setFunction(Function function)
void	setInsert(DBInsert insert)
void	setName(java.lang.String name)
void	setPk_create(PkCreate pkCreate)
void	setSql(Sql sql)
void	setTable(Table table)
void	setTime_format(java.lang.String time_format)
void	setUpdate_field_version_num(java.lang.String update_field_version_num)
java.lang.String	toString(int indent)

Methods inherited from class org.xmlactions.action.actions.BaseAction

addChild, clearActions, doReplace, doReplace, getActions, getChild, getContent, getFirstValueFound, getParent, getReplacementContent, getReplacementMarker, isUsedForDisplay, processAction, setAction, setActions, setChild, setContent, setParent, setReplacementContent, setReplacementMarker, setUsedForDisplay

Methods inherited from class java.lang.Object

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

Field Detail

SQL_QUOTE

public static final java.lang.String SQL_QUOTE

See Also:

Constant Field Values

Constructor Detail

Database

public Database()

Method Detail

execute

public java.lang.String execute(IExecContext execContext)
                         throws java.lang.Exception

Description copied from class: BaseAction

Executes an action

Specified by:

execute in class BaseAction

Parameters:

execContext - the application execution context

Returns:

a String for replacement and to execute any child actions, else null to skip over child actions.

Throws:

java.lang.Exception

setInsert

public void setInsert(DBInsert insert)

getInsert

public DBInsert getInsert()

getInserts

public java.util.List<DBInsert> getInserts()

setTable

public void setTable(Table table)

getTable

public Table getTable()

Returns:

the last table added.

setPk_create

public void setPk_create(PkCreate pkCreate)

getPk_create

public PkCreate getPk_create()

Returns:

the last pkCreate added.

setSql

public void setSql(Sql sql)

getSql

public Sql getSql()

Returns:

the last XmlCData added.

setFunction

public void setFunction(Function function)

getFunction

public Function getFunction()

Returns:

the last Function added.

setDb_specific

public void setDb_specific(DbSpecific dbSpecific)

getdbSpecific

public DbSpecific getdbSpecific()

Returns:

the last DbSpecific added.

getTable

public Table getTable(java.lang.String name)
               throws java.lang.IllegalArgumentException

Get the named table from the table list

Returns:

the named table.

Throws:

java.lang.IllegalArgumentException - of not found

getTableQuietly

public Table getTableQuietly(java.lang.String name)
                      throws java.lang.IllegalArgumentException

Get the named table from the table list

Returns:

the named table.

Throws:

java.lang.IllegalArgumentException - of not found

getPkCreate

public PkCreate getPkCreate(java.lang.String name,
                            java.lang.String dbSpecificName)
                     throws java.lang.IllegalArgumentException

Get the named pkCreate from the pkCreates list

Returns:

the named pkCreate.

Throws:

java.lang.IllegalArgumentException - if not found

getPkCreate

public PkCreate getPkCreate(java.lang.String name)
                     throws java.lang.IllegalArgumentException

Get the named pkCreate from the pkCreates list

Returns:

the named pkCreate.

Throws:

java.lang.IllegalArgumentException - if not found

getPkCreateQuietly

public PkCreate getPkCreateQuietly(java.lang.String name)
                            throws java.lang.IllegalArgumentException

Get the named pkCreate from the pkCreates list

Returns:

the named pkCreate.

Throws:

java.lang.IllegalArgumentException - if not found

getSql

public Sql getSql(java.lang.String name)
           throws java.lang.IllegalArgumentException

Get the named sql from the sqls list

Parameters:

name - - the name of the sql that we want

Returns:

the named sql.

Throws:

java.lang.IllegalArgumentException - if not found

getSqlQuietly

public Sql getSqlQuietly(java.lang.String name)
                  throws java.lang.IllegalArgumentException

Get the named sql from the sqls list

Parameters:

name - - the name of the sql that we want

Returns:

the named sql.

Throws:

java.lang.IllegalArgumentException

getSql

public Sql getSql(java.lang.String dbSpecificName,
                  java.lang.String name)
           throws java.lang.IllegalArgumentException

Get the named sql from the sqls list

Parameters:

dbSpecificName - - if we want a database specific sql

name - - the name of the sql that we want

Returns:

the named sql.

Throws:

java.lang.IllegalArgumentException - if not found

getFunction

public Function getFunction(java.lang.String name)
                     throws java.lang.IllegalArgumentException

Get the named function from the functions list

Parameters:

name - - the name of the function that we want

Returns:

the named function.

Throws:

java.lang.IllegalArgumentException - if not found

getFunctionQuietly

public Function getFunctionQuietly(java.lang.String name)
                            throws java.lang.IllegalArgumentException

Get the named function from the functions list

Parameters:

name - - the name of the function that we want

Returns:

the named function.

Throws:

java.lang.IllegalArgumentException

getFunction

public Function getFunction(java.lang.String dbSpecificName,
                            java.lang.String name)
                     throws java.lang.IllegalArgumentException

Get the named function from the functions list

Parameters:

dbSpecificName - - if we want a database specific sql

name - - the name of the sql that we want

Returns:

the named function.

Throws:

java.lang.IllegalArgumentException - if not found

getDbSpecific

public DbSpecific getDbSpecific(java.lang.String name)
                         throws java.lang.IllegalArgumentException

Get the named DbSpecific from the dbSpecifics list

Returns:

the named DbSpecific.

Throws:

java.lang.IllegalArgumentException - if not found

getDbSpecificQuietly

public DbSpecific getDbSpecificQuietly(java.lang.String name)
                                throws java.lang.IllegalArgumentException

Get the named DbSpecific from the dbSpecifics list

Returns:

the named DbSpecific or null

Throws:

java.lang.IllegalArgumentException

getTables

public java.util.List<Table> getTables()

getPkCreates

public java.util.List<PkCreate> getPkCreates()

getSqls

public java.util.List<Sql> getSqls()

getFunctions

public java.util.List<Function> getFunctions()

getDbSpecifics

public java.util.List<DbSpecific> getDbSpecifics()

setName

public void setName(java.lang.String name)

getName

public java.lang.String getName()

toString

public java.lang.String toString(int indent)

buildQuery

public java.lang.String[] buildQuery(java.lang.String tableName,
                                     java.lang.String[] fields,
                                     java.lang.String leftJoin,
                                     java.lang.String whereClause,
                                     java.lang.String orderBy,
                                     int rowCount,
                                     int offset)
                              throws DBConfigException

Build both the sql count to retrieve the total number of rows and the sql query to retrieve all or a subset of these rows

Parameters:

tableName -

fields - we want to include in the query or null if we want them all

leftJoin -

whereClause - is the where clause if not null.

orderBy - the sort order or null if no sort required

rowCount - the number of rows we want returned, -1 for all rows

offset - the starting row, -1 to ignore

Returns:

the SQL Count Query and the Row Query

Throws:

DBConfigException

buildQuery

public java.lang.String[] buildQuery(java.lang.String databaseName,
                                     java.lang.String tableName,
                                     java.lang.String[] fields,
                                     java.lang.String leftJoin,
                                     java.lang.String whereClause,
                                     java.lang.String orderBy,
                                     int rowCount,
                                     int offset)
                              throws DBConfigException

Build both the sql count to retrieve the total number of rows and the sql query to retrieve all or a subset of these rows

Parameters:

databaseName -

tableName -

fields - we want to include in the query or null if we want them all

leftJoin -

whereClause - is the where clause if not null.

orderBy - the sort order or null if no sort required

rowCount - the number of rows we want returned, -1 for all rows

offset - the starting row, -1 to ignore

Returns:

the SQL Count Query and the Row Query

Throws:

DBConfigException

buildTableAndFieldNames

public java.util.List<CommonStorageField> buildTableAndFieldNames(java.lang.String tableName)

getStorageField

public CommonStorageField getStorageField(java.lang.String tableAndFieldName)

Get a StorageField from the database . table that matches tableAndFieldName. TODO add unit test

Parameters:

tableAndFieldName -

Returns:

Throws:

java.lang.IllegalArgumentException

getStorageField

public CommonStorageField getStorageField(java.lang.String tableName,
                                          java.lang.String fieldName)

Get a StorageField from the database . table that matches tableName. TODO add unit test

Parameters:

tableName -

fieldName -

Returns:

Throws:

java.lang.IllegalArgumentException

findTablePath

public Table findTablePath(java.lang.String tableName1,
                           java.lang.String tableName2)

processInserts

protected void processInserts(IExecContext execContext)
                       throws java.lang.Exception

A database may contain DBInserts that are used to insert databases from other files. This method calls the insertion process.

Parameters:

execContext -

Throws:

java.lang.Exception

getDate_format

public java.lang.String getDate_format()

Returns:

the date_format

setDate_format

public void setDate_format(java.lang.String date_format)

Parameters:

date_format - the date_format to set

getTime_format

public java.lang.String getTime_format()

Returns:

the time_format

setTime_format

public void setTime_format(java.lang.String time_format)

Parameters:

time_format - the time_format to set

getDatetime_format

public java.lang.String getDatetime_format()

Returns:

the datetime_format

setDatetime_format

public void setDatetime_format(java.lang.String datetime_format)

Parameters:

datetime_format - the datetime_format to set

getUpdate_field_version_num

public java.lang.String getUpdate_field_version_num()

setUpdate_field_version_num

public void setUpdate_field_version_num(java.lang.String update_field_version_num)