org.apache.torque.util
Class Criteria.Criterion

java.lang.Object
  org.apache.torque.util.Criteria.Criterion

All Implemented Interfaces:

java.io.Serializable

Enclosing class:

Criteria

public final class Criteria.Criterion
extends java.lang.Object
implements java.io.Serializable

This is an inner class that describes an object in the criteria.

See Also:

Serialized Form

Field Summary

static java.lang.String	AND
static java.lang.String	OR

Method Summary

Criteria.Criterion	and(Criteria.Criterion criterion) Append an AND Criterion onto this Criterion's list.
void	appendPsTo(java.lang.StringBuffer sb, java.util.List params) Appends a Prepared Statement representation of the Criterion onto the buffer.
void	appendTo(java.lang.StringBuffer sb) Appends a representation of the Criterion onto the buffer.
boolean	equals(java.lang.Object obj) This method checks another Criteria.Criterion to see if they contain the same attributes and hashtable entries.
java.util.List	getAllTables() get all tables from nested criterion objects
Criteria.Criterion[]	getAttachedCriterion() get an array of all criterion attached to this recursing through all sub criterion
java.lang.String	getColumn() Get the column name.
SqlEnum	getComparison() Get the comparison.
DB	getDb() Get the value of db.
java.lang.String	getTable() Get the table name.
java.lang.Object	getValue() Get the value.
int	hashCode() Returns a hash code value for the object.
boolean	isIgnoreCase() Is ignore case on or off?
Criteria.Criterion	or(Criteria.Criterion criterion) Append an OR Criterion onto this Criterion's list.
void	setDB(DB v) Set the value of db.
Criteria.Criterion	setIgnoreCase(boolean b) Sets ignore case.
void	setTable(java.lang.String name) Set the table name.
void	setValue(java.lang.Object value) Set the value of the criterion.
java.lang.String	toString() Build a string representation of the Criterion.

Methods inherited from class java.lang.Object

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

Field Detail

AND

public static final java.lang.String AND

See Also:

Constant Field Values

OR

public static final java.lang.String OR

See Also:

Constant Field Values

Method Detail

getColumn

public java.lang.String getColumn()

Get the column name.

Returns:

A String with the column name.

setTable

public void setTable(java.lang.String name)

Set the table name.

Parameters:

name - A String with the table name.

getTable

public java.lang.String getTable()

Get the table name.

Returns:

A String with the table name.

getComparison

public SqlEnum getComparison()

Get the comparison.

Returns:

A String with the comparison.

getValue

public java.lang.Object getValue()

Get the value.

Returns:

An Object with the value.

setValue

public void setValue(java.lang.Object value)

Set the value of the criterion.

Parameters:

value - the new value.

getDb

public DB getDb()

Get the value of db. The DB adaptor which might be used to get db specific variations of sql.

Returns:

value of db.

setDB

public void setDB(DB v)

Set the value of db. The DB adaptor might be used to get db specific variations of sql.

Parameters:

v - Value to assign to db.

setIgnoreCase

public Criteria.Criterion setIgnoreCase(boolean b)

Sets ignore case.

Parameters:

b - True if case should be ignored.

Returns:

A modified Criteria object.

isIgnoreCase

public boolean isIgnoreCase()

Is ignore case on or off?

Returns:

True if case is ignored.

and

public Criteria.Criterion and(Criteria.Criterion criterion)

Append an AND Criterion onto this Criterion's list.

or

public Criteria.Criterion or(Criteria.Criterion criterion)

Append an OR Criterion onto this Criterion's list.

appendTo

public void appendTo(java.lang.StringBuffer sb)
              throws TorqueException

Appends a representation of the Criterion onto the buffer.

Throws:

TorqueException

appendPsTo

public void appendPsTo(java.lang.StringBuffer sb,
                       java.util.List params)

Appends a Prepared Statement representation of the Criterion onto the buffer.

Parameters:

sb - The stringbuffer that will receive the Prepared Statement

params - A list to which Prepared Statement parameters will be appended

toString

public java.lang.String toString()

Build a string representation of the Criterion.

Overrides:

toString in class java.lang.Object

Returns:

A String with the representation of the Criterion.

equals

public boolean equals(java.lang.Object obj)

This method checks another Criteria.Criterion to see if they contain the same attributes and hashtable entries.

Overrides:

equals in class java.lang.Object

hashCode

public int hashCode()

Returns a hash code value for the object.

Overrides:

hashCode in class java.lang.Object

getAllTables

public java.util.List getAllTables()

get all tables from nested criterion objects

Returns:

the list of tables

getAttachedCriterion

public Criteria.Criterion[] getAttachedCriterion()

get an array of all criterion attached to this recursing through all sub criterion