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 2001 (C) Intalio, Inc. All Rights Reserved.
42 *
43 * $Id$
44 */
45
46
47 package org.exolab.castor.xml.schema;
48
49
50 /**
51 * A class that represents the XML Schema Identity Constraint: KeyRef.
52 *
53 * @author <a href="mailto:kvisco@intalio.com">Keith Visco</a>
54 * @version $Revision$ $Date: 2006-04-14 04:14:43 -0600 (Fri, 14 Apr 2006) $
55 **/
56 public class KeyRef extends IdentityConstraint {
57 /** SerialVersionUID */
58 private static final long serialVersionUID = -7342572522733089648L;
59
60 /**
61 * The refer for the KeyRef, (ie. the name of key being refered to).
62 **/
63 private String _refer = null;
64
65 /**
66 * Creates a new KeyRef Identity-Constraint.
67 *
68 * @param name the name for the IdentityConstraint. Must not be null.
69 * @exception SchemaException when name or refer are null.
70 **/
71 public KeyRef(String name, String refer)
72 throws SchemaException
73 {
74 super(name);
75 setRefer(refer);
76 } //-- KeyRef
77
78 /**
79 * Returns the refer field (the name of the key being referenced).
80 *
81 * @return the refer field (the name of the key being referenced).
82 **/
83 public String getRefer() {
84 return _refer;
85 } //-- getRefer
86
87 /**
88 * Sets the refer field (the name of the key being referenced).
89 *
90 * @param refer the name of the key to reference. Must not be null.
91 * @exception SchemaException when refer is null.
92 **/
93 public void setRefer(String refer)
94 throws SchemaException
95 {
96 if (refer == null)
97 throw new SchemaException("The 'refer' field of a KeyRef must not be null.");
98 _refer = refer;
99 } //-- setRefer
100
101 /**
102 * Returns the type of this Schema Structure.
103 *
104 * @return the type of this Schema Structure.
105 **/
106 public short getStructureType() {
107 return Structure.KEYREF;
108 } //-- getStructureType
109
110 } //-- class: KeyRef