Criteria Class Reference
[Object queries API]

See also:
http://www.hibernate.org/hib_docs/v3/reference/en/html/querycriteria.html
More...

Inheritance diagram for Criteria:

Inheritance graph
[legend]

List of all members.

Public Member Functions

 __construct ($dao=null)
 __clone ()
 __sleep ()
 __wakeup ()
 getDao ()
 
Returns:
StorableDAO

 setDao (StorableDAO $dao)
 
Returns:
Criteria

 getLogic ()
 
Returns:
LogicalChain

 add (LogicalObject $logic)
 
Returns:
Criteria

 getOrder ()
 
Returns:
OrderChain

 addOrder ($order)
 
Returns:
Criteria

 dropOrder ()
 
Returns:
Criteria

 getLimit ()
 setLimit ($limit)
 
Returns:
Criteria

 getOffset ()
 setOffset ($offset)
 
Returns:
Criteria

 getFetchStrategy ()
 
Returns:
FetchStrategy

 setFetchStrategy (FetchStrategy $strategy)
 
Returns:
Criteria

 setProjection (ObjectProjection $chain)
 
Returns:
Criteria

 getProjection ()
 
Returns:
ProjectionChain

 dropProjection ()
 
Returns:
Criteria

 setDistinct ($orly=true)
 
Returns:
Criteria

 isDistinct ()
 isSilent ()
 setSilent ($silent)
 
Returns:
Criteria

 fetchCollection ($path, $lazy=false, $criteria=null)
 
Returns:
Criteria

 get ()
 getList ()
 getResult ()
 
Returns:
QueryResult

 getCustom ($index=null)
 getCustomList ()
 getPropertyList ()
 toString ()
 toDialectString (Dialect $dialect)
 toSelectQuery ()
 
Returns:
SelectQuery

 fillSelectQuery (SelectQuery $query)
 
Returns:
SelectQuery


Static Public Member Functions

static create ($dao=null)
 
Returns:
Criteria


Private Member Functions

 joinProperties (SelectQuery $query, ComplexBuilderDAO $parentDao, $parentTable, $parentRequired, $prefix=null)
 getProto ()
 
Returns:
AbstractProtoClass


Private Attributes

 $dao = null
 $daoClass = null
 $logic = null
 $order = null
 $strategy = null
 $projection = null
 $distinct = false
 $limit = null
 $offset = null
 $collections = array()
 $silent = true


Detailed Description

See also:
http://www.hibernate.org/hib_docs/v3/reference/en/html/querycriteria.html

Definition at line 18 of file Criteria.class.php.


Constructor & Destructor Documentation

Criteria::__construct ( dao = null  ) 

Definition at line 45 of file Criteria.class.php.

References $dao, Expression::andBlock(), Assert::isTrue(), and setDao().

Here is the call graph for this function:


Member Function Documentation

static Criteria::create ( dao = null  )  [static]

Returns:
Criteria

Definition at line 40 of file Criteria.class.php.

References $dao.

Criteria::__clone (  ) 

Definition at line 58 of file Criteria.class.php.

Criteria::__sleep (  ) 

Definition at line 64 of file Criteria.class.php.

Criteria::__wakeup (  ) 

Definition at line 73 of file Criteria.class.php.

References Singleton::getInstance().

Here is the call graph for this function:

Criteria::getDao (  ) 

Returns:
StorableDAO

Definition at line 81 of file Criteria.class.php.

Referenced by MappableObjectProjection::process(), and HavingProjection::process().

Criteria::setDao ( StorableDAO dao  ) 

Returns:
Criteria

Definition at line 89 of file Criteria.class.php.

References FetchStrategy::cascade(), and setFetchStrategy().

Referenced by __construct(), and UnifiedContainer::setCriteria().

Here is the call graph for this function:

Criteria::getLogic (  ) 

Returns:
LogicalChain

Definition at line 107 of file Criteria.class.php.

Criteria::add ( LogicalObject logic  ) 

Returns:
Criteria

Definition at line 115 of file Criteria.class.php.

References $logic.

Criteria::getOrder (  ) 

Returns:
OrderChain

Definition at line 125 of file Criteria.class.php.

Criteria::addOrder ( order  ) 

Returns:
Criteria

Definition at line 133 of file Criteria.class.php.

References $order.

Criteria::dropOrder (  ) 

Returns:
Criteria

Definition at line 146 of file Criteria.class.php.

Criteria::getLimit (  ) 

Definition at line 153 of file Criteria.class.php.

Criteria::setLimit ( limit  ) 

Returns:
Criteria

Definition at line 161 of file Criteria.class.php.

References $limit.

Criteria::getOffset (  ) 

Definition at line 168 of file Criteria.class.php.

Criteria::setOffset ( offset  ) 

Returns:
Criteria

Definition at line 176 of file Criteria.class.php.

References $offset.

Criteria::getFetchStrategy (  ) 

Returns:
FetchStrategy

Definition at line 186 of file Criteria.class.php.

Criteria::setFetchStrategy ( FetchStrategy strategy  ) 

Returns:
Criteria

Definition at line 194 of file Criteria.class.php.

References Assert::isTrue(), and FetchStrategy::JOIN.

Referenced by setDao().

Here is the call graph for this function:

Criteria::setProjection ( ObjectProjection chain  ) 

Returns:
Criteria

Definition at line 214 of file Criteria.class.php.

Criteria::getProjection (  ) 

Returns:
ProjectionChain

Definition at line 224 of file Criteria.class.php.

Referenced by toSelectQuery().

Criteria::dropProjection (  ) 

Returns:
Criteria

Definition at line 232 of file Criteria.class.php.

Criteria::setDistinct ( orly = true  ) 

Returns:
Criteria

Definition at line 242 of file Criteria.class.php.

Criteria::isDistinct (  ) 

Definition at line 249 of file Criteria.class.php.

Criteria::isSilent (  ) 

Definition at line 254 of file Criteria.class.php.

Referenced by get(), getCustom(), getCustomList(), getList(), getPropertyList(), and getResult().

Criteria::setSilent ( silent  ) 

Returns:
Criteria

Definition at line 262 of file Criteria.class.php.

References $silent.

Criteria::fetchCollection ( path,
lazy = false,
criteria = null 
)

Returns:
Criteria

Definition at line 274 of file Criteria.class.php.

References Assert::isTrue().

Here is the call graph for this function:

Criteria::get (  ) 

Definition at line 294 of file Criteria.class.php.

References isSilent().

Here is the call graph for this function:

Criteria::getList (  ) 

Definition at line 313 of file Criteria.class.php.

References isSilent(), and toSelectQuery().

Here is the call graph for this function:

Criteria::getResult (  ) 

Returns:
QueryResult

Definition at line 333 of file Criteria.class.php.

References isSilent(), and toSelectQuery().

Here is the call graph for this function:

Criteria::getCustom ( index = null  ) 

Definition at line 355 of file Criteria.class.php.

References isSilent(), and toSelectQuery().

Here is the call graph for this function:

Criteria::getCustomList (  ) 

Definition at line 376 of file Criteria.class.php.

References isSilent(), and toSelectQuery().

Here is the call graph for this function:

Criteria::getPropertyList (  ) 

Definition at line 388 of file Criteria.class.php.

References isSilent(), and toSelectQuery().

Referenced by joinProperties().

Here is the call graph for this function:

Criteria::toString (  ) 

Implements Stringable.

Definition at line 400 of file Criteria.class.php.

References DBPool::getByDao(), ImaginaryDialect::me(), and toDialectString().

Here is the call graph for this function:

Criteria::toDialectString ( Dialect dialect  ) 

Implements DialectString.

Definition at line 409 of file Criteria.class.php.

References toSelectQuery().

Referenced by toString().

Here is the call graph for this function:

Criteria::toSelectQuery (  ) 

Returns:
SelectQuery

Definition at line 417 of file Criteria.class.php.

References fillSelectQuery(), getProjection(), Assert::isNotNull(), and OSQL::select().

Referenced by getCustom(), getCustomList(), getList(), getPropertyList(), getResult(), and toDialectString().

Here is the call graph for this function:

Criteria::fillSelectQuery ( SelectQuery query  ) 

Returns:
SelectQuery

Definition at line 436 of file Criteria.class.php.

References SelectQuery::distinct(), FetchStrategy::JOIN, joinProperties(), and SelectQuery::setOrderChain().

Referenced by toSelectQuery().

Here is the call graph for this function:

Criteria::joinProperties ( SelectQuery query,
ComplexBuilderDAO parentDao,
parentTable,
parentRequired,
prefix = null 
) [private]

Definition at line 466 of file Criteria.class.php.

References $logic, FetchStrategy::CASCADE, DBField::create(), Expression::eq(), SelectQuery::get(), getPropertyList(), SelectQuery::join(), SelectQuery::leftJoin(), and MetaRelation::ONE_TO_ONE.

Referenced by fillSelectQuery().

Here is the call graph for this function:

Criteria::getProto (  )  [private]

Returns:
AbstractProtoClass

Definition at line 545 of file Criteria.class.php.


Member Data Documentation

Criteria::$dao = null [private]

Definition at line 20 of file Criteria.class.php.

Referenced by __construct(), and create().

Criteria::$daoClass = null [private]

Definition at line 21 of file Criteria.class.php.

Criteria::$logic = null [private]

Definition at line 22 of file Criteria.class.php.

Referenced by add(), and joinProperties().

Criteria::$order = null [private]

Definition at line 23 of file Criteria.class.php.

Referenced by addOrder().

Criteria::$strategy = null [private]

Definition at line 24 of file Criteria.class.php.

Criteria::$projection = null [private]

Definition at line 25 of file Criteria.class.php.

Criteria::$distinct = false [private]

Definition at line 27 of file Criteria.class.php.

Criteria::$limit = null [private]

Definition at line 29 of file Criteria.class.php.

Referenced by setLimit().

Criteria::$offset = null [private]

Definition at line 30 of file Criteria.class.php.

Referenced by setOffset().

Criteria::$collections = array() [private]

Definition at line 32 of file Criteria.class.php.

Criteria::$silent = true [private]

Definition at line 35 of file Criteria.class.php.

Referenced by setSilent().


The documentation for this class was generated from the following file:
Generated on Sun Dec 9 21:57:09 2007 for onPHP by  doxygen 1.5.4