org.apache.ojb.broker.metadata
Class ProcedureDescriptor

java.lang.Object
  org.apache.ojb.broker.metadata.ProcedureDescriptor

All Implemented Interfaces:

Serializable, AttributeContainer

Direct Known Subclasses:

DeleteProcedureDescriptor, InsertProcedureDescriptor, UpdateProcedureDescriptor

public abstract class ProcedureDescriptor
extends Object
implements Serializable

A ProcedureDescriptor contains information that is common for all types of procedures/functions that are used to handle the persistence operations.
Note: Be careful when use ProcedureDescriptor variables or caching ProcedureDescriptor instances, because instances could become invalid during runtime (see MetadataManager).

Version:

$Id: ProcedureDescriptor.java,v 1.1 2007-08-24 22:17:29 ewestfal Exp $

Author:

Ron Gallagher

See Also:

Serialized Form

Constructor Summary

ProcedureDescriptor(ClassDescriptor classDescriptor, String name)
Constructor declaration

Method Summary

protected void	addArgument(ArgumentDescriptor argument) Add an argument
protected void	addArguments(FieldDescriptor[] field) Set up arguments for each FieldDescriptor in an array.
void	addAttribute(String attributeName, String attributeValue) Store the specified attribute and it's value.
int	getArgumentCount() Retrieves the number of arguments that are passed to the procedure that this descriptor represents.
Collection	getArguments() Get the argument descriptors for this procedure.
String	getAttribute(String attributeName) Get the value of an attribute
String	getAttribute(String attributeName, String defaultValue) Get the value of an attribute
String[]	getAttributeNames() Returns an array of the names of all atributes of this descriptor.
Map	getAttributes() Returns the attribute map (name, value) of this descriptor.
ClassDescriptor	getClassDescriptor() Retrieve the class descriptor that this object is related to.
String	getName() Retrieve the the name of the procedure/function to invoke.
FieldDescriptor	getReturnValueFieldRef() Retrieve the field descriptor that will receive the return value from the procedure/function...
String	getReturnValueFieldRefName() Retrieve the name of the field descriptor that will receive the return value from the procedure/function...
boolean	hasReturnValue() Is there a return value for this procedure?
boolean	hasReturnValues() Does this procedure return any values to the 'caller'?
void	setReturnValueFieldRef(FieldDescriptor fieldDescriptor) Change the the field descriptor that will receive the return value from the procedure/function...
void	setReturnValueFieldRef(String fieldName) Change the field descriptor that will receive the return value from the procedure/function..
String	toString()
abstract String	toXML()

Methods inherited from class java.lang.Object

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

Constructor Detail

ProcedureDescriptor

public ProcedureDescriptor(ClassDescriptor classDescriptor,
                           String name)

Constructor declaration

Method Detail

getName

public final String getName()

Retrieve the the name of the procedure/function to invoke.

Returns:

The current value

setReturnValueFieldRef

public final void setReturnValueFieldRef(String fieldName)

Change the field descriptor that will receive the return value from the procedure/function..

Parameters:

fieldName - the name of the field that will receive the return value from the procedure/function.

setReturnValueFieldRef

public final void setReturnValueFieldRef(FieldDescriptor fieldDescriptor)

Change the the field descriptor that will receive the return value from the procedure/function...

Parameters:

fieldDescriptor - the field descriptor that will receive the return value from the procedure/function.

getReturnValueFieldRef

public final FieldDescriptor getReturnValueFieldRef()

Retrieve the field descriptor that will receive the return value from the procedure/function...

Returns:

The current value

hasReturnValue

public final boolean hasReturnValue()

Is there a return value for this procedure?

Returns:

true if there is a return value for this procedure.

hasReturnValues

public final boolean hasReturnValues()

Does this procedure return any values to the 'caller'?

Returns:

true if the procedure returns at least 1 value that is returned to the caller.

getReturnValueFieldRefName

public final String getReturnValueFieldRefName()

Retrieve the name of the field descriptor that will receive the return value from the procedure/function...

Returns:

The current value

getClassDescriptor

public final ClassDescriptor getClassDescriptor()

Retrieve the class descriptor that this object is related to.

Returns:

The current value

toXML

public abstract String toXML()

addArgument

protected void addArgument(ArgumentDescriptor argument)

Add an argument

addArguments

protected void addArguments(FieldDescriptor[] field)

Set up arguments for each FieldDescriptor in an array.

getArguments

public final Collection getArguments()

Get the argument descriptors for this procedure.

getArgumentCount

public final int getArgumentCount()

Retrieves the number of arguments that are passed to the procedure that this descriptor represents.

Note: The value returned by this method does not reflect the presence of any return value for the procedure

addAttribute

public void addAttribute(String attributeName,
                         String attributeValue)

Description copied from interface: AttributeContainer

Store the specified attribute and it's value.

Specified by:

addAttribute in interface AttributeContainer

Parameters:

attributeName - the name of the attribute to retrieve

attributeValue - the attribute's value

See Also:

AttributeContainer.addAttribute(String, String)

getAttribute

public String getAttribute(String attributeName,
                           String defaultValue)

Description copied from interface: AttributeContainer

Get the value of an attribute

Specified by:

getAttribute in interface AttributeContainer

Parameters:

attributeName - the attribute to retrieve

defaultValue - the value to return if the attribute is not present

Returns:

the attribute value

See Also:

AttributeContainer.getAttribute(String, String)

getAttribute

public String getAttribute(String attributeName)

Description copied from interface: AttributeContainer

Get the value of an attribute

Specified by:

getAttribute in interface AttributeContainer

Parameters:

attributeName - the attribute to retrieve

Returns:

the attribute value

See Also:

AttributeContainer.getAttribute(String)

getAttributes

public Map getAttributes()

Returns the attribute map (name, value) of this descriptor. Note that the returned map is not modifiable.

Returns:

The attributes

getAttributeNames

public String[] getAttributeNames()

Returns an array of the names of all atributes of this descriptor.

Returns:

The list of attribute names (will not be null)

toString

public String toString()

Overrides:

toString in class Object