|
|||||||||
PREV CLASS NEXT CLASS | FRAMES NO FRAMES | ||||||||
SUMMARY: NESTED | FIELD | CONSTR | METHOD | DETAIL: FIELD | CONSTR | METHOD |
java.lang.Objectorg.apache.ojb.broker.metadata.ProcedureDescriptor
org.apache.ojb.broker.metadata.InsertProcedureDescriptor
public class InsertProcedureDescriptor
An InsertProcedureDescriptor contains information that is related to the
procedure/function that is used to handle the insertion of new records.
Note: Be careful when use InsertProcedureDescriptor variables or caching
InsertProcedureDescriptor instances, because instances could become invalid
during runtime (see MetadataManager
).
Field Summary |
---|
Constructor Summary | |
---|---|
InsertProcedureDescriptor(ClassDescriptor classDescriptor,
java.lang.String name,
boolean includeAllFields)
Constructor declaration |
Method Summary | |
---|---|
void |
addArgument(ArgumentDescriptor argument)
Add an argument |
void |
addAttribute(java.lang.String attributeName,
java.lang.String attributeValue)
Store the specified attribute and it's value. |
java.lang.String |
getAttribute(java.lang.String attributeName)
Get the value of an attribute |
java.lang.String |
getAttribute(java.lang.String attributeName,
java.lang.String defaultValue)
Get the value of an attribute |
java.lang.String[] |
getAttributeNames()
Returns an array of the names of all atributes of this descriptor. |
java.util.Map |
getAttributes()
Returns the attribute map (name, value) of this descriptor. |
boolean |
getIncludeAllFields()
Retrieve the value that indicates if the argument list for this procedure includes all field-descriptors from the related class-descriptor. |
java.lang.String |
toString()
Provide a string representation of this object |
java.lang.String |
toXML()
returns the XML marshalled version of this instance. |
Methods inherited from class org.apache.ojb.broker.metadata.ProcedureDescriptor |
---|
getArgumentCount, getArguments, getClassDescriptor, getName, getReturnValueFieldRef, getReturnValueFieldRefName, hasReturnValue, hasReturnValues, setReturnValueFieldRef, setReturnValueFieldRef |
Methods inherited from class java.lang.Object |
---|
equals, getClass, hashCode, notify, notifyAll, wait, wait, wait |
Constructor Detail |
---|
public InsertProcedureDescriptor(ClassDescriptor classDescriptor, java.lang.String name, boolean includeAllFields)
Method Detail |
---|
public boolean getIncludeAllFields()
public final void addArgument(ArgumentDescriptor argument)
The argument will be added only if this procedure is not configured
to include all arguments
.
public java.lang.String toXML()
XmlCapable
toXML
in interface XmlCapable
toXML
in class ProcedureDescriptor
public java.lang.String toString()
public void addAttribute(java.lang.String attributeName, java.lang.String attributeValue)
AttributeContainer
addAttribute
in interface AttributeContainer
attributeName
- the name of the attribute to retrieveattributeValue
- the attribute's valueAttributeContainer.addAttribute(String, String)
public java.lang.String getAttribute(java.lang.String attributeName, java.lang.String defaultValue)
AttributeContainer
getAttribute
in interface AttributeContainer
attributeName
- the attribute to retrievedefaultValue
- the value to return if the attribute is not present
AttributeContainer.getAttribute(String, String)
public java.lang.String getAttribute(java.lang.String attributeName)
AttributeContainer
getAttribute
in interface AttributeContainer
attributeName
- the attribute to retrieve
AttributeContainer.getAttribute(String)
public java.util.Map getAttributes()
public java.lang.String[] getAttributeNames()
null
)
|
|||||||||
PREV CLASS NEXT CLASS | FRAMES NO FRAMES | ||||||||
SUMMARY: NESTED | FIELD | CONSTR | METHOD | DETAIL: FIELD | CONSTR | METHOD |