javax.enterprise.deploy.model

Interface DDBean

Known Subinterfaces:
DDBeanRoot

public interface DDBean

An interface for beans that represent a fragment of a standard deployment descriptor. A link is provided to the J2EE application that includes this bean.

Method Summary

void
addXpathListener(String xpath, XpathListener xpl)
Register a listener for a specific XPath.
String[]
getAttributeNames()
Returns the list of attribute names associated with XML element.
String
getAttributeValue(String attrName)
Returns the string value of the named attribute.
DDBean[]
getChildBean(String xpath)
Return a list of DDBeans based upon the XPath.
String
getId()
Returns the ATTLIST ID value for the XML tag defined by the Xpath for this bean.
DDBeanRoot
getRoot()
Return the root element for this DDBean.
String
getText()
Returns the XML text for by this bean.
String[]
getText(String xpath)
Return a list of text values for a given XPath in the deployment descriptor.
String
getXpath()
Returns the location in the deployment descriptor from which this bean is derived.
void
removeXpathListener(String xpath, XpathListener xpl)
Unregister a listener for a specific XPath.

Method Details

addXpathListener

public void addXpathListener(String xpath,
                             XpathListener xpl)
Register a listener for a specific XPath.
Parameters:
xpath - The XPath this listener is to be registered for.
xpl - The listener object.

getAttributeNames

public String[] getAttributeNames()
Returns the list of attribute names associated with XML element.
Returns:
a list of attribute names on this element. Null is returned if there are no attributes.
Since:
1.1

getAttributeValue

public String getAttributeValue(String attrName)
Returns the string value of the named attribute.
Returns:
the value of the attribute. Null is returned if there is no such attribute.
Since:
1.1

getChildBean

public DDBean[] getChildBean(String xpath)
Return a list of DDBeans based upon the XPath.
Parameters:
xpath - An XPath string referring to a location in the same deployment descriptor as this standard bean.
Returns:
a list of DDBeans or 'null' if no matching XML data is found.

getId

public String getId()
Returns the ATTLIST ID value for the XML tag defined by the Xpath for this bean.
Returns:
The XML text for this Bean or 'null' if no attribute was specifed with the tag.

getRoot

public DDBeanRoot getRoot()
Return the root element for this DDBean.
Returns:
The DDBeanRoot at the root of this DDBean tree.

getText

public String getText()
Returns the XML text for by this bean.
Returns:
The XML text for this Bean.

getText

public String[] getText(String xpath)
Return a list of text values for a given XPath in the deployment descriptor.
Parameters:
xpath - An XPath.
Returns:
The list text values for this XPath or 'null' if no matching XML data is found.

getXpath

public String getXpath()
Returns the location in the deployment descriptor from which this bean is derived.
Returns:
The XPath of this Bean.

removeXpathListener

public void removeXpathListener(String xpath,
                                XpathListener xpl)
Unregister a listener for a specific XPath.
Parameters:
xpath - The XPath this listener is to be registered for.
xpl - The listener object.