oracle.toplink.tools.ejbjar
Class NameAndDescription

java.lang.Object
oracle.toplink.tools.ejbjar.DomObject
oracle.toplink.tools.ejbjar.Description
oracle.toplink.tools.ejbjar.NameAndDescription

All Implemented Interfaces:

EjbJarConstants

Direct Known Subclasses:

CmpField, EjbLocalReference, EjbReference, EnvironmentEntry, Method, ResourceEnvReference, ResourceReference, RunAs, SecurityRole, SecurityRoleReference

public abstract class NameAndDescription

extends Description

Since a number of elements have optional description sub-elements and required name sub-elements this abstract class can be subclassed to inherit the name and description element support.

Field Summary

Fields inherited from interface oracle.toplink.tools.ejbjar.EjbJarConstants

ABSTRACT_SCHEMA_NAME, ACKNOWLEDGE_MODE, APPLICATION_AUTH, ASSEMBLY_DESCRIPTOR, AUTO_ACKNOWLEDGE, BEAN_MANAGED, BOOLEAN_TYPE, BYTE_TYPE, CASCADE_DELETE, CMP_FIELD, CMP_VERSION, CMP_VERSION_1, CMP_VERSION_2, CMR_FIELD, CMR_FIELD_NAME, CMR_FIELD_TYPE, COLLECTION_TYPE, CONTAINER_AUTH, CONTAINER_MANAGED, CONTAINER_TRANSACTION, DESCRIPTION, DESTINATION_TYPE, DISPLAY_NAME, DOUBLE_TYPE, DUPS_OK_ACKNOWLEDGE, DURABLE, EJB_CLASS, EJB_CLIENT_JAR, EJB_JAR, EJB_LINK, EJB_LOCAL_REF, EJB_NAME, EJB_QL, EJB_REF, EJB_REF_NAME, EJB_REF_TYPE, EJB_RELATION, EJB_RELATION_NAME, EJB_RELATIONSHIP_ROLE, EJB_RELATIONSHIP_ROLE_NAME, ENTERPRISE_BEANS, ENTITY, ENTITY_REF_TYPE, ENV_ENTRY, ENV_ENTRY_NAME, ENV_ENTRY_TYPE, ENV_ENTRY_VALUE, EXCLUDE_LIST, FALSE_VALUE, FIELD_NAME, FLOAT_TYPE, HOME, INTEGER_TYPE, LARGE_ICON, LOCAL, LOCAL_HOME, LONG_TYPE, MANDATORY, MESSAGE_DRIVEN, MESSAGE_DRIVEN_DESTINATION, MESSAGE_SELECTOR, METHOD, METHOD_INTF, METHOD_NAME, METHOD_PARAM, METHOD_PARAMS, METHOD_PERMISSION, MULTIPLICITY, MULTIPLICITY_MANY, MULTIPLICITY_ONE, NEVER, NONDURABLE, NOT_SUPPORTED, PERSISTENCE_TYPE, PRIM_KEY_CLASS, PRIMKEY_FIELD, QUERY, QUERY_METHOD, QUEUE_TYPE, REENTRANT, RELATIONSHIP_ROLE_SOURCE, RELATIONSHIPS, REMOTE, REQUIRED, REQUIRES_NEW, RES_AUTH, RES_REF_NAME, RES_SHARING_SCOPE, RES_TYPE, RESOURCE_ENV_REF, RESOURCE_ENV_REF_NAME, RESOURCE_ENV_REF_TYPE, RESOURCE_REF, RESULT_TYPE_MAPPING, ROLE_LINK, ROLE_NAME, RUN_AS, SECURITY_IDENTITY, SECURITY_ROLE, SECURITY_ROLE_REF, SESSION, SESSION_REF_TYPE, SESSION_TYPE, SET_TYPE, SHAREABLE_SCOPE, SHORT_TYPE, SMALL_ICON, STATEFUL_TYPE, STATELESS_TYPE, STRING_TYPE, SUBSCRIPTION_DURABILITY, SUPPORTS, TOPIC_TYPE, TRANS_ATTRIBUTE, TRANSACTION_TYPE, TRUE_VALUE, UNCHECKED, UNSHAREABLE_SCOPE, USE_CALLER_IDENTITY

Constructor Summary

NameAndDescription()

Method Summary

java.lang.String	getName()
void	inheritedFields(org.w3c.dom.Document doc, org.w3c.dom.Element e) Insert elements for the fields that subclasses inherit from this object.
void	loadFromElement(org.w3c.dom.Element e) Load the data for this instance from the specified element.
void	setName(java.lang.String nm)

Methods inherited from class oracle.toplink.tools.ejbjar.Description

getDescription, setDescription

Methods inherited from class oracle.toplink.tools.ejbjar.DomObject

toElement, trace

Methods inherited from class java.lang.Object

equals, getClass, hashCode, notify, notifyAll, toString, wait, wait, wait

Constructor Detail

NameAndDescription

public NameAndDescription()

Method Detail

getName

public java.lang.String getName()

Returns:

String the name String

inheritedFields

public void inheritedFields(org.w3c.dom.Document doc,
                            org.w3c.dom.Element e)

Insert elements for the fields that subclasses inherit from this object. Note: This means a class needs to know if it has subclasses.

Overrides:

inheritedFields in class Description

Parameters:

doc - a Document instance used to create elements

e - the parent Element in which to insert the field elements

loadFromElement

public void loadFromElement(org.w3c.dom.Element e)

Load the data for this instance from the specified element.

Overrides:

loadFromElement in class Description

Parameters:

e - the DOM element

setName

public void setName(java.lang.String nm)

Parameters:

nm - the name String