|
|||||||||
PREV CLASS NEXT CLASS | FRAMES NO FRAMES | ||||||||
SUMMARY: NESTED | FIELD | CONSTR | METHOD | DETAIL: FIELD | CONSTR | METHOD |
public interface Query
represents Queries that can be used by the OJB PersistenceBroker to retrieve Objects from the underlying DB. Until now there are two implementations: 1. QueryByCriteria, represents SELECT * FROM ... WHERE ... queries 2. QueryByIdentity, uses Example objects or OIDs as templates for the db lookup there could additional implementations, e.g for user defined SQL For the Criteria API I reused code from the COBRA project, as you will see by their class comments. I removed all stuff that relies on knowlegde of the DataDictionary or MetaData layer. The Query and Criteria classes thus don't know how to build SQL statements, as in the COBRA original sources. I use the this classes as mere data-structures, that are processed by the OJB Accesslayer (SqlGenerator, JdbcAccess). This design will allow to reuse the org.apache.ojb.broker.query package in other projects without breaking any references. I hope this will be useful for someone.
Field Summary | |
---|---|
static int |
NO_END_AT_INDEX
|
static int |
NO_START_AT_INDEX
|
static boolean |
NOT_SCROLLABLE
|
static boolean |
SCROLLABLE
|
static long |
serialVersionUID
|
Method Summary | |
---|---|
int |
fullSize()
Deprecated. use OJBIterator.fullSize() |
void |
fullSize(int size)
Deprecated. |
java.lang.Class |
getBaseClass()
return the base class, with respect to which all paths are done |
Criteria |
getCriteria()
return the criteria of the query if present or null. |
int |
getEndAtIndex()
|
java.lang.Object |
getExampleObject()
return the template Object if present or null |
int |
getFetchSize()
Returns the fetchSize hint for this Query |
java.util.List |
getGroupBy()
Gets the groupby for ReportQueries of all Criteria and Sub Criteria the elements are of class FieldHelper |
Criteria |
getHavingCriteria()
return the criteria of the query if present or null. |
java.util.List |
getOrderBy()
Answer the orderBy of all Criteria and Sub Criteria the elements are of class FieldHelper |
java.util.List |
getPrefetchedRelationships()
Returns the names of Relationships to be prefetched |
java.lang.Class |
getSearchClass()
return the target class, representing the extend to be searched |
int |
getStartAtIndex()
|
boolean |
getWithExtents()
|
boolean |
isDistinct()
return true if select DISTINCT should be used |
void |
setEndAtIndex(int endAtIndex)
Set the row at which the query should stop retrieving results, inclusive. |
void |
setFetchSize(int fetchSize)
Set fetchSize hint for this Query. |
void |
setStartAtIndex(int startAtIndex)
Set the row at which the query should start retrieving results, inclusive first row is 1 |
void |
setWithExtents(boolean withExtents)
|
boolean |
usePaging()
Answer true if start- and endIndex is set |
Field Detail |
---|
static final long serialVersionUID
static final int NO_START_AT_INDEX
static final int NO_END_AT_INDEX
static final boolean SCROLLABLE
static final boolean NOT_SCROLLABLE
Method Detail |
---|
Criteria getCriteria()
Criteria getHavingCriteria()
java.lang.Object getExampleObject()
java.lang.Class getSearchClass()
java.lang.Class getBaseClass()
boolean isDistinct()
java.util.List getOrderBy()
java.util.List getGroupBy()
int getStartAtIndex()
void setStartAtIndex(int startAtIndex)
startAtIndex
- starting index, inclusive.int getEndAtIndex()
void setEndAtIndex(int endAtIndex)
endAtIndex
- ending index, inclusivejava.util.List getPrefetchedRelationships()
void fullSize(int size)
size
- int fullSize()
void setWithExtents(boolean withExtents)
boolean getWithExtents()
boolean usePaging()
void setFetchSize(int fetchSize)
fetchSize
- the fetch size specific to this queryint getFetchSize()
|
|||||||||
PREV CLASS NEXT CLASS | FRAMES NO FRAMES | ||||||||
SUMMARY: NESTED | FIELD | CONSTR | METHOD | DETAIL: FIELD | CONSTR | METHOD |