KickJava   Java API By Example, From Geeks To Geeks.

Java > Open Source Codes > org > apache > ws > jaxme > xs > xml > XsEDocumentation


1 /*
2  * Copyright 2003, 2004 The Apache Software Foundation
3  *
4  * Licensed under the Apache License, Version 2.0 (the "License");
5  * you may not use this file except in compliance with the License.
6  * You may obtain a copy of the License at
7  *
8  * http://www.apache.org/licenses/LICENSE-2.0
9  *
10  * Unless required by applicable law or agreed to in writing, software
11  * distributed under the License is distributed on an "AS IS" BASIS,
12  * WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
13  * See the License for the specific language governing permissions and
14  * limitations under the License.
15
16  */
17 package org.apache.ws.jaxme.xs.xml;
18
19
20 /** <p>Interface of <code>xs:documentation</code>, as specified
21  * by the following:
22  * <pre>
23  * &lt;xs:element name="documentation" id="documentation"&gt;
24  * &lt;xs:annotation&gt;
25  * &lt;xs:documentation source="http://www.w3.org/TR/xmlschema-1/#element-documentation"/&gt;
26  * &lt;/xs:annotation&gt;
27  * &lt;xs:complexType mixed="true"&gt;
28  * &lt;xs:sequence minOccurs="0" maxOccurs="unbounded"&gt;
29  * &lt;xs:any processContents="lax"/&gt;
30  * &lt;/xs:sequence&gt;
31  * &lt;xs:attribute name="source" type="xs:anyURI"/&gt;
32  * &lt;xs:attribute ref="xml:lang"/&gt;
33  * &lt;/xs:complexType&gt;
34  * &lt;/xs:element&gt;
35  * </pre></p>
36  *
37  * @author <a HREF="mailto:joe@ispsoft.de">Jochen Wiedmann</a>
38  */
39 public interface XsEDocumentation extends XsObject {
40     /** <p>Sets the documentation elements language. Defaults to
41      * null.</p>
42      * @param pLang The language abbreviation, for example "en".
43      */
44     public void setLang(XmlLang pLang);
45
46     /** <p>Returns the documentation elements language. Defaults to
47      * null.</p>
48      * @return The language abbreviation, for example "en".
49      */
50     public XmlLang getLang();
51
52     /** <p>Sets the URI to read for the documentations contents.
53      * Defaults to null.</p>
54      * @param pSource Source URI
55      */
56     public void setSource(XsAnyURI pSource);
57
58     /** <p>Returns the URI to read for the documentations contents.
59      * Defaults to null.</p>
60      * @return Source URI
61      */
62     public XsAnyURI getSource();
63     
64     /** <p>Returns the embedded text. The embedded text is specified as the
65      * concatenation of all text nodes. Child elements, if any, are ignored.</p>
66      */
67     public String JavaDoc getText();
68     
69     /** <p>Returns whether the documentation is simple. In other words, whether
70      * it consists of text only. If not, you should use {@link #getChilds()}
71      * rather than {@link #getText()}.</p>
72      */
73     public boolean isTextOnly();
74     
75     /** <p>Returns the array of all child objects. Child objects may either
76      * be Strings or DOM nodes.</p>
77      */
78     public Object JavaDoc[] getChilds();
79 }
80
Popular Tags