001: /**
002: * Redistribution and use of this software and associated documentation
003: * ("Software"), with or without modification, are permitted provided
004: * that the following conditions are met:
005: *
006: * 1. Redistributions of source code must retain copyright
007: * statements and notices. Redistributions must also contain a
008: * copy of this document.
009: *
010: * 2. Redistributions in binary form must reproduce the
011: * above copyright notice, this list of conditions and the
012: * following disclaimer in the documentation and/or other
013: * materials provided with the distribution.
014: *
015: * 3. The name "Exolab" must not be used to endorse or promote
016: * products derived from this Software without prior written
017: * permission of Intalio, Inc. For written permission,
018: * please contact info@exolab.org.
019: *
020: * 4. Products derived from this Software may not be called "Exolab"
021: * nor may "Exolab" appear in their names without prior written
022: * permission of Intalio, Inc. Exolab is a registered
023: * trademark of Intalio, Inc.
024: *
025: * 5. Due credit should be given to the Exolab Project
026: * (http://www.exolab.org/).
027: *
028: * THIS SOFTWARE IS PROVIDED BY INTALIO, INC. AND CONTRIBUTORS
029: * ``AS IS'' AND ANY EXPRESSED OR IMPLIED WARRANTIES, INCLUDING, BUT
030: * NOT LIMITED TO, THE IMPLIED WARRANTIES OF MERCHANTABILITY AND
031: * FITNESS FOR A PARTICULAR PURPOSE ARE DISCLAIMED. IN NO EVENT SHALL
032: * INTALIO, INC. OR ITS CONTRIBUTORS BE LIABLE FOR ANY DIRECT,
033: * INDIRECT, INCIDENTAL, SPECIAL, EXEMPLARY, OR CONSEQUENTIAL DAMAGES
034: * (INCLUDING, BUT NOT LIMITED TO, PROCUREMENT OF SUBSTITUTE GOODS OR
035: * SERVICES; LOSS OF USE, DATA, OR PROFITS; OR BUSINESS INTERRUPTION)
036: * HOWEVER CAUSED AND ON ANY THEORY OF LIABILITY, WHETHER IN CONTRACT,
037: * STRICT LIABILITY, OR TORT (INCLUDING NEGLIGENCE OR OTHERWISE)
038: * ARISING IN ANY WAY OUT OF THE USE OF THIS SOFTWARE, EVEN IF ADVISED
039: * OF THE POSSIBILITY OF SUCH DAMAGE.
040: *
041: * Copyright 2000 (C) Intalio, Inc. All Rights Reserved.
042: *
043: * $Id: AttributeGroup.java 5951 2006-05-30 22:18:48Z bsnyder $
044: */package org.exolab.castor.xml.schema;
045:
046: import java.util.Enumeration;
047:
048: import org.exolab.castor.xml.ValidationException;
049:
050: /**
051: * An XML Schema Attribute Group Definition
052: * @author <a href="mailto:kvisco@intalio.com">Keith Visco</a>
053: * @version $Revision: 5951 $ $Date: 2006-04-14 04:14:43 -0600 (Fri, 14 Apr 2006) $
054: **/
055: public abstract class AttributeGroup extends Annotated {
056:
057: /**
058: * The id of this AttributeGroup
059: **/
060: private String _id = null;
061:
062: /**
063: * Returns the anyAttribute set in this attribute group if any.
064: * @return the anyAttribute set in this attribute group if any.
065: */
066: public abstract Wildcard getAnyAttribute();
067:
068: /**
069: * Returns the AttributeDecl associated with the given name
070: * @return the AttributeDecl associated with the given name, or
071: * null if no AttributeDecl with the given name was found.
072: **/
073: public abstract AttributeDecl getAttribute(String name);
074:
075: /**
076: * Returns an Enumeration of all the attributes of this
077: * attribute group. The enumeration includes attributes from
078: * all AttributeGroupReferences contained in this AttributeGroup.
079: *
080: * @return an Enumeration of all the attributes of this
081: * attribute group.
082: **/
083: public abstract Enumeration getAttributes();
084:
085: /**
086: * Returns the id of this AttributeGroup
087: * @return the id of this AttributeGroup, or null, if
088: * no id was defined.
089: **/
090: public String getId() {
091: return _id;
092: } //-- getId
093:
094: /**
095: * Returns true if this AttributeGroup does not contain any
096: * AttributeDecls or any non-empty AttributeGroupReferences
097: *
098: * @return true if this AttributeGroup does not contain any
099: * AttributeDecls or any non-empty AttributeGroupReferences
100: **/
101: public abstract boolean isEmpty();
102:
103: /**
104: * Returns the type of this Schema Structure
105: * @return the type of this Schema Structure
106: **/
107: public short getStructureType() {
108: return Structure.ATTRIBUTE_GROUP;
109: } //-- getStructureType
110:
111: /**
112: * Sets the id of this AttributeGroup
113: * @param id the id of this AttributeGroup
114: **/
115: public void setId(String id) {
116: this ._id = id;
117: } //-- setId
118:
119: /**
120: * Checks the validity of this Attribute declaration
121: * @exception ValidationException when this Attribute declaration
122: * is invalid
123: **/
124: public void validate() throws ValidationException {
125: //-- no validation currently needed
126:
127: } //-- validate
128:
129: } //-- AttributeGroup
|