Class ProcedureQueryDescriptor

java.lang.Object

org.apache.cayenne.map.QueryDescriptor

org.apache.cayenne.map.ProcedureQueryDescriptor

All Implemented Interfaces:

ProjectNode, XMLSerializable

public class ProcedureQueryDescriptor
extends QueryDescriptor

Since:

4.0

Field Summary

Fields

Modifier and Type	Field	Description
protected CapsStrategy	columnNamesCapitalization
protected int	fetchLimit
protected int	fetchOffset
protected String	resultEntityName

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
ProcedureQueryDescriptor()

Method Summary

Modifier and Type	Method	Description
ProcedureQuery<?>	buildQuery()	Assembles Cayenne query instance of appropriate type from this descriptor.
ProcedureQuery<?>	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.
CapsStrategy	getColumnNamesCapitalization()	Returns the capitalization strategy applied to the column names of the query result, or null if none is set.
int	getFetchLimit()	Returns the fetch limit of the query.
int	getFetchOffset()	Returns the fetch offset of the query.
String	getResultEntityName()	Returns result entity name.
void	setColumnNamesCapitalization(CapsStrategy columnNamesCapitalization)
void	setFetchLimit(int fetchLimit)
void	setFetchOffset(int fetchOffset)
void	setResultEntityName(String resultEntityName)	Sets result entity name.

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

resultEntityName

protected String resultEntityName

fetchLimit

protected int fetchLimit

fetchOffset

protected int fetchOffset

columnNamesCapitalization

protected CapsStrategy columnNamesCapitalization

Constructor Details

ProcedureQueryDescriptor

public ProcedureQueryDescriptor()

Method Details

getResultEntityName

public String getResultEntityName()

Returns result entity name.

setResultEntityName

public void setResultEntityName(String resultEntityName)

Sets result entity name.

getFetchLimit

public int getFetchLimit()

Returns the fetch limit of the query. Zero means no limit.

Since:

5.0

setFetchLimit

public void setFetchLimit(int fetchLimit)

Since:

5.0

getFetchOffset

public int getFetchOffset()

Returns the fetch offset of the query.

Since:

5.0

setFetchOffset

public void setFetchOffset(int fetchOffset)

Since:

5.0

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

buildQuery

public ProcedureQuery<?> buildQuery()

Description copied from class: QueryDescriptor

Assembles Cayenne query instance of appropriate type from this descriptor.

Specified by:

buildQuery in class QueryDescriptor

buildQuery

public ProcedureQuery<?> 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.