org.xmlactions.db.actions

Class Table

java.lang.Object

org.xmlactions.action.actions.BaseAction

org.xmlactions.db.actions.BaseStorageField

org.xmlactions.db.actions.CommonStorageField

org.xmlactions.db.actions.Fields

org.xmlactions.db.actions.Table

public class Table
extends Fields

Field Summary

Fields

Modifier and Type	Field and Description
static java.lang.String	TABLE_FIELD_AS_SEPERATOR An sql query will return the table name with the field name.
static java.lang.String	TABLE_FIELD_SEPERATOR An sql query will include the table name with the field name.

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

CHILD, CONTENT

Constructor Summary

Constructors

Constructor and Description
Table()

Method Summary

Modifier and Type	Method and Description
java.lang.String	buildQuery(java.lang.String databaseName, java.util.List<CommonStorageField> commonStorageFields, java.lang.String leftJoin, java.lang.String whereClause, java.lang.String orderBy, java.lang.String quote) Build a query to return all rows for this table including any foreign tables
java.lang.String	buildSqlFieldName(CommonStorageField field) Builds a table and field name into the output for an sql, considering that the table may have an alias.
java.lang.String	buildSqlFieldName(java.lang.String tableFieldName) Builds a table and field name into the output for an sql, considering that the table may have an alias.
java.util.List<CommonStorageField>	buildStorageFieldsList(java.util.List<SqlField> sqlFields) Gets a list of storage fields that match the field names.
java.lang.String	buildTableAndFieldName(java.lang.String fieldName) Builds a table and field name by combining the tableName.fieldName
static java.lang.String	buildTableAndFieldName(java.lang.String tableName, java.lang.String fieldName) Builds a table and field name by combining the tableName.fieldName
java.lang.String	execute(IExecContext execContext) Executes an action
java.lang.String	getBean()
CommonStorageField	getField(java.lang.String fieldName) Get a field that matches the field name.
CommonStorageField	getFieldFromTableAndFieldName(java.lang.String tableAndFieldName) Get a field that matches the table name and field name.
static java.lang.String	getFieldName(java.lang.String tableAndFieldName) This will get the field name from a table and field name string.
PK	getPk() Search through list of fields in table looking for the Primary Key.
CommonStorageField	getStorageField(java.lang.String name)
TablePath	getTable_path()
static java.lang.String	getTableName(java.lang.String tableAndFieldName) This will get the table name from a table and field name string.
java.util.List<TablePath>	getTablePaths() These are used to builds ManyToMany entries between tables using a lookup table containing references between the tables.
java.lang.String	getUpdate_field_version_num()
boolean	hasField(java.lang.String fieldName) Check if a table has a field
static boolean	isTableAndFieldName(java.lang.String name) Checks if the name is a table and field name, by searching for a .
void	setBean(java.lang.String bean)
void	setTable_path(TablePath tablePath)
void	setTablePaths(java.util.List<TablePath> tablePaths)
void	setUpdate_field_version_num(java.lang.String update_field_version_num)
java.lang.String	toString()
java.lang.String	toString(int offset)

Methods inherited from class org.xmlactions.db.actions.Fields

getField, getFields, setBinary, setDate, setDatetime, setField, setFk, setImage, setInt, setLink, setPassword, setPk, setSelect, setText, setTextarea, setTimeofday, setTimestamp, validate

Methods inherited from class org.xmlactions.db.actions.CommonStorageField

addBackLinkedFk, getAlias, getBackLinkedFks, getDate_format, getFunction_ref, getLength, getName, getName, getPattern, getPlaceholder, getPresentation_height, getPresentation_name, getPresentation_name, getPresentation_width, getQuery_sql, getRefFk, getRegex, getTooltip, getTooltip, isEditable, isMandatory, isUnique, setAlias, setDate_format, setEditable, setFunction_ref, setLength, setMandatory, setName, setPattern, setPlaceholder, setPresentation_height, setPresentation_name, setPresentation_width, setQuery_sql, setRefFk, setRegex, setTooltip, setUnique

Methods inherited from class org.xmlactions.db.actions.BaseStorageField

buildErrorString

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, wait, wait, wait

Field Detail

TABLE_FIELD_SEPERATOR

public static final java.lang.String TABLE_FIELD_SEPERATOR

An sql query will include the table name with the field name. This is used to distinguish all fields in a query. The separator character between the table name and the field name is this value. Most likely it's a '.'

See Also:

Constant Field Values

TABLE_FIELD_AS_SEPERATOR

public static final java.lang.String TABLE_FIELD_AS_SEPERATOR

An sql query will return the table name with the field name. This is used to distinguish all fields returned from a query. The separator character between the table name and the field name is this value. Most likely it's a '_'

See Also:

Constant Field Values

Constructor Detail

Table

public Table()

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

getField

public CommonStorageField getField(java.lang.String fieldName)

Get a field that matches the field name.

Parameters:

fieldName - is the field we want to find

Returns:

the found field or null

getFieldFromTableAndFieldName

public CommonStorageField getFieldFromTableAndFieldName(java.lang.String tableAndFieldName)
                                                 throws DBConfigException

Get a field that matches the table name and field name.

Parameters:

tableAndFieldName - is the field we want to find which will have the table name at the beginning. i.e. tb_tablename.fieldname

Throws:

DBConfigException

getFieldName

public static java.lang.String getFieldName(java.lang.String tableAndFieldName)

This will get the field name from a table and field name string. i.e. 'tb_table.field' will return 'field'

Parameters:

tableAndFieldName -

Returns:

the field name or null if none found

getTableName

public static java.lang.String getTableName(java.lang.String tableAndFieldName)

This will get the table name from a table and field name string. i.e. 'tb_table.field' will return 'tb_table'

Parameters:

tableAndFieldName -

Returns:

the table name or null if none found

buildTableAndFieldName

public java.lang.String buildTableAndFieldName(java.lang.String fieldName)

Builds a table and field name by combining the tableName.fieldName

Parameters:

fieldName -

Returns:

tableName.fieldName

buildTableAndFieldName

public static java.lang.String buildTableAndFieldName(java.lang.String tableName,
                                                      java.lang.String fieldName)

Builds a table and field name by combining the tableName.fieldName

Parameters:

tableName -

fieldName -

Returns:

tableName.fieldName

hasField

public boolean hasField(java.lang.String fieldName)

Check if a table has a field

Parameters:

fieldName - is the field we want to find

Returns:

true if table has the field

buildQuery

public java.lang.String buildQuery(java.lang.String databaseName,
                                   java.util.List<CommonStorageField> commonStorageFields,
                                   java.lang.String leftJoin,
                                   java.lang.String whereClause,
                                   java.lang.String orderBy,
                                   java.lang.String quote)

Build a query to return all rows for this table including any foreign tables

Parameters:

databaseName -

commonStorageFields -

leftJoin -

whereClause -

orderBy -

quote - this character quote's the field names we are returning. May be null or a ' or a ". i.e. tb_xxx.id as "tb_xxx.id"

toString

public java.lang.String toString(int offset)

Specified by:

toString in class BaseStorageField

buildStorageFieldsList

public java.util.List<CommonStorageField> buildStorageFieldsList(java.util.List<SqlField> sqlFields)

Gets a list of storage fields that match the field names. If the fieldNames is empty we return the complete list of storage fields

Parameters:

sqlFields - the list of field names

Returns:

the list of storage fields, used to build a query

getStorageField

public CommonStorageField getStorageField(java.lang.String name)

isTableAndFieldName

public static boolean isTableAndFieldName(java.lang.String name)

Checks if the name is a table and field name, by searching for a . in the name

Parameters:

name -

Returns:

true if name is a table and field name

getPk

public PK getPk()

Search through list of fields in table looking for the Primary Key.

Returns:

the PK or null if none found.

setTablePaths

public void setTablePaths(java.util.List<TablePath> tablePaths)

getTablePaths

public java.util.List<TablePath> getTablePaths()

These are used to builds ManyToMany entries between tables using a lookup table containing references between the tables.

setTable_path

public void setTable_path(TablePath tablePath)

getTable_path

public TablePath getTable_path()

buildSqlFieldName

public java.lang.String buildSqlFieldName(CommonStorageField field)

Builds a table and field name into the output for an sql, considering that the table may have an alias.

Parameters:

field - - this can be either the table.fieldname or the fieldname

Returns:

the table.alias or table.name + "." + fieldname

buildSqlFieldName

public java.lang.String buildSqlFieldName(java.lang.String tableFieldName)

Builds a table and field name into the output for an sql, considering that the table may have an alias.

Parameters:

tableFieldName - - this can be either the table.fieldname or the fieldname

Returns:

the table.alias or table.name + "." + fieldname

toString

public java.lang.String toString()

Overrides:

toString in class java.lang.Object

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)

getBean

public java.lang.String getBean()

setBean

public void setBean(java.lang.String bean)