KickJava   Java API By Example, From Geeks To Geeks.

Java > Open Source Codes > org > apache > ws > jaxme > xs > XSObject


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;
18
19 import org.xml.sax.Locator JavaDoc;
20 import org.xml.sax.SAXException JavaDoc;
21
22 /** <p>A common base interface for all other schema objects.</p>
23  *
24  * @author <a HREF="mailto:joe@ispsoft.de">Jochen Wiedmann</a>
25  */
26 public interface XSObject {
27   /** <p>Returns the objects schema.</p>
28    */
29   public XSSchema getXSSchema();
30
31   /** <p>Returns whether the object is a top-level object. This is
32    * the case for the XsESchema itself and for all its childs only.</p>
33    */
34   public boolean isTopLevelObject();
35
36   /** <p>Returns either of the following:
37    * <ul>
38    * <li>If the object is the schema itself, returns null. The
39    * schema doesn't have a parent object.</p>
40    * <li>If the object is a top-level object, returns the
41    * schema.</p>
42    * <li>Otherwise returns the object in which the given object
43    * is embedded.</li>
44    * </ul>
45    */
46   public XSObject getParentObject();
47
48   /** <p>Returns the objects location.</p>
49    */
50   public Locator JavaDoc getLocator();
51
52   /** <p>Validates the objects internal state.</p>
53    */
54   public void validate() throws SAXException JavaDoc;
55 }
56
Popular Tags