Package org.apache.cayenne.map
Class Procedure
- java.lang.Object
-
- org.apache.cayenne.map.Procedure
-
- All Implemented Interfaces:
Serializable,ConfigurationNode,CayenneMapEntry,XMLSerializable
public class Procedure extends Object implements ConfigurationNode, CayenneMapEntry, XMLSerializable, Serializable
A mapping descriptor for a database stored procedure.- See Also:
- Serialized Form
-
-
Field Summary
Fields Modifier and Type Field Description protected List<ProcedureParameter>callParametersprotected Stringcatalogprotected DataMapdataMapprotected Stringnameprotected booleanreturningValueprotected Stringschema
-
Method Summary
All Methods Static Methods Instance Methods Concrete Methods Modifier and Type Method Description <T> TacceptVisitor(ConfigurationNodeVisitor<T> visitor)voidaddCallParameter(ProcedureParameter param)Adds new call parameter to the stored procedure.voidclearCallParameters()voidencodeAsXML(XMLEncoder encoder, ConfigurationNodeVisitor delegate)Prints itself as XML to the provided XMLEncoder.static StringgenerateFullyQualifiedName(String catalog, String schema, String name)Utility function to generate fully qualified name for procedureList<ProcedureParameter>getCallOutParameters()Returns a list of OUT and INOUT call parameters.List<ProcedureParameter>getCallParameters()Returns an unmodifiable list of call parameters.StringgetCatalog()DataMapgetDataMap()StringgetFullyQualifiedName()Returns procedure name including schema and catalog, if present.StringgetName()Returns the name property of this object.ObjectgetParent()Returns the parent map.ProcedureParametergetResultParam()Returns parameter describing the return value of the StoredProcedure, or null if procedure does not support return values.StringgetSchema()booleanisReturningValue()Returnstrueif a stored procedure returns a value.voidremoveCallParameter(String name)Removes a named call parameter.voidsetCallParameters(List<ProcedureParameter> parameters)voidsetCatalog(String string)Sets stored procedure's catalog.voidsetDataMap(DataMap dataMap)Sets parent DataMap of this entity.voidsetName(String name)voidsetParent(Object parent)Stores the parent map.voidsetReturningValue(boolean returningValue)voidsetSchema(String string)Sets stored procedure's database schema.
-
-
-
Constructor Detail
-
Procedure
public Procedure()
Creates an unnamed procedure object.
-
Procedure
public Procedure(String name)
Creates a named Procedure object.
-
-
Method Detail
-
acceptVisitor
public <T> T acceptVisitor(ConfigurationNodeVisitor<T> visitor)
- Specified by:
acceptVisitorin interfaceConfigurationNode- Since:
- 3.1
-
getName
public String getName()
Description copied from interface:CayenneMapEntryReturns the name property of this object.- Specified by:
getNamein interfaceCayenneMapEntry- Returns:
- name of this entry.
-
setName
public void setName(String name)
-
getParent
public Object getParent()
Description copied from interface:CayenneMapEntryReturns the parent map.- Specified by:
getParentin interfaceCayenneMapEntry
-
setParent
public void setParent(Object parent)
Description copied from interface:CayenneMapEntryStores the parent map.- Specified by:
setParentin interfaceCayenneMapEntry
-
encodeAsXML
public void encodeAsXML(XMLEncoder encoder, ConfigurationNodeVisitor delegate)
Prints itself as XML to the provided XMLEncoder.- Specified by:
encodeAsXMLin interfaceXMLSerializable- Since:
- 1.1
-
getFullyQualifiedName
public String getFullyQualifiedName()
Returns procedure name including schema and catalog, if present.
-
generateFullyQualifiedName
public static String generateFullyQualifiedName(String catalog, String schema, String name)
Utility function to generate fully qualified name for procedure
-
getDataMap
public DataMap getDataMap()
- Returns:
- parent DataMap of this entity.
-
setDataMap
public void setDataMap(DataMap dataMap)
Sets parent DataMap of this entity.
-
setCallParameters
public void setCallParameters(List<ProcedureParameter> parameters)
-
addCallParameter
public void addCallParameter(ProcedureParameter param)
Adds new call parameter to the stored procedure. Also setsparam's parent to be this procedure.
-
removeCallParameter
public void removeCallParameter(String name)
Removes a named call parameter.
-
clearCallParameters
public void clearCallParameters()
-
getCallParameters
public List<ProcedureParameter> getCallParameters()
Returns an unmodifiable list of call parameters.
-
getCallOutParameters
public List<ProcedureParameter> getCallOutParameters()
Returns a list of OUT and INOUT call parameters. If procedure has a return value, it will also be included as a call parameter.
-
getResultParam
public ProcedureParameter getResultParam()
Returns parameter describing the return value of the StoredProcedure, or null if procedure does not support return values. If procedure supports return parameters, its first parameter is always assumed to be a return result.
-
isReturningValue
public boolean isReturningValue()
Returnstrueif a stored procedure returns a value. The first parameter in a list of parameters will be assumed to be a descriptor of return value.- Returns:
- boolean
-
setReturningValue
public void setReturningValue(boolean returningValue)
-
getCatalog
public String getCatalog()
-
getSchema
public String getSchema()
-
setCatalog
public void setCatalog(String string)
Sets stored procedure's catalog.
-
setSchema
public void setSchema(String string)
Sets stored procedure's database schema.
-
-