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 2001 (C) Intalio, Inc. All Rights Reserved.
042: *
043: * $Id: Union.java 6230 2006-09-19 07:56:07Z wguttmn $
044: */package org.exolab.castor.xml.schema;
045:
046: import java.util.Enumeration;
047: import java.util.Vector;
048:
049: /**
050: * A class that represents the XML Schema Union simple-type.
051: *
052: * @author <a href="mailto:kvisco@intalio.com">Keith Visco</a>
053: * @version $Revision: 6230 $ $Date: 2006-04-14 04:14:43 -0600 (Fri, 14 Apr 2006) $
054: **/
055: public class Union extends SimpleType {
056: /** SerialVersionUID */
057: private static final long serialVersionUID = -1389185884142578168L;
058:
059: /**
060: * The local annotation for this Union
061: **/
062: private Annotation _annotation = null;
063:
064: /**
065: * The id attribute for this Union
066: **/
067: private String _id = null;
068:
069: /**
070: * The simpleType members of this Union
071: **/
072: private Vector _simpleTypes = null;
073:
074: private boolean _hasReferencedTypes = false;
075:
076: /**
077: * Creates a new Union type.
078: *
079: * @param schema the Schema for this Union (Cannot be null)
080: **/
081: public Union(Schema schema) throws SchemaException {
082: super ();
083:
084: if (schema == null) {
085: String err = "The Schema argument to the constructor of Union "
086: + "may not be null.";
087: throw new IllegalArgumentException(err);
088: }
089: super .setSchema(schema);
090: //-- No sense in having a union of only one (1), but
091: //-- we choose a low number, like two (2) or three (3)
092: //-- since most unions will only have at most a
093: //-- few members.
094: _simpleTypes = new Vector(3);
095: } //-- Union
096:
097: /**
098: * Adds the given SimpleType reference as a member of this
099: * Union. An exception will be thrown during a call to
100: * #getMemberTypes if this reference cannot be resolved.
101: *
102: * @param typeName the name of the SimpleType to add.
103: **/
104: public void addMemberType(String typeName) {
105: if (typeName == null)
106: return;
107: addMemberType(new SimpleTypeReference(getSchema(), typeName));
108: } //-- addMemberType
109:
110: /**
111: * Adds the given SimpleType as a member of this Union
112: *
113: * @param simpleType the SimpleType to add to this Union.
114: **/
115: public void addMemberType(SimpleType simpleType) {
116: if (simpleType == null)
117: return;
118:
119: if (simpleType instanceof SimpleTypeReference) {
120: if (simpleType.getType() != null) {
121: simpleType = (SimpleType) simpleType.getType();
122: } else
123: _hasReferencedTypes = true;
124: }
125: _simpleTypes.add(simpleType);
126: } //-- addMemberType
127:
128: /**
129: * Returns the id for this Union, or null if no id has been set.
130: *
131: * @return the id for this Union, or null if no id has been set..
132: **/
133: public String getId() {
134: return _id;
135: } //-- getId
136:
137: /**
138: * Returns the annotation which appears local to this Union, or
139: * null if no local annotation has been set.
140: *
141: * @return the annotation which is local to this Union.
142: **/
143: public Annotation getLocalAnnotation() {
144: return _annotation;
145: } //-- getLocalAnnotation
146:
147: /**
148: * Returns an Enumeration of all the SimpleTypes that are members of
149: * this Union.
150: *
151: * @return an Enumeration of all member SimpleTypes.
152: **/
153: public Enumeration getMemberTypes() {
154: //-- clear any referenced types (if necessary)
155: if (_hasReferencedTypes) {
156: _hasReferencedTypes = false;
157: for (int i = 0; i < _simpleTypes.size(); i++) {
158: Object obj = _simpleTypes.elementAt(i);
159: if (obj instanceof SimpleTypeReference) {
160: SimpleType simpleType = (SimpleType) obj;
161: if (simpleType.getType() != null) {
162: _simpleTypes.setElementAt(simpleType.getType(),
163: i);
164: } else {
165: //-- XXXX
166: //-- we should really throw an exception here
167: //-- but for now...just re-mark as having
168: //-- an unresolved referred type.
169: _hasReferencedTypes = true;
170: }
171: }
172: }
173: }
174: return _simpleTypes.elements();
175: } //-- getMemberTypes;
176:
177: /**
178: * Returns the type of this Schema Structure
179: * @return the type of this Schema Structure
180: **/
181: public short getStructureType() {
182: return Structure.UNION;
183: } //-- getStructureType
184:
185: /**
186: * Sets the Schema for this Union. This method overloads the
187: * SimpleType#setSchema method to prevent the Schema from being
188: * changed.
189: *
190: * @param schema the schema that this Union belongs to.
191: **/
192: public void setSchema(Schema schema) {
193: if (schema != getSchema()) {
194: String err = "The Schema of an Union cannot be changed.";
195: throw new IllegalStateException(err);
196: }
197: } //-- void setSchema
198:
199: /**
200: * Sets the id for this Union.
201: *
202: * @param id the unique id for this Union. Must be globally unique
203: * within the scope of the Schema.
204: **/
205: public void setId(String id) {
206: _id = id;
207: } //-- setId
208:
209: /**
210: * Sets an annotation which is local to this Union.
211: *
212: * @param annotation the local annotation to set for this Union.
213: **/
214: public void setLocalAnnotation(Annotation annotation) {
215: _annotation = annotation;
216: } //-- setLocalAnnotation
217:
218: } //-- class: Union
|