javax.enterprise.deploy.model
Interface DDBeanRoot

All Superinterfaces:

DDBean

public interface DDBeanRoot
extends DDBean

An interface that represents the root of a standard deployment descriptor. A DDBeanRoot is a type of DDBean.

Version:

$Rev: 46019 $ $Date: 2004-09-14 02:56:06 -0700 (Tue, 14 Sep 2004) $

Method Summary

String	getDDBeanRootVersion() A convenience method to return the version number of an XML instance document.
DeployableObject	getDeployableObject() Return the containing DeployableObject
String	getFilename() Returns the filename relative to the root of the module of the XML instance document this DDBeanRoot represents.
String	getModuleDTDVersion() A convenience method to return the DTD version number.
ModuleType	getType() Return the ModuleType of deployment descriptor.
String	getXpath() Return the XPath for this standard bean.

Methods inherited from interface javax.enterprise.deploy.model.DDBean

addXpathListener, getAttributeNames, getAttributeValue, getChildBean, getId, getRoot, getText, getText, removeXpathListener

Method Detail

getType

ModuleType getType()

Return the ModuleType of deployment descriptor.

Returns:

The ModuleType of deployment descriptor

getDeployableObject

DeployableObject getDeployableObject()

Return the containing DeployableObject

Returns:

The DeployableObject that contains this deployment descriptor

getModuleDTDVersion

String getModuleDTDVersion()

A convenience method to return the DTD version number. The DeployableObject has this information. Note: the method getDDBeanRootVersion() is preferred to this method.

Returns:

a string containing the DTD version number

See Also:

getDDBeanRootVersion()

getDDBeanRootVersion

String getDDBeanRootVersion()

A convenience method to return the version number of an XML instance document. This method is replacing the method DeployableObject.getModuleDTDVersion, because it returns the version number of any J2EE XML instance document

Returns:

a string that is the version number of the XML instance document. Null is returned if no version number can be found.

A module's deployment descriptor file always contains a document type identifier, DOCTYPE. The DOCTYPE statement contains the module DTD version number in the label of the statement.

The format of the DOCTYPE statement is:

<!DOCTYPE root_element PUBLIC "-//organization//label//language" "location">

root_element

is the name of the root document in the DTD.

organization

is the name of the organization responsible for the creation and maintenance of the DTD being referenced.

label

is a unique descriptive name for the public text being referenced.

language

is the ISO 639 language id representing the natural language encoding of th DTD.

location

is the URL of the DTD.

An example J2EE deployment descriptor DOCTYPE statement is:

In this example the label is, "DTD J2EE Application Client 1.3", and the DTD version number is 1.3. A call to getModuleDTDVersion would return a string containing, "1.3".

getXpath

String getXpath()

Return the XPath for this standard bean. The root XPath is "/".

Specified by:

getXpath in interface DDBean

Returns:

"/" this is the root standard bean.

getFilename

String getFilename()

Returns the filename relative to the root of the module of the XML instance document this DDBeanRoot represents.

Returns:

String the filename relative to the root of the module

Since:

1.1