Class SQLTemplateDescriptor

java.lang.Object

org.apache.cayenne.map.QueryDescriptor

org.apache.cayenne.map.SQLTemplateDescriptor

All Implemented Interfaces:

ProjectNode, XMLSerializable

public class SQLTemplateDescriptor
extends QueryDescriptor

Since:

4.0

Field Summary

Fields

Modifier and Type	Field	Description
protected Map<String,String>	adapterSql
protected CapsStrategy	columnNamesCapitalization
protected Map<String,Integer>	prefetchesMap
protected String	sql

Fields inherited from class QueryDescriptor

cacheGroup, cacheStrategy, DATA_MAP_ROOT, dataMap, DB_ENTITY_ROOT, fetchingDataRows, JAVA_CLASS_ROOT, name, OBJ_ENTITY_ROOT, pageSize, PROCEDURE_ROOT, root, statementFetchSize

Constructor Summary

Constructors

Constructor	Description
SQLTemplateDescriptor()

Method Summary

Modifier and Type	Method	Description
void	addPrefetch(String prefetchPath, int semantics)	Adds single prefetch path with semantics to this query.
SQLTemplate<?>	buildQuery()	Assembles Cayenne query instance of appropriate type from this descriptor.
SQLTemplate<?>	buildQuery(Map<String,?> parameters)	Assembles Cayenne query instance of appropriate type from this descriptor, applying a map of named parameters to it.
void	encodeAsXML(XMLEncoder encoder, ProjectNodeVisitor<?> delegate)	Prints itself as XML to the provided XMLEncoder.
Map<String,String>	getAdapterSql()	Returns map of db adapter specific SQL statements.
CapsStrategy	getColumnNamesCapitalization()	Returns the capitalization strategy applied to the column names of the query result, or null if none is set.
Map<String,Integer>	getPrefetchesMap()	Returns map of prefetch paths with semantics for this query.
String	getSql()	Returns default SQL statement for this query.
void	removePrefetch(String prefetchPath)	Removes single prefetch path from this query.
void	setAdapterSql(Map<String,String> adapterSql)	Sets a map db adapter specific SQL statements for this query.
void	setColumnNamesCapitalization(CapsStrategy columnNamesCapitalization)
void	setPrefetchesMap(HashMap<String,Integer> prefetchesMap)	Sets map of prefetch paths with semantics for this query.
void	setSql(String sql)	Sets default SQL statement for this query.

Methods inherited from class QueryDescriptor

acceptVisitor, getCacheGroup, getCacheStrategy, getDataMap, getName, getPageSize, getRoot, getStatementFetchSize, isFetchingDataRows, setCacheGroup, setCacheStrategy, setDataMap, setFetchingDataRows, setName, setPageSize, setRoot, setStatementFetchSize

Methods inherited from class Object

clone, equals, finalize, getClass, hashCode, notify, notifyAll, toString, wait, wait, wait

Field Details

sql

protected String sql

prefetchesMap

protected Map<String,Integer> prefetchesMap

adapterSql

protected Map<String,String> adapterSql

columnNamesCapitalization

protected CapsStrategy columnNamesCapitalization

Constructor Details

SQLTemplateDescriptor

public SQLTemplateDescriptor()

Method Details

getSql

public String getSql()

Returns default SQL statement for this query.

setSql

public void setSql(String sql)

Sets default SQL statement for this query.

getAdapterSql

public Map<String,String> getAdapterSql()

Returns map of db adapter specific SQL statements.

setAdapterSql

public void setAdapterSql(Map<String,String> adapterSql)

Sets a map db adapter specific SQL statements for this query.

getColumnNamesCapitalization

public CapsStrategy getColumnNamesCapitalization()

Returns the capitalization strategy applied to the column names of the query result, or null if none is set.

Since:

5.0

setColumnNamesCapitalization

public void setColumnNamesCapitalization(CapsStrategy columnNamesCapitalization)

Since:

5.0

getPrefetchesMap

public Map<String,Integer> getPrefetchesMap()

Returns map of prefetch paths with semantics for this query.

Since:

4.1

setPrefetchesMap

public void setPrefetchesMap(HashMap<String,Integer> prefetchesMap)

Sets map of prefetch paths with semantics for this query.

Since:

4.1

addPrefetch

public void addPrefetch(String prefetchPath,
 int semantics)

Adds single prefetch path with semantics to this query.

Since:

4.1

removePrefetch

public void removePrefetch(String prefetchPath)

Removes single prefetch path from this query.

Since:

4.1

buildQuery

public SQLTemplate<?> buildQuery()

Description copied from class: QueryDescriptor

Assembles Cayenne query instance of appropriate type from this descriptor.

Specified by:

buildQuery in class QueryDescriptor

buildQuery

public SQLTemplate<?> buildQuery(Map<String,?> parameters)

Description copied from class: QueryDescriptor

Assembles Cayenne query instance of appropriate type from this descriptor, applying a map of named parameters to it.

Specified by:

buildQuery in class QueryDescriptor

Since:

5.0

encodeAsXML

public void encodeAsXML(XMLEncoder encoder,
 ProjectNodeVisitor<?> delegate)

Description copied from interface: XMLSerializable

Prints itself as XML to the provided XMLEncoder.