001: /*
002: * JBoss, Home of Professional Open Source.
003: * Copyright 2006, Red Hat Middleware LLC, and individual contributors
004: * as indicated by the @author tags. See the copyright.txt file in the
005: * distribution for a full listing of individual contributors.
006: *
007: * This is free software; you can redistribute it and/or modify it
008: * under the terms of the GNU Lesser General Public License as
009: * published by the Free Software Foundation; either version 2.1 of
010: * the License, or (at your option) any later version.
011: *
012: * This software is distributed in the hope that it will be useful,
013: * but WITHOUT ANY WARRANTY; without even the implied warranty of
014: * MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE. See the GNU
015: * Lesser General Public License for more details.
016: *
017: * You should have received a copy of the GNU Lesser General Public
018: * License along with this software; if not, write to the Free
019: * Software Foundation, Inc., 51 Franklin St, Fifth Floor, Boston, MA
020: * 02110-1301 USA, or see the FSF site: http://www.fsf.org.
021: */
022: package javax.enterprise.deploy.model;
023:
024: /**
025: * A fragment of a standard deployment descriptor.
026: *
027: * @author <a href="mailto:adrian@jboss.org">Adrian Brock</a>
028: * @version $Revision: 57196 $
029: */
030: public interface DDBean {
031: // Constants -----------------------------------------------------
032:
033: // Public --------------------------------------------------------
034:
035: /**
036: * Returns the original xpath string provided by the DConfigBean
037: *
038: * @return the xpath
039: */
040: String getXpath();
041:
042: /**
043: * Returns the XML text for this bean
044: *
045: * @return the text
046: */
047: String getText();
048:
049: /**
050: * Returns the tool specific attribute ID
051: *
052: * @return the id or null if there is no id
053: */
054: String getId();
055:
056: /**
057: * Get the root element
058: *
059: * @return the root element
060: */
061: DDBeanRoot getRoot();
062:
063: /**
064: * Get the child elements with the specified xpath
065: *
066: * @param xpath the xpath of the children
067: * @return an array of children or null if there are none
068: */
069: DDBean[] getChildBean(String xpath);
070:
071: /**
072: * Get the text for the given xpath
073: *
074: * @param xpath the xpath
075: * @return an array of Strings for the xpath or null if there are none
076: */
077: String[] getText(String xpath);
078:
079: /**
080: * Register a listener for a given xpath
081: *
082: * @param xpath the xpath
083: * @param xpl the listener
084: */
085: void addXpathListener(String xpath, XpathListener xpl);
086:
087: /**
088: * Unregister a listener for a given xpath
089: *
090: * @param xpath the xpath
091: * @param xpl the listener
092: */
093: void removeXpathListener(String xpath, XpathListener xpl);
094:
095: /**
096: * Returns the list of attributes associated with this element
097: *
098: * @return the list of attributes
099: */
100: String[] getAttributeNames();
101:
102: /**
103: * Get the value for a given attribute
104: *
105: * @param attrName the attribute name
106: * @return the value
107: */
108: String getAttributeValue(String attrName);
109: }
|