oracle.toplink.tools.ejbjar
Class EjbJar

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

All Implemented Interfaces:

EjbJarConstants

public class EjbJar

extends Description

Root object that stores all deployment descriptor info contained in an ejb-jar.xml file.

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

EjbJar()

Method Summary

void	addEnterpriseObjects(java.util.Vector v)
void	addEntity(Entity entity)
void	addRelationship(Relationship relationship)
AssemblyDescriptor	getAssemblyDescriptor()
java.lang.String	getDisplayName()
java.lang.String	getEjbClientJar()
java.util.Vector	getEnterpriseObjects()
java.util.Vector	getEntities()
Entity	getEntityForEjbClass(java.lang.String ejbClass)
Entity	getEntityForEjbName(java.lang.String ejbName)
java.lang.String	getLargeIcon()
java.util.Vector	getMessageDrivens()
Relationships	getRelationships()
java.util.Vector	getSessions()
java.lang.String	getSmallIcon()
static EjbJar	loadFromDocument(org.w3c.dom.Document doc) Create a new instance loaded with all of the data from the specified document obtained by parsing a ejb-jar XML file.
void	loadFromElement(org.w3c.dom.Element e) Load the data for this instance from the specified element.
void	removeEntity(Entity entity)
void	removeRelationships(java.util.Collection rels)
void	setDisplayName(java.lang.String s)
void	setEjbClientJar(java.lang.String s)
void	setEnterpriseObjects(java.util.Vector enterpiseObjects)
void	setLargeIcon(java.lang.String s)
void	setRelationships(Relationships r)
void	setSmallIcon(java.lang.String s)
org.w3c.dom.Element	toElement(org.w3c.dom.Document doc) Return the data from this instance as a DOM element.

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

getDescription, inheritedFields, setDescription

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

trace

Methods inherited from class java.lang.Object

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

Constructor Detail

EjbJar

public EjbJar()

Method Detail

addEnterpriseObjects

public void addEnterpriseObjects(java.util.Vector v)

Parameters:

v - a collection of concrete entity, session or message-driven objects

addEntity

public void addEntity(Entity entity)

addRelationship

public void addRelationship(Relationship relationship)

getAssemblyDescriptor

public AssemblyDescriptor getAssemblyDescriptor()

Returns:

AssemblyDescriptor the assembly descriptor object, or null if not set

getEjbClientJar

public java.lang.String getEjbClientJar()

Returns:

String the client jar String, or null if not set

getDisplayName

public java.lang.String getDisplayName()

Returns:

String the display name String, or null if not set

getEnterpriseObjects

public java.util.Vector getEnterpriseObjects()

Returns:

Vector collection of EnterpriseObject objects

getEntities

public java.util.Vector getEntities()

Returns:

Vector collection of Entity objects (empty if none exist)

getEntityForEjbClass

public Entity getEntityForEjbClass(java.lang.String ejbClass)

getEntityForEjbName

public Entity getEntityForEjbName(java.lang.String ejbName)

getLargeIcon

public java.lang.String getLargeIcon()

Returns:

String the largeIcon String, or null if not set

getMessageDrivens

public java.util.Vector getMessageDrivens()

Returns:

Vector collection of MessageDriven objects (empty if none exist)

getRelationships

public Relationships getRelationships()

Returns:

Relationships holds the individual relationship objects, null if none

getSessions

public java.util.Vector getSessions()

Returns:

Vector collection of Session objects (empty if none exist)

getSmallIcon

public java.lang.String getSmallIcon()

Returns:

String the smallIcon String, or null if not set

loadFromDocument

public static EjbJar loadFromDocument(org.w3c.dom.Document doc)

Create a new instance loaded with all of the data from the specified document obtained by parsing a ejb-jar XML file.

Parameters:

doc - the DOM document created by the XML parser

Returns:

EjbJar the model object that holds the data

removeEntity

public void removeEntity(Entity entity)

removeRelationships

public void removeRelationships(java.util.Collection rels)

setDisplayName

public void setDisplayName(java.lang.String s)

setEjbClientJar

public void setEjbClientJar(java.lang.String s)

setEnterpriseObjects

public void setEnterpriseObjects(java.util.Vector enterpiseObjects)

setLargeIcon

public void setLargeIcon(java.lang.String s)

setRelationships

public void setRelationships(Relationships r)

Parameters:

r - set the relationship objects

setSmallIcon

public void setSmallIcon(java.lang.String s)

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 root DOM element for an ejb-jar file

toElement

public org.w3c.dom.Element toElement(org.w3c.dom.Document doc)

Return the data from this instance as a DOM element.

Specified by:

toElement in class DomObject

Parameters:

doc - a Document instance used to create elements