org.apache.turbine.util.db
Class Criteria.Criterion

java.lang.Object
  |
  +--org.apache.turbine.util.db.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
private  Criteria.Criterion and
          Another criterion connected to this one by an AND clause.
static java.lang.String AND
           
private  java.lang.String column
          Column name.
private  java.lang.String comparison
          Comparison value.
private  DB db
          The DB adaptor which might be used to get db specific variations of sql.
private  boolean ignoreStringCase
          flag to ignore case in comparision
private  Criteria.Criterion or
          Another Criterion connected to this one by an OR clause.
static java.lang.String OR
           
private  java.lang.String table
          Table name.
private  java.lang.Object value
          Value of the CO.
 
Constructor Summary
private Criteria.Criterion(java.lang.Object val, java.lang.String comp)
          Creates a new instance, initializing a couple members.
(package private) Criteria.Criterion(java.lang.String tableColumn, java.lang.Object val)
          Create a new instance.
(package private) Criteria.Criterion(java.lang.String tableColumn, java.lang.Object val, java.lang.String comp)
          Create a new instance.
(package private) Criteria.Criterion(java.lang.String table, java.lang.String column, java.lang.Object val)
          Create a new instance.
(package private) Criteria.Criterion(java.lang.String table, java.lang.String column, java.lang.Object val, java.lang.String comp)
          Create a new instance.
 
Method Summary
private  void addCriterionTable(Criteria.Criterion c, StringStackBuffer s)
           
 Criteria.Criterion and(Criteria.Criterion criterion)
          Append a Criteria onto this Criteria's AND field.
 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 to see if they contain the same attributes and hashtable entries.
 java.lang.String[] getAllTables()
           
 Criteria.Criterion getAnd()
          get the criterion from this Criterion's AND field.
 Criteria.Criterion[] getAttachedCriterion()
           
 java.lang.String getColumn()
          Get the column name.
 java.lang.String getComparison()
          Get the comparison.
 DB getDb()
          Get the value of db.
 Criteria.Criterion getOr()
          get the criterion from this Criterion's AND field.
 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 a Criterion onto this Criterion's OR field.
 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.
 java.lang.String toString()
          Build a string representation of the Criterion.
private  void traverseCriterion(Criteria.Criterion c, java.util.ArrayList a)
           
 
Methods inherited from class java.lang.Object
, clone, finalize, getClass, notify, notifyAll, registerNatives, wait, wait, wait
 

Field Detail

AND

public static final java.lang.String AND

OR

public static final java.lang.String OR

value

private java.lang.Object value
Value of the CO.

comparison

private java.lang.String comparison
Comparison value.

table

private java.lang.String table
Table name.

column

private java.lang.String column
Column name.

ignoreStringCase

private boolean ignoreStringCase
flag to ignore case in comparision

db

private DB db
The DB adaptor which might be used to get db specific variations of sql.

or

private Criteria.Criterion or
Another Criterion connected to this one by an OR clause.

and

private Criteria.Criterion and
Another criterion connected to this one by an AND clause.
Constructor Detail

Criteria.Criterion

private Criteria.Criterion(java.lang.Object val,
                           java.lang.String comp)
Creates a new instance, initializing a couple members.

Criteria.Criterion

Criteria.Criterion(java.lang.String table,
                   java.lang.String column,
                   java.lang.Object val,
                   java.lang.String comp)
Create a new instance.
Parameters:
table - A String with the name of the table.
column - A String with the name of the column.
val - An Object with the value for the Criteria.
comp - A String with the comparison value.

Criteria.Criterion

Criteria.Criterion(java.lang.String tableColumn,
                   java.lang.Object val,
                   java.lang.String comp)
Create a new instance.
Parameters:
tableColumn - A String with the full name of the column.
val - An Object with the value for the Criteria.
comp - A String with the comparison value.

Criteria.Criterion

Criteria.Criterion(java.lang.String table,
                   java.lang.String column,
                   java.lang.Object val)
Create a new instance.
Parameters:
table - A String with the name of the table.
column - A String with the name of the column.
val - An Object with the value for the Criteria.

Criteria.Criterion

Criteria.Criterion(java.lang.String tableColumn,
                   java.lang.Object val)
Create a new instance.
Parameters:
tableColumn - A String with the full name of the column.
val - An Object with the value for the Criteria.
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 java.lang.String 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.

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.

getAnd

public Criteria.Criterion getAnd()
get the criterion from this Criterion's AND field.

and

public Criteria.Criterion and(Criteria.Criterion criterion)
Append a Criteria onto this Criteria's AND field.

getOr

public Criteria.Criterion getOr()
get the criterion from this Criterion's AND field.

or

public Criteria.Criterion or(Criteria.Criterion criterion)
Append a Criterion onto this Criterion's OR field.

appendTo

public void appendTo(java.lang.StringBuffer sb)
Appends a representation of the Criterion onto the buffer.

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 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.lang.String[] getAllTables()

addCriterionTable

private void addCriterionTable(Criteria.Criterion c,
                               StringStackBuffer s)

getAttachedCriterion

public Criteria.Criterion[] getAttachedCriterion()

traverseCriterion

private void traverseCriterion(Criteria.Criterion c,
                               java.util.ArrayList a)


Copyright © 2000-2002 Apache Software Foundation. All Rights Reserved.