|
|||||||||
PREV CLASS NEXT CLASS | FRAMES NO FRAMES | ||||||||
SUMMARY: NESTED | FIELD | CONSTR | METHOD | DETAIL: FIELD | CONSTR | METHOD |
java.lang.Objectorg.apache.cayenne.map.QueryBuilder
public abstract class QueryBuilder
A builder that constructs Cayenne queries from abstract configuration information defined in cayenne-data-map*.dtd. This abstract builder supports values declared in the DTD, allowing subclasses to define their own Query creation logic.
Field Summary | |
---|---|
protected java.util.Map |
adapterSql
|
static java.lang.String |
DATA_MAP_ROOT
|
protected DataMap |
dataMap
|
static java.lang.String |
DB_ENTITY_ROOT
|
static java.lang.String |
JAVA_CLASS_ROOT
|
protected java.lang.String |
name
|
static java.lang.String |
OBJ_ENTITY_ROOT
|
protected java.util.List |
orderings
|
protected java.util.List |
prefetches
|
static java.lang.String |
PROCEDURE_ROOT
|
protected java.util.Map |
properties
|
protected Expression |
qualifier
|
protected java.util.List |
resultColumns
|
protected java.lang.String |
resultEntity
|
protected java.lang.String |
rootName
|
protected java.lang.String |
rootType
|
protected boolean |
selecting
Deprecated. since 1.2 as "selecting" query property is no longer relevant. |
protected java.lang.String |
sql
|
Constructor Summary | |
---|---|
QueryBuilder()
|
Method Summary | |
---|---|
void |
addOrdering(java.lang.String path,
java.lang.String descending,
java.lang.String ignoreCase)
|
void |
addPrefetch(java.lang.String path)
|
void |
addProperty(java.lang.String name,
java.lang.String value)
|
void |
addResultColumn(java.lang.String label,
java.lang.String dbType,
java.lang.String objectType)
Deprecated. since 1.2 unused. |
void |
addSql(java.lang.String sql,
java.lang.String adapterClass)
Adds raw sql. |
abstract Query |
getQuery()
Builds a Query object based on internal configuration information. |
protected java.lang.Object |
getRoot()
Determines query root based on configuration info, falls back to a DataMap root if the data is invalid. |
void |
setName(java.lang.String name)
|
void |
setQualifier(java.lang.String qualifier)
|
void |
setResultEntity(java.lang.String resultEntity)
|
void |
setResultType(java.lang.String resultType)
Deprecated. since 1.2 |
void |
setRoot(DataMap dataMap,
java.lang.String rootType,
java.lang.String rootName)
Sets the information pertaining to the root of the query. |
void |
setSelecting(java.lang.String selecting)
Deprecated. since 1.2 as "selecting" query property is no longer relevant. |
Methods inherited from class java.lang.Object |
---|
clone, equals, finalize, getClass, hashCode, notify, notifyAll, toString, wait, wait, wait |
Field Detail |
---|
public static final java.lang.String OBJ_ENTITY_ROOT
public static final java.lang.String DB_ENTITY_ROOT
public static final java.lang.String PROCEDURE_ROOT
public static final java.lang.String DATA_MAP_ROOT
public static final java.lang.String JAVA_CLASS_ROOT
protected java.lang.String name
protected java.util.Map properties
protected java.util.List resultColumns
protected java.lang.String sql
protected java.util.Map adapterSql
protected Expression qualifier
protected java.util.List orderings
protected java.util.List prefetches
protected DataMap dataMap
protected java.lang.String rootType
protected java.lang.String rootName
protected boolean selecting
protected java.lang.String resultEntity
Constructor Detail |
---|
public QueryBuilder()
Method Detail |
---|
public abstract Query getQuery()
public void setName(java.lang.String name)
protected java.lang.Object getRoot()
CayenneRuntimeException
- if a valid root can't be established.public void setSelecting(java.lang.String selecting)
public void setResultType(java.lang.String resultType)
public void setResultEntity(java.lang.String resultEntity)
public void setRoot(DataMap dataMap, java.lang.String rootType, java.lang.String rootName)
public void addSql(java.lang.String sql, java.lang.String adapterClass)
public void setQualifier(java.lang.String qualifier)
public void addProperty(java.lang.String name, java.lang.String value)
public void addResultColumn(java.lang.String label, java.lang.String dbType, java.lang.String objectType)
public void addOrdering(java.lang.String path, java.lang.String descending, java.lang.String ignoreCase)
public void addPrefetch(java.lang.String path)
|
|||||||||
PREV CLASS NEXT CLASS | FRAMES NO FRAMES | ||||||||
SUMMARY: NESTED | FIELD | CONSTR | METHOD | DETAIL: FIELD | CONSTR | METHOD |