KickJava   Java API By Example, From Geeks To Geeks.

Java > Open Source Codes > org > jboss > axis > deployment > wsdd > WSDDElement


1 /*
2  * The Apache Software License, Version 1.1
3  *
4  *
5  * Copyright (c) 2001-2003 The Apache Software Foundation. All rights
6  * reserved.
7  *
8  * Redistribution and use in source and binary forms, with or without
9  * modification, are permitted provided that the following conditions
10  * are met:
11  *
12  * 1. Redistributions of source code must retain the above copyright
13  * notice, this list of conditions and the following disclaimer.
14  *
15  * 2. Redistributions in binary form must reproduce the above copyright
16  * notice, this list of conditions and the following disclaimer in
17  * the documentation and/or other materials provided with the
18  * distribution.
19  *
20  * 3. The end-user documentation included with the redistribution,
21  * if any, must include the following acknowledgment:
22  * "This product includes software developed by the
23  * Apache Software Foundation (http://www.apache.org/)."
24  * Alternately, this acknowledgment may appear in the software itself,
25  * if and wherever such third-party acknowledgments normally appear.
26  *
27  * 4. The names "Axis" and "Apache Software Foundation" must
28  * not be used to endorse or promote products derived from this
29  * software without prior written permission. For written
30  * permission, please contact apache@apache.org.
31  *
32  * 5. Products derived from this software may not be called "Apache",
33  * nor may "Apache" appear in their name, without prior written
34  * permission of the Apache Software Foundation.
35  *
36  * THIS SOFTWARE IS PROVIDED ``AS IS'' AND ANY EXPRESSED OR IMPLIED
37  * WARRANTIES, INCLUDING, BUT NOT LIMITED TO, THE IMPLIED WARRANTIES
38  * OF MERCHANTABILITY AND FITNESS FOR A PARTICULAR PURPOSE ARE
39  * DISCLAIMED. IN NO EVENT SHALL THE APACHE SOFTWARE FOUNDATION OR
40  * ITS CONTRIBUTORS BE LIABLE FOR ANY DIRECT, INDIRECT, INCIDENTAL,
41  * SPECIAL, EXEMPLARY, OR CONSEQUENTIAL DAMAGES (INCLUDING, BUT NOT
42  * LIMITED TO, PROCUREMENT OF SUBSTITUTE GOODS OR SERVICES; LOSS OF
43  * USE, DATA, OR PROFITS; OR BUSINESS INTERRUPTION) HOWEVER CAUSED AND
44  * ON ANY THEORY OF LIABILITY, WHETHER IN CONTRACT, STRICT LIABILITY,
45  * OR TORT (INCLUDING NEGLIGENCE OR OTHERWISE) ARISING IN ANY WAY OUT
46  * OF THE USE OF THIS SOFTWARE, EVEN IF ADVISED OF THE POSSIBILITY OF
47  * SUCH DAMAGE.
48  * ====================================================================
49  *
50  * This software consists of voluntary contributions made by many
51  * individuals on behalf of the Apache Software Foundation. For more
52  * information on the Apache Software Foundation, please see
53  * <http://www.apache.org/>.
54  */
55 package org.jboss.axis.deployment.wsdd;
56
57 import org.jboss.axis.encoding.SerializationContext;
58 import org.jboss.axis.utils.Messages;
59 import org.w3c.dom.Element JavaDoc;
60 import org.w3c.dom.Node JavaDoc;
61 import org.w3c.dom.NodeList JavaDoc;
62
63 import javax.xml.namespace.QName JavaDoc;
64 import java.io.IOException JavaDoc;
65 import java.util.Vector JavaDoc;
66
67
68 /**
69  * abstract class extended by all WSDD Element classes
70  */
71 public abstract class WSDDElement extends WSDDConstants
72 {
73    /**
74     * If we have documentation, it goes here
75     */
76    private WSDDDocumentation documentation = null;
77
78    private String JavaDoc name;
79
80    /**
81     * Default constructor
82     */
83    public WSDDElement()
84    {
85    }
86
87    /**
88     * Create an element in WSDD that wraps an extant DOM element
89     *
90     * @param e (Element) XXX
91     * @throws WSDDException XXX
92     */
93    public WSDDElement(Element JavaDoc e)
94            throws WSDDException
95    {
96       validateCandidateElement(e);
97    }
98
99    /**
100     * Return the element name of a particular subclass.
101     */
102    protected abstract QName JavaDoc getElementName();
103
104    /**
105     * Make sure everything looks kosher with the element name.
106     */
107    private void validateCandidateElement(Element JavaDoc e)
108            throws WSDDException
109    {
110       QName JavaDoc name = getElementName();
111
112       if ((null == e) || (null == e.getNamespaceURI())
113               || (null == e.getLocalName())
114               || !e.getNamespaceURI().equals(name.getNamespaceURI())
115               || !e.getLocalName().equals(name.getLocalPart()))
116       {
117          throw new WSDDException(Messages.getMessage("invalidWSDD00",
118                  e.getLocalName(),
119                  name.getLocalPart()));
120       }
121    }
122
123    public Element JavaDoc getChildElement(Element JavaDoc e, String JavaDoc name)
124    {
125       Element JavaDoc[] elements = getChildElements(e, name);
126       if (elements.length == 0)
127          return null;
128       return elements[0];
129    }
130
131    public Element JavaDoc[] getChildElements(Element JavaDoc e, String JavaDoc name)
132    {
133       NodeList JavaDoc nl = e.getChildNodes();
134       Vector JavaDoc els = new Vector JavaDoc();
135
136       for (int i = 0; i < nl.getLength(); i++)
137       {
138          Node JavaDoc thisNode = nl.item(i);
139          if (!(thisNode instanceof Element JavaDoc))
140             continue;
141
142          Element JavaDoc el = (Element JavaDoc)thisNode;
143          if (el.getLocalName().equals(name))
144          {
145             els.add(el);
146          }
147       }
148
149       Element JavaDoc[] elements = new Element JavaDoc[els.size()];
150       els.toArray(elements);
151
152       return elements;
153    }
154
155    /**
156     * Get documentation (if any) for this WSDDElement.
157     *
158     * @return the WSDDDocumentation object associated with this element, or
159     * null.
160     */
161    public WSDDDocumentation getDocumentation()
162    {
163       return documentation;
164    }
165
166    /**
167     * Write this element out to a SerializationContext
168     */
169    public abstract void writeToContext(SerializationContext context)
170            throws IOException JavaDoc;
171 }
172
Popular Tags