Package org.apache.cayenne.map
Class ProcedureParameter
java.lang.Object
org.apache.cayenne.map.ProcedureParameter
- All Implemented Interfaces:
- Serializable,- ConfigurationNode,- CayenneMapEntry,- XMLSerializable
public class ProcedureParameter extends Object implements ConfigurationNode, CayenneMapEntry, XMLSerializable, Serializable
A descriptor for the Procedure parameter.
- See Also:
- Serialized Form
- 
Field SummaryFields Modifier and Type Field Description protected intdirectionstatic intIN_OUT_PARAMETERstatic intIN_PARAMETERprotected intmaxLengthprotected Stringnamestatic intOUT_PARAMETERprotected intprecisionprotected Procedureprocedureprotected inttype
- 
Constructor SummaryConstructors Constructor Description ProcedureParameter()Creates unnamed ProcedureParameter.ProcedureParameter(String name)ProcedureParameter(String name, int type, int direction)
- 
Method SummaryModifier and Type Method Description <T> TacceptVisitor(ConfigurationNodeVisitor<T> visitor)voidencodeAsXML(XMLEncoder encoder, ConfigurationNodeVisitor delegate)Prints itself as XML to the provided PrintWriter.intgetDirection()Returns the direction of this parameter.intgetMaxLength()StringgetName()Returns the name property of this object.ObjectgetParent()Returns the parent map.intgetPrecision()ProceduregetProcedure()Returns the procedure that holds this parameter.intgetType()booleanisInParameter()booleanisOutParam()voidsetDirection(int direction)Sets the direction of this parameter.voidsetMaxLength(int i)voidsetName(String name)voidsetParent(Object parent)Stores the parent map.voidsetPrecision(int i)voidsetProcedure(Procedure procedure)Sets the procedure that holds this parameter.voidsetType(int i)
- 
Field Details- 
IN_OUT_PARAMETERpublic static final int IN_OUT_PARAMETER- See Also:
- Constant Field Values
 
- 
IN_PARAMETERpublic static final int IN_PARAMETER- See Also:
- Constant Field Values
 
- 
OUT_PARAMETERpublic static final int OUT_PARAMETER- See Also:
- Constant Field Values
 
- 
name
- 
procedure
- 
directionprotected int direction
- 
maxLengthprotected int maxLength
- 
precisionprotected int precision
- 
typeprotected int type
 
- 
- 
Constructor Details- 
ProcedureParameterpublic ProcedureParameter()Creates unnamed ProcedureParameter.
- 
ProcedureParameter
- 
ProcedureParameter
 
- 
- 
Method Details- 
acceptVisitor- Specified by:
- acceptVisitorin interface- ConfigurationNode
 
- 
getNameDescription copied from interface:CayenneMapEntryReturns the name property of this object.- Specified by:
- getNamein interface- CayenneMapEntry
- Returns:
- name of this entry.
 
- 
setName
- 
getParentDescription copied from interface:CayenneMapEntryReturns the parent map.- Specified by:
- getParentin interface- CayenneMapEntry
 
- 
setParentDescription copied from interface:CayenneMapEntryStores the parent map.- Specified by:
- setParentin interface- CayenneMapEntry
 
- 
encodeAsXMLPrints itself as XML to the provided PrintWriter.- Specified by:
- encodeAsXMLin interface- XMLSerializable
- Since:
- 1.1
 
- 
getDirectionpublic int getDirection()Returns the direction of this parameter. Possible values can be IN_PARAMETER, OUT_PARAMETER, IN_OUT_PARAMETER, VOID_PARAMETER.
- 
getMaxLengthpublic int getMaxLength()
- 
getPrecisionpublic int getPrecision()
- 
getTypepublic int getType()
- 
isInParameterpublic boolean isInParameter()- Returns:
- trueif this is IN or INOUT parameter.
 
- 
isOutParampublic boolean isOutParam()- Returns:
- trueif this is OUT or INOUT parameter.
 
- 
setDirectionpublic void setDirection(int direction)Sets the direction of this parameter. Acceptable values of direction are defined as int constants in ProcedureParam class. If an attempt is made to set an invalid attribute's direction, an IllegalArgumentException is thrown by this method.
- 
setMaxLengthpublic void setMaxLength(int i)
- 
setPrecisionpublic void setPrecision(int i)
- 
setTypepublic void setType(int i)
- 
getProcedureReturns the procedure that holds this parameter.
- 
setProcedureSets the procedure that holds this parameter.
 
-