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 import org.exolab.castor.xml.ValidationException;
40
41 /**
42 * A class which represents the field selector for an IdentityConstraint
43 *
44 * @author <a href="mailto:kvisco@intalio.com">Keith Visco</a>
45 * @version $Revision$ $Date: 2006-04-14 04:14:43 -0600 (Fri, 14 Apr 2006) $
46 **/
47 public class IdentityField extends Annotated {
48 /** SerialVersionUID */
49 private static final long serialVersionUID = -1385357135959672473L;
50
51 /**
52 * Identity Field id (optional)
53 **/
54 private String _id = null;
55
56 /**
57 * XPath expression for field nodes (required)
58 **/
59 private String _xpath = null;
60
61 /**
62 * Creates a new IdentityField.
63 *
64 * @param xpath the xpath for the IdentityField. Must not be null.
65 * @exception SchemaException if xpath is null.
66 **/
67 public IdentityField(String xpath) throws SchemaException {
68 setXPath(xpath);
69 } // -- IdentityField
70
71 /**
72 * Returns the Id of this IdentityField, or null if no Id has been set.
73 *
74 * @return the Id of this IdentityField, or null if no Id has been set.
75 **/
76 public String getId() {
77 return _id;
78 } // -- getId
79
80 /**
81 * Returns the XPath of this IdentityField. This value will never be null.
82 *
83 * @return the XPath of this IdentityField.
84 **/
85 public String getXPath() {
86 return _xpath;
87 } // -- getXPath
88
89
90 /**
91 * Sets the Id for this IdentityField.
92 *
93 * @param id the Id for this IdentityField.
94 **/
95 public void setId(String id) {
96 _id = id;
97 } // -- setId
98
99 /**
100 * Sets the XPath expression for this Field.
101 *
102 * @param xpath the XPath expression for this IdentityField. Must not be null.
103 * @exception SchemaException if xpath is null.
104 **/
105 public void setXPath(String xpath) throws SchemaException {
106 if (xpath == null)
107 throw new SchemaException("The xpath of a 'field' must not be null.");
108
109 _xpath = xpath;
110 } // -- setXPath
111
112 /**
113 * Returns the type of this Schema Structure
114 *
115 * @return the type of this Schema Structure
116 **/
117 public short getStructureType() {
118 return Structure.IDENTITY_FIELD;
119 } // -- getStructureType
120
121 /**
122 * Checks the validity of this Schema defintion.
123 *
124 * @exception ValidationException when this Schema definition is invalid.
125 **/
126 public void validate() throws ValidationException {
127 // -- do nothing, if it can be constructed, it's valid.
128 // -- validate XPath expression in the future?
129 } // -- validate
130
131 } // -- class: IdentityField