1 /**
2 * Redistribution and use of this software and associated documentation
3 * ("Software"), with or without modification, are permitted provided
4 * that the following conditions are met:
5 *
6 * 1. Redistributions of source code must retain copyright
7 * statements and notices. Redistributions must also contain a
8 * copy of this document.
9 *
10 * 2. Redistributions in binary form must reproduce the
11 * above copyright notice, this list of conditions and the
12 * following disclaimer in the documentation and/or other
13 * materials provided with the distribution.
14 *
15 * 3. The name "Exolab" must not be used to endorse or promote
16 * products derived from this Software without prior written
17 * permission of Intalio, Inc. For written permission,
18 * please contact info@exolab.org.
19 *
20 * 4. Products derived from this Software may not be called "Exolab"
21 * nor may "Exolab" appear in their names without prior written
22 * permission of Intalio, Inc. Exolab is a registered
23 * trademark of Intalio, Inc.
24 *
25 * 5. Due credit should be given to the Exolab Project
26 * (http://www.exolab.org/).
27 *
28 * THIS SOFTWARE IS PROVIDED BY INTALIO, INC. AND CONTRIBUTORS
29 * ``AS IS'' AND ANY EXPRESSED OR IMPLIED WARRANTIES, INCLUDING, BUT
30 * NOT LIMITED TO, THE IMPLIED WARRANTIES OF MERCHANTABILITY AND
31 * FITNESS FOR A PARTICULAR PURPOSE ARE DISCLAIMED. IN NO EVENT SHALL
32 * INTALIO, INC. OR ITS CONTRIBUTORS BE LIABLE FOR ANY DIRECT,
33 * INDIRECT, INCIDENTAL, SPECIAL, EXEMPLARY, OR CONSEQUENTIAL DAMAGES
34 * (INCLUDING, BUT NOT LIMITED TO, PROCUREMENT OF SUBSTITUTE GOODS OR
35 * SERVICES; LOSS OF USE, DATA, OR PROFITS; OR BUSINESS INTERRUPTION)
36 * HOWEVER CAUSED AND ON ANY THEORY OF LIABILITY, WHETHER IN CONTRACT,
37 * STRICT LIABILITY, OR TORT (INCLUDING NEGLIGENCE OR OTHERWISE)
38 * ARISING IN ANY WAY OUT OF THE USE OF THIS SOFTWARE, EVEN IF ADVISED
39 * OF THE POSSIBILITY OF SUCH DAMAGE.
40 *
41 * Copyright 2000 (C) Intalio, Inc. All Rights Reserved.
42 *
43 * $Id$
44 */
45
46
47 package org.exolab.castor.xml.schema;
48
49 import java.util.Enumeration;
50
51 import org.exolab.castor.xml.ValidationException;
52
53 /**
54 * An XML Schema Attribute Group Definition
55 * @author <a href="mailto:kvisco@intalio.com">Keith Visco</a>
56 * @version $Revision$ $Date: 2006-04-14 04:14:43 -0600 (Fri, 14 Apr 2006) $
57 **/
58 public abstract class AttributeGroup extends Annotated {
59
60 /**
61 * The id of this AttributeGroup
62 **/
63 private String _id = null;
64
65 /**
66 * Returns the anyAttribute set in this attribute group if any.
67 * @return the anyAttribute set in this attribute group if any.
68 */
69 public abstract Wildcard getAnyAttribute();
70
71 /**
72 * Returns the AttributeDecl associated with the given name
73 * @return the AttributeDecl associated with the given name, or
74 * null if no AttributeDecl with the given name was found.
75 **/
76 public abstract AttributeDecl getAttribute(String name);
77
78 /**
79 * Returns an Enumeration of all the attributes of this
80 * attribute group. The enumeration includes attributes from
81 * all AttributeGroupReferences contained in this AttributeGroup.
82 *
83 * @return an Enumeration of all the attributes of this
84 * attribute group.
85 **/
86 public abstract Enumeration getAttributes();
87
88 /**
89 * Returns the id of this AttributeGroup
90 * @return the id of this AttributeGroup, or null, if
91 * no id was defined.
92 **/
93 public String getId() {
94 return _id;
95 } //-- getId
96
97 /**
98 * Returns true if this AttributeGroup does not contain any
99 * AttributeDecls or any non-empty AttributeGroupReferences
100 *
101 * @return true if this AttributeGroup does not contain any
102 * AttributeDecls or any non-empty AttributeGroupReferences
103 **/
104 public abstract boolean isEmpty();
105
106 /**
107 * Returns the type of this Schema Structure
108 * @return the type of this Schema Structure
109 **/
110 public short getStructureType() {
111 return Structure.ATTRIBUTE_GROUP;
112 } //-- getStructureType
113
114 /**
115 * Sets the id of this AttributeGroup
116 * @param id the id of this AttributeGroup
117 **/
118 public void setId(String id) {
119 this._id = id;
120 } //-- setId
121
122 /**
123 * Checks the validity of this Attribute declaration
124 * @exception ValidationException when this Attribute declaration
125 * is invalid
126 **/
127 public void validate()
128 throws ValidationException
129 {
130 //-- no validation currently needed
131
132 } //-- validate
133
134
135 } //-- AttributeGroup