1 /**
2 * Redistribution and use of this software and associated documentation ("Software"), with or
3 * without modification, are permitted provided that the following conditions are met:
4 *
5 * 1. Redistributions of source code must retain copyright statements and notices. Redistributions
6 * must also contain a copy of this document.
7 *
8 * 2. Redistributions in binary form must reproduce the above copyright notice, this list of
9 * conditions and the following disclaimer in the documentation and/or other materials provided with
10 * the distribution.
11 *
12 * 3. The name "Exolab" must not be used to endorse or promote products derived from this Software
13 * without prior written permission of Intalio, Inc. For written permission, please contact
14 * info@exolab.org.
15 *
16 * 4. Products derived from this Software may not be called "Exolab" nor may "Exolab" appear in
17 * their names without prior written permission of Intalio, Inc. Exolab is a registered trademark of
18 * Intalio, Inc.
19 *
20 * 5. Due credit should be given to the Exolab Project (http://www.exolab.org/).
21 *
22 * THIS SOFTWARE IS PROVIDED BY INTALIO, INC. AND CONTRIBUTORS ``AS IS'' AND ANY EXPRESSED OR
23 * IMPLIED WARRANTIES, INCLUDING, BUT NOT LIMITED TO, THE IMPLIED WARRANTIES OF MERCHANTABILITY AND
24 * FITNESS FOR A PARTICULAR PURPOSE ARE DISCLAIMED. IN NO EVENT SHALL INTALIO, INC. OR ITS
25 * CONTRIBUTORS BE LIABLE FOR ANY DIRECT, INDIRECT, INCIDENTAL, SPECIAL, EXEMPLARY, OR CONSEQUENTIAL
26 * DAMAGES (INCLUDING, BUT NOT LIMITED TO, PROCUREMENT OF SUBSTITUTE GOODS OR SERVICES; LOSS OF USE,
27 * DATA, OR PROFITS; OR BUSINESS INTERRUPTION) HOWEVER CAUSED AND ON ANY THEORY OF LIABILITY,
28 * WHETHER IN CONTRACT, STRICT LIABILITY, OR TORT (INCLUDING NEGLIGENCE OR OTHERWISE) ARISING IN ANY
29 * WAY OUT OF THE USE OF THIS SOFTWARE, EVEN IF ADVISED OF THE POSSIBILITY OF SUCH DAMAGE.
30 *
31 * Copyright 2001 (C) Intalio, Inc. All Rights Reserved.
32 *
33 * $Id$
34 */
35
36
37 package org.exolab.castor.xml.schema;
38
39
40 /**
41 * A class that represents the XML Schema Identity Constraint: KeyRef.
42 *
43 * @author <a href="mailto:kvisco@intalio.com">Keith Visco</a>
44 * @version $Revision$ $Date: 2006-04-14 04:14:43 -0600 (Fri, 14 Apr 2006) $
45 **/
46 public class KeyRef extends IdentityConstraint {
47 /** SerialVersionUID */
48 private static final long serialVersionUID = -7342572522733089648L;
49
50 /**
51 * The refer for the KeyRef, (ie. the name of key being refered to).
52 **/
53 private String _refer = null;
54
55 /**
56 * Creates a new KeyRef Identity-Constraint.
57 *
58 * @param name the name for the IdentityConstraint. Must not be null.
59 * @exception SchemaException when name or refer are null.
60 **/
61 public KeyRef(String name, String refer) throws SchemaException {
62 super(name);
63 setRefer(refer);
64 } // -- KeyRef
65
66 /**
67 * Returns the refer field (the name of the key being referenced).
68 *
69 * @return the refer field (the name of the key being referenced).
70 **/
71 public String getRefer() {
72 return _refer;
73 } // -- getRefer
74
75 /**
76 * Sets the refer field (the name of the key being referenced).
77 *
78 * @param refer the name of the key to reference. Must not be null.
79 * @exception SchemaException when refer is null.
80 **/
81 public void setRefer(String refer) throws SchemaException {
82 if (refer == null)
83 throw new SchemaException("The 'refer' field of a KeyRef must not be null.");
84 _refer = refer;
85 } // -- setRefer
86
87 /**
88 * Returns the type of this Schema Structure.
89 *
90 * @return the type of this Schema Structure.
91 **/
92 public short getStructureType() {
93 return Structure.KEYREF;
94 } // -- getStructureType
95
96 } // -- class: KeyRef