org.apache.ojb.broker.metadata
Class DeleteProcedureDescriptor

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

All Implemented Interfaces:

Serializable, AttributeContainer, RepositoryElements, XmlCapable

public class DeleteProcedureDescriptor
extends ProcedureDescriptor
implements Serializable, XmlCapable

An DeleteProcedureDescriptor contains information that is related to the procedure/function that is used to handle the deleting of existing records.
Note: Be careful when use DeleteProcedureDescriptor variables or caching DeleteProcedureDescriptor instances, because instances could become invalid during runtime (see MetadataManager).

Version:

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

Author:

Ron Gallagher

See Also:

Serialized Form

Field Summary

Fields inherited from interface org.apache.ojb.broker.metadata.RepositoryElements

_NEXT, ACCEPT_LOCKS, ACCESS, ATTRIBUTE, ATTRIBUTE_NAME, ATTRIBUTE_VALUE, AUTO_DELETE, AUTO_INCREMENT, AUTO_RETRIEVE, AUTO_UPDATE, BATCH_MODE, CASCADE_LINK_STR, CASCADE_NONE_STR, CASCADE_OBJECT_STR, CLASS_DESCRIPTOR, CLASS_EXTENT, CLASS_NAME, CLASS_PROXY, CLASS_REF, COLLECTION_CLASS, COLLECTION_DESCRIPTOR, COLUMN_NAME, CON_LOG_ABANDONED, CON_MAX_ACTIVE, CON_MAX_IDLE, CON_MAX_WAIT, CON_MIN_EVICTABLE_IDLE_TIME_MILLIS, CON_NUM_TESTS_PER_EVICTION_RUN, CON_REMOVE_ABANDONED, CON_REMOVE_ABANDONED_TIMEOUT, CON_TEST_ON_BORROW, CON_TEST_ON_RETURN, CON_TEST_WHILE_IDLE, CON_TIME_BETWEEN_EVICTION_RUNS_MILLIS, CON_WHEN_EXHAUSTED_ACTION, CONNECTION_FACTORY, CONNECTION_POOL, CONSTANT_ARGUMENT, DATASOURCE_NAME, DBMS_NAME, DEFAULT_CONNECTION, DELETE_PROCEDURE, DOCUMENTATION, DRIVER_NAME, EAGER_RELEASE, EXTENDS, FACTORY_CLASS, FACTORY_METHOD, FIELD_CONVERSION, FIELD_DESCRIPTOR, FIELD_ID_REF, FIELD_NAME, FIELD_REF, FK_POINTING_TO_ITEMS_CLASS, FK_POINTING_TO_THIS_CLASS, FOREIGN_KEY, ID, IGNORE_AUTOCOMMIT_EXCEPTION, INCLUDE_ALL_FIELDS, INCLUDE_PK_FIELDS_ONLY, INDEX_COLUMN, INDEX_DESCRIPTOR, INDEXED, INDIRECTION_TABLE, INITIALIZATION_METHOD, INSERT_PROCEDURE, INVERSE_FK, ISOLATION_LEVEL, ITEMS_CLASS, JCD_ALIAS, JDBC_CONNECTION_DESCRIPTOR, JDBC_LEVEL, JDBC_TYPE, LENGTH, LOCKING, MAPPING_REPOSITORY, NAME, NULLABLE, OBJECT_CACHE, ORDERBY, OTM_DEPENDENT, PRECISION, PRIMARY_KEY, PROXY_PREFETCHING_LIMIT, PROXY_REFERENCE, QUERY_CUSTOMIZER, REFERENCE_DESCRIPTOR, REFERENCED_CLASS, REFRESH, REPOSITORY_VERSION, RETURN, RETURN_FIELD_REF, ROW_READER, RUNTIME_ARGUMENT, SCALE, SCHEMA_NAME, SEQUENCE_MANAGER, SEQUENCE_MANAGER_CLASS, SEQUENCE_NAME, SORT, TABLE_NAME, TAG_ACCESS, TAG_ACCESS_ANONYMOUS, TAG_ACCESS_READONLY, TAG_ACCESS_READWRITE, TAG_SUPER, UNIQUE, UPDATE_LOCK, UPDATE_PROCEDURE, URL_DBALIAS, URL_PROTOCOL, URL_SUBPROTOCOL, USE_AUTOCOMMIT, USER_NAME, USER_PASSWD, VALIDATION_QUERY, VALUE

Constructor Summary

DeleteProcedureDescriptor(ClassDescriptor classDescriptor, String name, boolean includePkFieldsOnly)
Constructor declaration

Method Summary

void	addArgument(ArgumentDescriptor argument) Add an argument
void	addAttribute(String attributeName, String attributeValue) Store the specified attribute and it's value.
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.
boolean	getIncludePkFieldsOnly() Retrieve the value that indicates if the argument list for this procedure includes only the field-descriptors from the related class-descriptor that are identified as being part of the primary key.
String	toString() Provide a string representation of this object
String	toXML() returns the XML marshalled version of this instance.

Methods inherited from class org.apache.ojb.broker.metadata.ProcedureDescriptor

addArguments, getArgumentCount, getArguments, getClassDescriptor, getName, getReturnValueFieldRef, getReturnValueFieldRefName, hasReturnValue, hasReturnValues, setReturnValueFieldRef, setReturnValueFieldRef

Methods inherited from class java.lang.Object

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

Constructor Detail

DeleteProcedureDescriptor

public DeleteProcedureDescriptor(ClassDescriptor classDescriptor,
                                 String name,
                                 boolean includePkFieldsOnly)

Constructor declaration

Method Detail

getIncludePkFieldsOnly

public boolean getIncludePkFieldsOnly()

Retrieve the value that indicates if the argument list for this procedure includes only the field-descriptors from the related class-descriptor that are identified as being part of the primary key.

Returns:

The current value

addArgument

public final void addArgument(ArgumentDescriptor argument)

Add an argument

The argument will be added only if this procedure is not configured to include just the primary key fields.

Overrides:

addArgument in class ProcedureDescriptor

toXML

public String toXML()

Description copied from interface: XmlCapable

returns the XML marshalled version of this instance.

Specified by:

toXML in interface XmlCapable

Specified by:

toXML in class ProcedureDescriptor

Returns:

the XML String representing this object.

toString

public String toString()

Provide a string representation of this object

Returns:

a string representation of this object

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)