com.konakart.db

Class KKCriteria

java.lang.Object

org.apache.torque.util.Criteria

com.konakart.db.KKCriteria

All Implemented Interfaces:

java.io.Serializable, org.apache.torque.criteria.CriteriaInterface<org.apache.torque.util.Criteria>

public class KKCriteria
extends org.apache.torque.util.Criteria

KKCriteria

See Also:

Serialized Form

Nested Class Summary

Nested Classes

Modifier and Type	Class and Description
class	KKCriteria.KKCriterion This is an inner class that describes an object in the criteria.

Nested classes/interfaces inherited from class org.apache.torque.util.Criteria

org.apache.torque.util.Criteria.Criterion

Field Summary

Fields

Modifier and Type	Field and Description
static org.apache.torque.criteria.SqlEnum	ALL Comparison type.
static org.apache.torque.criteria.SqlEnum	ALT_NOT_EQUAL Comparison type.
static org.apache.torque.criteria.SqlEnum	CURRENT_DATE "CURRENT_DATE" ANSI SQL function
static org.apache.torque.criteria.SqlEnum	CURRENT_TIME "CURRENT_TIME" ANSI SQL function
static org.apache.torque.criteria.SqlEnum	CUSTOM Comparison type.
static org.apache.torque.criteria.SqlEnum	DISTINCT Comparison type.
static org.apache.torque.criteria.SqlEnum	EQUAL Comparison type.
static org.apache.torque.criteria.SqlEnum	GREATER_EQUAL Comparison type.
static org.apache.torque.criteria.SqlEnum	GREATER_THAN Comparison type.
static org.apache.torque.criteria.SqlEnum	ILIKE Comparison type.
static org.apache.torque.criteria.SqlEnum	IN Comparison type.
static org.apache.torque.criteria.JoinType	INNER_JOIN "INNER JOIN" SQL statement
static org.apache.torque.criteria.SqlEnum	ISNOTNULL "IS NOT NULL" null comparison
static org.apache.torque.criteria.SqlEnum	ISNULL "IS NULL" null comparison
static org.apache.torque.criteria.SqlEnum	JOIN Comparison type.
static org.apache.torque.criteria.JoinType	LEFT_JOIN "LEFT JOIN" SQL statement
static org.apache.torque.criteria.SqlEnum	LESS_EQUAL Comparison type.
static org.apache.torque.criteria.SqlEnum	LESS_THAN Comparison type.
static org.apache.torque.criteria.SqlEnum	LIKE Comparison type.
protected static org.apache.commons.logging.Log	log the log
static org.apache.torque.criteria.SqlEnum	NOT_EQUAL Comparison type.
static org.apache.torque.criteria.SqlEnum	NOT_ILIKE Comparison type.
static org.apache.torque.criteria.SqlEnum	NOT_IN Comparison type.
static org.apache.torque.criteria.SqlEnum	NOT_LIKE Comparison type.
static java.util.Map<java.lang.String,org.apache.torque.util.BasePeerImpl<?>>	peerImplMap Holds a map of Peer class name to PeerImpl objects
static org.apache.torque.criteria.JoinType	RIGHT_JOIN "RIGHT JOIN" SQL statement

Constructor Summary

Constructors

Constructor and Description
KKCriteria() Constructor
KKCriteria(java.lang.String dbName) Constructor

Method Summary

Modifier and Type	Method and Description
org.apache.torque.util.Criteria	add(org.apache.torque.map.ColumnMap colMap, java.lang.Object value) Add a column and a value to the criteria
org.apache.torque.util.Criteria	add(org.apache.torque.map.ColumnMap colMap, java.lang.Object value, org.apache.torque.criteria.SqlEnum comparison)
org.apache.torque.util.Criteria	add(org.apache.torque.util.Criteria.Criterion c)
KKCriteria	add(KKCriteria.KKCriterion c) This method adds a prepared KKCriterion object to the KKCriteria.
KKCriteria	add(java.lang.String column, java.lang.Object value) This method adds a new criterion to the list of criterias.
KKCriteria	add(java.lang.String column, java.lang.Object value, org.apache.torque.criteria.SqlEnum comparison) This method adds a new criterion to the list of criterias.
org.apache.torque.util.Criteria	addAscendingOrderByColumn(org.apache.torque.Column column) Add order by column name, explicitly specifying ascending.
org.apache.torque.util.Criteria	addAscendingOrderByColumn(java.lang.String name) Add order by column name, explicitly specifying ascending.
void	addCriterionOrNull(org.apache.torque.map.ColumnMap col, org.apache.torque.criteria.SqlEnum comparison, java.lang.Object value) Add a Criterion where a column is compared with a value OR is null
org.apache.torque.util.Criteria	addDescendingOrderByColumn(org.apache.torque.Column column) Add order by column name, explicitly specifying descending.
org.apache.torque.util.Criteria	addDescendingOrderByColumn(java.lang.String name) Add order by column name, explicitly specifying descending.
void	addForInsert(org.apache.torque.map.ColumnMap colMap, int value) A utility method to not add integers that are equal to BaseMgr.NOT_INITIALISED
void	addForInsert(org.apache.torque.map.ColumnMap colMap, java.lang.Object value) A utility to not add null objects
org.apache.torque.util.Criteria	addGroupByColumn(org.apache.torque.Column groupBy) Add group by column name.
KKCriteria	addIn(org.apache.torque.Column column, java.util.Collection<?> values) Adds an 'IN' clause with the criteria supplied as a Collection.
void	addIn(org.apache.torque.map.ColumnMap colMap, int[] inObjects) Add objects to the in clause of the criteria
void	addIn(org.apache.torque.map.ColumnMap colMap, java.lang.Object[] inObjects) Add objects to the in clause of the criteria
org.apache.torque.util.Criteria	addJoin(org.apache.torque.Column left, org.apache.torque.Column right) This is the way that you should add a join of two tables.
org.apache.torque.util.Criteria	addJoin(org.apache.torque.Column left, org.apache.torque.Column right, org.apache.torque.criteria.JoinType operator) This is the way that you should add a join of two tables.
org.apache.torque.util.Criteria	addJoin(org.apache.torque.map.ColumnMap left, org.apache.torque.map.ColumnMap right) This is the way that you should add a join of two tables.
org.apache.torque.util.Criteria	addJoin(org.apache.torque.map.ColumnMap left, org.apache.torque.map.ColumnMap right, org.apache.torque.criteria.JoinType operator) This is the way that you should add a join of two tables.
void	addJoin(org.apache.torque.map.ColumnMap colMap, java.lang.String right, org.apache.torque.criteria.JoinType joinType) Add a Join of the specified type
void	addJoin(java.lang.String left, org.apache.torque.map.ColumnMap right)
org.apache.torque.util.Criteria	addJoin(java.lang.String left, java.lang.String right) This is the way that you should add a join of two tables.
void	addNotIn(org.apache.torque.map.ColumnMap colMap, int[] inObjects) Add objects to the not in clause of the criteria
KKCriteria	addSelectColumn(org.apache.torque.Column column) Add select column.
KKCriteria	addSelectColumn(org.apache.torque.map.ColumnMap colMap) Add select column.
KKCriteria	addSelectColumn(java.lang.String name) Add select column.
void	clear() Brings this criteria back to its initial state, so that it can be reused as if it was new.
boolean	containsKey(org.apache.torque.map.ColumnMap colMap) Does the Criteria contain this column already?
void	derivePeerImpl(org.apache.torque.Column col) Derive the PeerImpl for the criteria
void	derivePeerImpl(org.apache.torque.map.ColumnMap colMap) Derive the PeerImpl for the criteria
void	derivePeerImpl(java.lang.String tableName) Derive the PeerImpl for the criteria
void	derivePeerImpl(org.apache.torque.map.TableMap tabMap) Derive the PeerImpl for the criteria
java.util.Map<java.lang.String,org.apache.torque.Column>	getAsColumns() Get the column aliases.
org.apache.torque.util.ColumnValues	getColValues()
java.lang.String	getDbName() Get the Database(Map) name.
java.lang.String	getDisplayQuery()
java.lang.String	getFirstTablename()
org.apache.torque.util.UniqueColumnList	getGroupByColumns() Get group by columns.
KKCriteria.KKCriterion	getNewCriterion(org.apache.torque.map.ColumnMap colMap, java.lang.Object value, org.apache.torque.criteria.SqlEnum comparison) Method to return criterion that is not added automatically to this Criteria.
KKCriteria.KKCriterion	getNewCriterion(org.apache.torque.map.ColumnMap colMap, java.lang.String value, java.lang.String preWildCard, java.lang.String postWildCard, int rule, boolean ignoreCase)
KKCriteria.KKCriterion	getNewCriterion(org.apache.torque.Column column, java.lang.Object value, org.apache.torque.criteria.SqlEnum comparison) Method to return criterion that is not added automatically to this Criteria.
KKCriteria.KKCriterion	getNewCriterion(java.lang.String table, java.lang.String column, java.lang.String value, java.lang.String preWildCard, java.lang.String postWildCard, int rule, boolean ignoreCase) Method to return criterion object for a query
KKCriteria.KKCriterion	getNewKKCriterion(org.apache.torque.Column column, java.lang.Object value, org.apache.torque.criteria.SqlEnum comparison) Method to return criterion that is not added automatically to this Criteria.
KKCriteria.KKCriterion	getNewKKCriterion(java.lang.String column, java.lang.Object value, org.apache.torque.criteria.SqlEnum comparison) Method to return criterion that is not added automatically to this Criteria.
org.apache.torque.util.UniqueList<org.apache.torque.sql.OrderBy>	getOrderByColumns() Get order by columns.
org.apache.torque.util.BasePeerImpl<?>	getPeerImpl()
java.lang.String	getQueryString()
static KKSearch	getSearch(java.lang.String searchString, int rule) Creates a search string based on the rule.
static org.apache.torque.criteria.SqlEnum	getSearchCriteria(int rule) Returns the Torque constraint for the KonaKart rule.
org.apache.torque.util.UniqueColumnList	getSelectColumns() Get select columns.
java.lang.Object	getSqlValue(int torqueType, java.lang.Object value) Get a value for the Torque Type suitable for a prepared statement
java.lang.String	getStoreId()
java.lang.String	getTableName()
org.apache.torque.sql.Query.Type	getType()
java.lang.Object	getValue(org.apache.torque.Column column) Method to return the value that was added to Criteria.
boolean	isEmpty() Returns whether there are any criterions in this criteria.
boolean	isLogInsertFailures() Don't log insert failures at WARN level if false.
boolean	isUseTransaction() called by BasePeer to determine whether the sql command specified by this criteria must be wrapped in a transaction.
org.apache.torque.util.Criteria	or(java.lang.String column, java.lang.Object value, org.apache.torque.criteria.SqlEnum comparison) This method adds a new OR criterion to the list of criteria.
void	put(java.lang.String fullyQualifiedName, java.lang.Object value)
java.lang.Object	remove(java.lang.String fullyQualifiedName)
void	setDbName(java.lang.String dbName) Set the DatabaseMap name.
void	setDisplayQuery(java.lang.String displayQuery)
void	setDistinct() Adds "DISTINCT " to the SQL statement.
void	setFirstTablename(java.lang.String firstTablename)
org.apache.torque.util.Criteria	setLimit(int limit) Set limit.
void	setLogInsertFailures(boolean logInsertFailures) Don't log insert failures at WARN level if false.
org.apache.torque.util.Criteria	setOffset(long offset) Set offset.
void	setPeerImpl(org.apache.torque.util.BasePeerImpl<?> peerImpl)
void	setStoreId(java.lang.String storeId)
void	setType(org.apache.torque.sql.Query.Type type)
void	setUseTransaction(boolean v) Will force the sql represented by this criteria to be executed within a transaction.
java.lang.String	toString() Build a string representation of the Criteria.

Methods inherited from class org.apache.torque.util.Criteria

add, add, add, add, addAlias, addAscendingOrderByColumn, addAsColumn, addAsColumn, addDate, addDate, addDate, addDate, addDescendingOrderByColumn, addGroupByColumn, addHaving, addIn, addIn, addIn, addJoin, addJoinInCriteria, addNotIn, addNotIn, addNotIn, addNotIn, and, and, and, and, and, and, and, andDate, andDate, andDate, andDate, andDate, andIn, andIn, andIn, andIn, andNotIn, andNotIn, andNotIn, andNotIn, containsKey, equals, get, getAliases, getBigDecimal, getBigDecimal, getBoolean, getBoolean, getComparison, getComparison, getCriterion, getCriterion, getCriterion, getDate, getDate, getDouble, getDouble, getFloat, getFloat, getHaving, getInt, getInt, getInteger, getInteger, getJoins, getLimit, getList, getList, getLong, getLong, getNewCriterion, getNewCriterion, getObjectKey, getObjectKey, getOffset, getSelectModifiers, getString, getString, getTableForAlias, getValue, hashCode, isIgnoreCase, isSingleRecord, keySet, or, or, or, or, or, or, orDate, orDate, orDate, orDate, orIn, orIn, orIn, orIn, orNotIn, orNotIn, orNotIn, orNotIn, put, putAll, remove, setAll, setIgnoreCase, setSingleRecord, size, values

Methods inherited from class java.lang.Object

clone, finalize, getClass, notify, notifyAll, wait, wait, wait

Field Detail

log

protected static final org.apache.commons.logging.Log log

the log

EQUAL

public static final org.apache.torque.criteria.SqlEnum EQUAL

Comparison type.

NOT_EQUAL

public static final org.apache.torque.criteria.SqlEnum NOT_EQUAL

Comparison type.

ALT_NOT_EQUAL

public static final org.apache.torque.criteria.SqlEnum ALT_NOT_EQUAL

Comparison type.

GREATER_THAN

public static final org.apache.torque.criteria.SqlEnum GREATER_THAN

Comparison type.

LESS_THAN

public static final org.apache.torque.criteria.SqlEnum LESS_THAN

Comparison type.

GREATER_EQUAL

public static final org.apache.torque.criteria.SqlEnum GREATER_EQUAL

Comparison type.

LESS_EQUAL

public static final org.apache.torque.criteria.SqlEnum LESS_EQUAL

Comparison type.

LIKE

public static final org.apache.torque.criteria.SqlEnum LIKE

Comparison type.

NOT_LIKE

public static final org.apache.torque.criteria.SqlEnum NOT_LIKE

Comparison type.

ILIKE

public static final org.apache.torque.criteria.SqlEnum ILIKE

Comparison type.

NOT_ILIKE

public static final org.apache.torque.criteria.SqlEnum NOT_ILIKE

Comparison type.

CUSTOM

public static final org.apache.torque.criteria.SqlEnum CUSTOM

Comparison type.

DISTINCT

public static final org.apache.torque.criteria.SqlEnum DISTINCT

Comparison type.

IN

public static final org.apache.torque.criteria.SqlEnum IN

Comparison type.

NOT_IN

public static final org.apache.torque.criteria.SqlEnum NOT_IN

Comparison type.

ALL

public static final org.apache.torque.criteria.SqlEnum ALL

Comparison type.

JOIN

public static final org.apache.torque.criteria.SqlEnum JOIN

Comparison type.

ISNULL

public static final org.apache.torque.criteria.SqlEnum ISNULL

"IS NULL" null comparison

ISNOTNULL

public static final org.apache.torque.criteria.SqlEnum ISNOTNULL

"IS NOT NULL" null comparison

CURRENT_DATE

public static final org.apache.torque.criteria.SqlEnum CURRENT_DATE

"CURRENT_DATE" ANSI SQL function

CURRENT_TIME

public static final org.apache.torque.criteria.SqlEnum CURRENT_TIME

"CURRENT_TIME" ANSI SQL function

LEFT_JOIN

public static final org.apache.torque.criteria.JoinType LEFT_JOIN

"LEFT JOIN" SQL statement

RIGHT_JOIN

public static final org.apache.torque.criteria.JoinType RIGHT_JOIN

"RIGHT JOIN" SQL statement

INNER_JOIN

public static final org.apache.torque.criteria.JoinType INNER_JOIN

"INNER JOIN" SQL statement

peerImplMap

public static java.util.Map<java.lang.String,org.apache.torque.util.BasePeerImpl<?>> peerImplMap

Holds a map of Peer class name to PeerImpl objects

Constructor Detail

KKCriteria

public KKCriteria()

Constructor

KKCriteria

public KKCriteria(java.lang.String dbName)

Constructor

Parameters:

dbName - the dbName

Method Detail

addForInsert

public void addForInsert(org.apache.torque.map.ColumnMap colMap,
                         int value)

A utility method to not add integers that are equal to BaseMgr.NOT_INITIALISED

Parameters:

colMap - the colMap

value - the value

addForInsert

public void addForInsert(org.apache.torque.map.ColumnMap colMap,
                         java.lang.Object value)

A utility to not add null objects

Parameters:

colMap - the colMap

value - the value

getSqlValue

public java.lang.Object getSqlValue(int torqueType,
                                    java.lang.Object value)

Get a value for the Torque Type suitable for a prepared statement

Parameters:

torqueType - the torqueType

value - the value

Returns:

a value for SQL

add

public KKCriteria add(java.lang.String column,
                      java.lang.Object value,
                      org.apache.torque.criteria.SqlEnum comparison)

This method adds a new criterion to the list of criterias. If a criterion for the requested column already exists, it is replaced. If is used as follow:

Criteria crit = new Criteria().add("column", "value" Criteria.GREATER_THAN); Any comparison can be used. The name of the table must be used implicitly in the column name, so the Column name must be something like 'TABLE.id'. If you don't like this, you can use the add(table, column, value) method.

Overrides:

add in class org.apache.torque.util.Criteria

Parameters:

column - The column to run the comparison on

value - An Object.

comparison - A String.

Returns:

A modified Criteria object.

add

public org.apache.torque.util.Criteria add(org.apache.torque.map.ColumnMap colMap,
                                           java.lang.Object value,
                                           org.apache.torque.criteria.SqlEnum comparison)

Parameters:

colMap - the colMap

value - An Object.

comparison - A String.

Returns:

A modified Criteria object.

add

public org.apache.torque.util.Criteria add(org.apache.torque.map.ColumnMap colMap,
                                           java.lang.Object value)

Add a column and a value to the criteria

Parameters:

colMap - the colMap

value - the value

Returns:

this criteria

add

public KKCriteria add(java.lang.String column,
                      java.lang.Object value)

This method adds a new criterion to the list of criterias. If a criterion for the requested column already exists, it is replaced. This is used as follows:

Criteria crit = new Criteria().add("column", "value"); An EQUAL comparison is used for column and value. The name of the table must be used implicitly in the column name, so the Column name must be something like 'TABLE.id'. If you don't like this, you can use the add(table, column, value) method.

Overrides:

add in class org.apache.torque.util.Criteria

Parameters:

column - The column to run the comparison on

value - An Object.

Returns:

A modified Criteria object.

addIn

public void addIn(org.apache.torque.map.ColumnMap colMap,
                  java.lang.Object[] inObjects)

Add objects to the in clause of the criteria

Parameters:

colMap - the colMap

inObjects - the inObjects

addIn

public void addIn(org.apache.torque.map.ColumnMap colMap,
                  int[] inObjects)

Add objects to the in clause of the criteria

Parameters:

colMap - the colMap

inObjects - the inObjects

addIn

public KKCriteria addIn(org.apache.torque.Column column,
                        java.util.Collection<?> values)

Adds an 'IN' clause with the criteria supplied as a Collection. For example:

FOO.NAME IN ('FOO', 'BAR', 'ZOW')

where 'values' contains three Strings "FOO", "BAR" and "ZOW". If a criterion for the requested column already exists, it is replaced.

Overrides:

addIn in class org.apache.torque.util.Criteria

Parameters:

column - The column to run the comparison on

values - A Collection with the allowed values.

Returns:

A modified Criteria object.

addNotIn

public void addNotIn(org.apache.torque.map.ColumnMap colMap,
                     int[] inObjects)

Add objects to the not in clause of the criteria

Parameters:

colMap - the colMap

inObjects - the inObjects

derivePeerImpl

public void derivePeerImpl(java.lang.String tableName)
                    throws org.apache.torque.TorqueException

Derive the PeerImpl for the criteria

Parameters:

tableName - the tableName

Throws:

org.apache.torque.TorqueException - an unexpected exception in Torque (the database layer)

derivePeerImpl

public void derivePeerImpl(org.apache.torque.map.ColumnMap colMap)

Derive the PeerImpl for the criteria

Parameters:

colMap - the colMap

derivePeerImpl

public void derivePeerImpl(org.apache.torque.Column col)
                    throws org.apache.torque.TorqueException

Derive the PeerImpl for the criteria

Parameters:

col - the col

Throws:

org.apache.torque.TorqueException - an unexpected exception in Torque (the database layer)

derivePeerImpl

public void derivePeerImpl(org.apache.torque.map.TableMap tabMap)

Derive the PeerImpl for the criteria

Parameters:

tabMap - the tabMap

or

public org.apache.torque.util.Criteria or(java.lang.String column,
                                          java.lang.Object value,
                                          org.apache.torque.criteria.SqlEnum comparison)

This method adds a new OR criterion to the list of criteria. It is used as follow:

Criteria crit = new Criteria().add("column", "value" Criteria.GREATER_THAN); crit.or("column", "value" Criteria.GREATER_THAN); Any comparison can be used. The name of the table must be used implicitly in the column name, so the Column name must be something like 'TABLE.id'. If you don't like this, you can use the add(table, column, value) method.

Overrides:

or in class org.apache.torque.util.Criteria

Parameters:

column - The column to run the comparison on

value - An Object.

comparison - A String.

Returns:

A modified Criteria object.

addSelectColumn

public KKCriteria addSelectColumn(org.apache.torque.Column column)

Add select column.

Overrides:

addSelectColumn in class org.apache.torque.util.Criteria

Parameters:

column - The select column to add.

Returns:

A modified Criteria object.

addSelectColumn

public KKCriteria addSelectColumn(org.apache.torque.map.ColumnMap colMap)

Add select column.

Parameters:

colMap - The select column to add.

Returns:

A modified Criteria object.

addSelectColumn

public KKCriteria addSelectColumn(java.lang.String name)

Add select column.

Overrides:

addSelectColumn in class org.apache.torque.util.Criteria

Parameters:

name - A String with the name of the select column.

Returns:

A modified Criteria object.

addJoin

public org.apache.torque.util.Criteria addJoin(java.lang.String left,
                                               java.lang.String right)

This is the way that you should add a join of two tables. For example:

AND PROJECT.PROJECT_ID=FOO.PROJECT_ID

left = PROJECT.PROJECT_ID right = FOO.PROJECT_ID

Overrides:

addJoin in class org.apache.torque.util.Criteria

Parameters:

left - A String with the left side of the join.

right - A String with the right side of the join.

Returns:

A modified Criteria object.

addJoin

public org.apache.torque.util.Criteria addJoin(org.apache.torque.Column left,
                                               org.apache.torque.Column right,
                                               org.apache.torque.criteria.JoinType operator)

This is the way that you should add a join of two tables. For example:

PROJECT LEFT JOIN FOO ON PROJECT.PROJECT_ID=FOO.PROJECT_ID

left = "PROJECT.PROJECT_ID" right = "FOO.PROJECT_ID" operator = Criteria.LEFT_JOIN

Overrides:

addJoin in class org.apache.torque.util.Criteria

Parameters:

left - A String with the left side of the join.

right - A String with the right side of the join.

operator - The operator used for the join: must be one of null, Criteria.LEFT_JOIN, Criteria.RIGHT_JOIN, Criteria.INNER_JOIN

Returns:

A modified Criteria object.

addJoin

public org.apache.torque.util.Criteria addJoin(org.apache.torque.map.ColumnMap left,
                                               org.apache.torque.map.ColumnMap right,
                                               org.apache.torque.criteria.JoinType operator)

This is the way that you should add a join of two tables. For example:

PROJECT LEFT JOIN FOO ON PROJECT.PROJECT_ID=FOO.PROJECT_ID

left = "PROJECT.PROJECT_ID" right = "FOO.PROJECT_ID" operator = Criteria.LEFT_JOIN

Parameters:

left - A String with the left side of the join.

right - A String with the right side of the join.

operator - The operator used for the join: must be one of null, Criteria.LEFT_JOIN, Criteria.RIGHT_JOIN, Criteria.INNER_JOIN

Returns:

A modified Criteria object.

addJoin

public org.apache.torque.util.Criteria addJoin(org.apache.torque.Column left,
                                               org.apache.torque.Column right)

This is the way that you should add a join of two tables. For example:

AND PROJECT.PROJECT_ID=FOO.PROJECT_ID

left = PROJECT.PROJECT_ID right = FOO.PROJECT_ID

Overrides:

addJoin in class org.apache.torque.util.Criteria

Parameters:

left - A String with the left side of the join.

right - A String with the right side of the join.

Returns:

A modified Criteria object.

addJoin

public org.apache.torque.util.Criteria addJoin(org.apache.torque.map.ColumnMap left,
                                               org.apache.torque.map.ColumnMap right)

This is the way that you should add a join of two tables. For example:

AND PROJECT.PROJECT_ID=FOO.PROJECT_ID

left = PROJECT.PROJECT_ID right = FOO.PROJECT_ID

Parameters:

left - A String with the left side of the join.

right - A String with the right side of the join.

Returns:

A modified Criteria object.

addJoin

public void addJoin(org.apache.torque.map.ColumnMap colMap,
                    java.lang.String right,
                    org.apache.torque.criteria.JoinType joinType)

Add a Join of the specified type

Parameters:

colMap - the colMap

right - the right

joinType - the joinType

addJoin

public void addJoin(java.lang.String left,
                    org.apache.torque.map.ColumnMap right)

Parameters:

left - the left

right - the right

addAscendingOrderByColumn

public org.apache.torque.util.Criteria addAscendingOrderByColumn(java.lang.String name)

Add order by column name, explicitly specifying ascending.

Overrides:

addAscendingOrderByColumn in class org.apache.torque.util.Criteria

Parameters:

name - The name of the column to order by.

Returns:

A modified Criteria object.

addAscendingOrderByColumn

public org.apache.torque.util.Criteria addAscendingOrderByColumn(org.apache.torque.Column column)

Add order by column name, explicitly specifying ascending.

Overrides:

addAscendingOrderByColumn in class org.apache.torque.util.Criteria

Parameters:

column - The column to order by.

Returns:

A modified Criteria object.

addDescendingOrderByColumn

public org.apache.torque.util.Criteria addDescendingOrderByColumn(java.lang.String name)

Add order by column name, explicitly specifying descending.

Overrides:

addDescendingOrderByColumn in class org.apache.torque.util.Criteria

Parameters:

name - The name of the column to order by.

Returns:

A modified Criteria object.

addDescendingOrderByColumn

public org.apache.torque.util.Criteria addDescendingOrderByColumn(org.apache.torque.Column column)

Add order by column name, explicitly specifying descending.

Overrides:

addDescendingOrderByColumn in class org.apache.torque.util.Criteria

Parameters:

column - The column to order by.

Returns:

A modified Criteria object.

addGroupByColumn

public org.apache.torque.util.Criteria addGroupByColumn(org.apache.torque.Column groupBy)

Add group by column name.

Overrides:

addGroupByColumn in class org.apache.torque.util.Criteria

Parameters:

groupBy - The name of the column to group by.

Returns:

A modified Criteria object.

clear

public void clear()

Brings this criteria back to its initial state, so that it can be reused as if it was new. Except if the criteria has grown in capacity, it is left at the current capacity.

Overrides:

clear in class org.apache.torque.util.Criteria

isEmpty

public boolean isEmpty()

Returns whether there are any criterions in this criteria.

Overrides:

isEmpty in class org.apache.torque.util.Criteria

Returns:

true if there are criterions, false otherwise.

getOrderByColumns

public org.apache.torque.util.UniqueList<org.apache.torque.sql.OrderBy> getOrderByColumns()

Get order by columns.

Specified by:

getOrderByColumns in interface org.apache.torque.criteria.CriteriaInterface<org.apache.torque.util.Criteria>

Overrides:

getOrderByColumns in class org.apache.torque.util.Criteria

Returns:

An UniqueList with the name of the order columns, not null.

getGroupByColumns

public org.apache.torque.util.UniqueColumnList getGroupByColumns()

Get group by columns.

Specified by:

getGroupByColumns in interface org.apache.torque.criteria.CriteriaInterface<org.apache.torque.util.Criteria>

Overrides:

getGroupByColumns in class org.apache.torque.util.Criteria

Returns:

An UniqueList with the name of the groupBy clause, not null.

getAsColumns

public java.util.Map<java.lang.String,org.apache.torque.Column> getAsColumns()

Get the column aliases.

Specified by:

getAsColumns in interface org.apache.torque.criteria.CriteriaInterface<org.apache.torque.util.Criteria>

Overrides:

getAsColumns in class org.apache.torque.util.Criteria

Returns:

A Map which map the column alias names to the alias clauses.

getSearch

public static KKSearch getSearch(java.lang.String searchString,
                                 int rule)

Creates a search string based on the rule. Adds wild cards if necessary.

Parameters:

searchString - the searchString

rule - the rule

Returns:

Returns a KKSearch object containing the search string and constraint

getSearchCriteria

public static org.apache.torque.criteria.SqlEnum getSearchCriteria(int rule)

Returns the Torque constraint for the KonaKart rule.

Parameters:

rule - the rule

Returns:

Returns the Torque constraint for the KonaKart rule

getStoreId

public java.lang.String getStoreId()

Returns:

the storeId

setStoreId

public void setStoreId(java.lang.String storeId)

Parameters:

storeId - the storeId to set

containsKey

public boolean containsKey(org.apache.torque.map.ColumnMap colMap)

Does the Criteria contain this column already?

Parameters:

colMap - the colMap

Returns:

true if the column is in the Criteria already

setUseTransaction

public void setUseTransaction(boolean v)

Will force the sql represented by this criteria to be executed within a transaction. This is here primarily to support the oid type in postgresql. Though it can be used to require any single sql statement to use a transaction.

Parameters:

v - the v

isUseTransaction

public boolean isUseTransaction()

called by BasePeer to determine whether the sql command specified by this criteria must be wrapped in a transaction.

Returns:

a boolean value

getTableName

public java.lang.String getTableName()

Returns:

the fully qualified table name

remove

public java.lang.Object remove(java.lang.String fullyQualifiedName)

Parameters:

fullyQualifiedName - the fullyQualifiedName

Returns:

the value of the removed Criterion or null

put

public void put(java.lang.String fullyQualifiedName,
                java.lang.Object value)

Parameters:

fullyQualifiedName - the fullyQualifiedName

value - the value

getNewCriterion

public KKCriteria.KKCriterion getNewCriterion(org.apache.torque.map.ColumnMap colMap,
                                              java.lang.String value,
                                              java.lang.String preWildCard,
                                              java.lang.String postWildCard,
                                              int rule,
                                              boolean ignoreCase)

Parameters:

colMap - the colMap

value - the value

preWildCard - the preWildCard

postWildCard - the postWildCard

rule - the rule

ignoreCase - the ignoreCase

Returns:

a KKCriteria.KKCriterion

getNewCriterion

public KKCriteria.KKCriterion getNewCriterion(java.lang.String table,
                                              java.lang.String column,
                                              java.lang.String value,
                                              java.lang.String preWildCard,
                                              java.lang.String postWildCard,
                                              int rule,
                                              boolean ignoreCase)

Method to return criterion object for a query

Parameters:

table - the table

column - full name of column (for example TABLE.COLUMN).

value - raw value (without any wildcards)

preWildCard - the preWildCard

postWildCard - the postWildCard

rule - the rule

ignoreCase - the ignoreCase

Returns:

A Criterion.

getNewCriterion

public KKCriteria.KKCriterion getNewCriterion(org.apache.torque.map.ColumnMap colMap,
                                              java.lang.Object value,
                                              org.apache.torque.criteria.SqlEnum comparison)

Method to return criterion that is not added automatically to this Criteria. This can be used to chain the Criterions to form a more complex where clause.

Parameters:

colMap - String full name of column (for example TABLE.COLUMN).

value - The value to compare to.

comparison - the comparison to use.

Returns:

A Criterion.

getNewCriterion

public KKCriteria.KKCriterion getNewCriterion(org.apache.torque.Column column,
                                              java.lang.Object value,
                                              org.apache.torque.criteria.SqlEnum comparison)

Method to return criterion that is not added automatically to this Criteria. This can be used to chain the Criterions to form a more complex where clause.

Overrides:

getNewCriterion in class org.apache.torque.util.Criteria

Parameters:

column - String full name of column (for example TABLE.COLUMN).

value - The value to compare to.

comparison - the comparison to use.

Returns:

A Criterion.

getNewKKCriterion

public KKCriteria.KKCriterion getNewKKCriterion(java.lang.String column,
                                                java.lang.Object value,
                                                org.apache.torque.criteria.SqlEnum comparison)

Method to return criterion that is not added automatically to this Criteria. This can be used to chain the Criterions to form a more complex where clause.

Parameters:

column - String full name of column (for example TABLE.COLUMN).

value - The value to compare to.

comparison - the comparison to use.

Returns:

A Criterion.

getNewKKCriterion

public KKCriteria.KKCriterion getNewKKCriterion(org.apache.torque.Column column,
                                                java.lang.Object value,
                                                org.apache.torque.criteria.SqlEnum comparison)

Method to return criterion that is not added automatically to this Criteria. This can be used to chain the Criterions to form a more complex where clause.

Parameters:

column - String full name of column (for example TABLE.COLUMN).

value - The value to compare to.

comparison - the comparison to use.

Returns:

A Criterion.

add

public org.apache.torque.util.Criteria add(org.apache.torque.util.Criteria.Criterion c)

Overrides:

add in class org.apache.torque.util.Criteria

addCriterionOrNull

public void addCriterionOrNull(org.apache.torque.map.ColumnMap col,
                               org.apache.torque.criteria.SqlEnum comparison,
                               java.lang.Object value)

Add a Criterion where a column is compared with a value OR is null

Parameters:

col - the col

comparison - the comparison

value - the value

getPeerImpl

public org.apache.torque.util.BasePeerImpl<?> getPeerImpl()

Returns:

the peerImpl

setPeerImpl

public void setPeerImpl(org.apache.torque.util.BasePeerImpl<?> peerImpl)

Parameters:

peerImpl - the peerImpl to set

add

public KKCriteria add(KKCriteria.KKCriterion c)

This method adds a prepared KKCriterion object to the KKCriteria. You can get a new, empty KKCriterion object with the getNewCriterion() method. If a criterion for the requested column already exists, it is replaced. This is used as follows:

KKCriteria crit = new KKCriteria(); KKCriteria.KKCriterion c = crit .getNewCriterion(XXXPeer.ID, new Integer(5), KKCriteria.LESS_THAN); crit.add(c);

Parameters:

c - A KKCriterion object

Returns:

A modified KKCriteria object.

getSelectColumns

public org.apache.torque.util.UniqueColumnList getSelectColumns()

Get select columns.

Specified by:

getSelectColumns in interface org.apache.torque.criteria.CriteriaInterface<org.apache.torque.util.Criteria>

Overrides:

getSelectColumns in class org.apache.torque.util.Criteria

Returns:

A List with the names of the select columns.

getColValues

public org.apache.torque.util.ColumnValues getColValues()

Returns:

the colValues

getValue

public java.lang.Object getValue(org.apache.torque.Column column)

Method to return the value that was added to Criteria.

Overrides:

getValue in class org.apache.torque.util.Criteria

Parameters:

column - The column to retrieve the value for.

Returns:

An Object with the value of object at key.

setDbName

public void setDbName(java.lang.String dbName)

Set the DatabaseMap name. If null is supplied, uses value provided by Torque.getDefaultDB().

Specified by:

setDbName in interface org.apache.torque.criteria.CriteriaInterface<org.apache.torque.util.Criteria>

Overrides:

setDbName in class org.apache.torque.util.Criteria

Parameters:

dbName - A String with the Database(Map) name.

getDbName

public java.lang.String getDbName()

Get the Database(Map) name.

Specified by:

getDbName in interface org.apache.torque.criteria.CriteriaInterface<org.apache.torque.util.Criteria>

Overrides:

getDbName in class org.apache.torque.util.Criteria

Returns:

A String with the Database(Map) name. By default, this is PoolBrokerService.DEFAULT.

setOffset

public org.apache.torque.util.Criteria setOffset(long offset)

Set offset.

Specified by:

setOffset in interface org.apache.torque.criteria.CriteriaInterface<org.apache.torque.util.Criteria>

Overrides:

setOffset in class org.apache.torque.util.Criteria

Parameters:

offset - An int with the value for offset.

Returns:

A modified Criteria object.

setLimit

public org.apache.torque.util.Criteria setLimit(int limit)

Set limit.

Specified by:

setLimit in interface org.apache.torque.criteria.CriteriaInterface<org.apache.torque.util.Criteria>

Overrides:

setLimit in class org.apache.torque.util.Criteria

Parameters:

limit - An int with the value for limit.

Returns:

A modified Criteria object.

setDistinct

public void setDistinct()

Adds "DISTINCT " to the SQL statement.

Specified by:

setDistinct in interface org.apache.torque.criteria.CriteriaInterface<org.apache.torque.util.Criteria>

Overrides:

setDistinct in class org.apache.torque.util.Criteria

getDisplayQuery

public java.lang.String getDisplayQuery()
                                 throws org.apache.torque.TorqueException

Returns:

the displayQuery

Throws:

org.apache.torque.TorqueException - an unexpected exception in Torque (the database layer)

getQueryString

public java.lang.String getQueryString()
                                throws org.apache.torque.TorqueException

Returns:

the Query String

Throws:

org.apache.torque.TorqueException - an unexpected exception in Torque (the database layer)

setDisplayQuery

public void setDisplayQuery(java.lang.String displayQuery)

Parameters:

displayQuery - the displayQuery to set

getType

public org.apache.torque.sql.Query.Type getType()

Returns:

the type

setType

public void setType(org.apache.torque.sql.Query.Type type)

Parameters:

type - the type to set

getFirstTablename

public java.lang.String getFirstTablename()

Returns:

the firstTablename

setFirstTablename

public void setFirstTablename(java.lang.String firstTablename)

Parameters:

firstTablename - the firstTablename to set

toString

public java.lang.String toString()

Build a string representation of the Criteria.

Overrides:

toString in class org.apache.torque.util.Criteria

Returns:

A String with the representation of the Criteria.

isLogInsertFailures

public boolean isLogInsertFailures()

Don't log insert failures at WARN level if false. Only log at DEBUG

Returns:

the logInsertFailures

setLogInsertFailures

public void setLogInsertFailures(boolean logInsertFailures)

Don't log insert failures at WARN level if false. Only log at DEBUG

Parameters:

logInsertFailures - the logInsertFailures to set