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: IdentityConstraint.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: import org.exolab.castor.xml.ValidationException;
050: import org.exolab.castor.xml.validators.ValidationUtils;
051:
052: /**
053: * The base class for the XML Schema Identity Constraints
054: * (key, keyref, unique).
055: *
056: * @author <a href="mailto:kvisco@intalio.com">Keith Visco</a>
057: * @version $Revision: 6230 $ $Date: 2006-04-14 04:14:43 -0600 (Fri, 14 Apr 2006) $
058: **/
059: public abstract class IdentityConstraint extends Annotated {
060:
061: /**
062: * Identity Constraint id
063: **/
064: private String _id = null;
065:
066: /**
067: * Identity Constraint name
068: **/
069: private String _name = null;
070:
071: /**
072: * Identity Constraint Selector
073: **/
074: private IdentitySelector _selector = null;
075:
076: /**
077: * The fields of this Identity Constraint
078: **/
079: private Vector _fields = null;
080:
081: /**
082: * Constructor used by sub-classes. Creates a new IdentityConstraint.
083: *
084: * @param name the name for the IdentityConstraint. Must not be null.
085: **/
086: protected IdentityConstraint(String name) throws SchemaException {
087: setName(name);
088: _fields = new Vector(3);
089: } //-- IdentityConstraint
090:
091: /**
092: * Adds the given IdentityField to this IdentityConstraint
093: *
094: * @param field the IdentityField to add.
095: **/
096: public void addField(IdentityField field) {
097: if (field != null)
098: _fields.addElement(field);
099: } //-- addField
100:
101: /**
102: * Returns an Enumeration of the IdentityFields contained within this
103: * IdentityConstraint.
104: *
105: * @return an Enumeration of the IdentityField objects contain within
106: * this IdentityConstraint.
107: **/
108: public Enumeration getFields() {
109: return _fields.elements();
110: } //-- getFields
111:
112: /**
113: * Returns the Id of this IdentityConstraint, or null if no
114: * Id has been set.
115: *
116: * @return the Id of this IdentityConstraint, or null if no
117: * Id has been set.
118: **/
119: public String getId() {
120: return _id;
121: } //-- getId
122:
123: /**
124: * Returns the name of this IdentityConstraint. This value will
125: * never be null.
126: *
127: * @return the name of this IdentityConstraint
128: **/
129: public String getName() {
130: return _name;
131: } //-- getName
132:
133: /**
134: * Returns the selector of this IdentityConstraint.
135: *
136: * @return the IdentitySelector of this IdentityConstraint
137: **/
138: public IdentitySelector getSelector() {
139: return _selector;
140: } //-- getSelector
141:
142: /**
143: * Removes the given IdentityField from this IdentityConstraint.
144: *
145: * @return true if the IdentityField was contained within this
146: * IdentityConstraint, otherwise false.
147: **/
148: public boolean removeField(IdentityField field) {
149: return _fields.removeElement(field);
150: } //-- removeField
151:
152: /**
153: * Sets the Id for this IdentityConstraint.
154: *
155: * @param id the Id for this IdentityConstraint.
156: **/
157: public void setId(String id) {
158: _id = id;
159: } //-- setId
160:
161: /**
162: * Sets the name for this IdentityConstraint.
163: *
164: * @param name the name for this IdentityConstraint. Must not be null.
165: * @exception SchemaException if name is null.
166: **/
167: public void setName(String name) throws SchemaException {
168: if (name == null)
169: throw new SchemaException(
170: "The name of an IdentityConstraint must not be null.");
171:
172: _name = name;
173: } //-- setName
174:
175: /**
176: * Sets the selector for this IdentityConstraint.
177: *
178: * @param selector the Selector for this IdentityConstraint. Must not be
179: * null.
180: * @exception SchemaException if selector is null.
181: **/
182: public void setSelector(IdentitySelector selector)
183: throws SchemaException {
184: if (selector == null)
185: throw new SchemaException(
186: "The selector of an IdentityConstraint must not be null.");
187: _selector = selector;
188: } //-- setSelector
189:
190: /**
191: * Returns the type of this Schema Structure
192: * @return the type of this Schema Structure
193: **/
194: public abstract short getStructureType();
195:
196: /**
197: * Checks the validity of this Schema defintion.
198: * @exception ValidationException when this Schema definition
199: * is invalid.
200: **/
201: public void validate() throws ValidationException {
202: String err = null;
203:
204: //-- name must be a NCName
205: if (!ValidationUtils.isNCName(_name)) {
206: err = "The name of an IdentityConstraint must be an NCName.";
207: }
208: //-- selector must exist
209: else if (_selector == null) {
210: err = "Selector for IdentityConstraint cannot be null.";
211: }
212: //-- at least 1 (one) field must exist
213: else if (_fields.size() < 1) {
214: err = "There must be at least one 'field' in an "
215: + "identity constraint.";
216: }
217:
218: if (err != null)
219: throw new ValidationException(err);
220:
221: } //-- validate
222:
223: } //-- class IdentityConstraint
|