KickJava   Java API By Example, From Geeks To Geeks.

Java > Open Source Codes > org > apache > fulcrum > intake > xmlmodel > Rule


1 package org.apache.fulcrum.intake.xmlmodel;
2
3 /* ====================================================================
4  * The Apache Software License, Version 1.1
5  *
6  * Copyright (c) 2001 The Apache Software Foundation. All rights
7  * reserved.
8  *
9  * Redistribution and use in source and binary forms, with or without
10  * modification, are permitted provided that the following conditions
11  * are met:
12  *
13  * 1. Redistributions of source code must retain the above copyright
14  * notice, this list of conditions and the following disclaimer.
15  *
16  * 2. Redistributions in binary form must reproduce the above copyright
17  * notice, this list of conditions and the following disclaimer in
18  * the documentation and/or other materials provided with the
19  * distribution.
20  *
21  * 3. The end-user documentation included with the redistribution,
22  * if any, must include the following acknowledgment:
23  * "This product includes software developed by the
24  * Apache Software Foundation (http://www.apache.org/)."
25  * Alternately, this acknowledgment may appear in the software itself,
26  * if and wherever such third-party acknowledgments normally appear.
27  *
28  * 4. The names "Apache" and "Apache Software Foundation" and
29  * "Apache Turbine" must not be used to endorse or promote products
30  * derived from this software without prior written permission. For
31  * written permission, please contact apache@apache.org.
32  *
33  * 5. Products derived from this software may not be called "Apache",
34  * "Apache Turbine", nor may "Apache" appear in their name, without
35  * prior written permission of the Apache Software Foundation.
36  *
37  * THIS SOFTWARE IS PROVIDED ``AS IS'' AND ANY EXPRESSED OR IMPLIED
38  * WARRANTIES, INCLUDING, BUT NOT LIMITED TO, THE IMPLIED WARRANTIES
39  * OF MERCHANTABILITY AND FITNESS FOR A PARTICULAR PURPOSE ARE
40  * DISCLAIMED. IN NO EVENT SHALL THE APACHE SOFTWARE FOUNDATION OR
41  * ITS CONTRIBUTORS BE LIABLE FOR ANY DIRECT, INDIRECT, INCIDENTAL,
42  * SPECIAL, EXEMPLARY, OR CONSEQUENTIAL DAMAGES (INCLUDING, BUT NOT
43  * LIMITED TO, PROCUREMENT OF SUBSTITUTE GOODS OR SERVICES; LOSS OF
44  * USE, DATA, OR PROFITS; OR BUSINESS INTERRUPTION) HOWEVER CAUSED AND
45  * ON ANY THEORY OF LIABILITY, WHETHER IN CONTRACT, STRICT LIABILITY,
46  * OR TORT (INCLUDING NEGLIGENCE OR OTHERWISE) ARISING IN ANY WAY OUT
47  * OF THE USE OF THIS SOFTWARE, EVEN IF ADVISED OF THE POSSIBILITY OF
48  * SUCH DAMAGE.
49  * ====================================================================
50  *
51  * This software consists of voluntary contributions made by many
52  * individuals on behalf of the Apache Software Foundation. For more
53  * information on the Apache Software Foundation, please see
54  * <http://www.apache.org/>.
55  */
56
57 import org.xml.sax.Attributes JavaDoc;
58 import org.apache.fulcrum.intake.validator.Constraint;
59
60 /**
61  * A Class for holding data about a constraint on a property.
62  *
63  * @author <a HREF="mailto:jmcnally@collab.net>John McNally</a>
64  * @version $Id: Rule.java,v 1.1 2004/11/12 10:25:47 epugh Exp $
65  */
66 public class Rule
67     implements Constraint, java.io.Serializable JavaDoc
68 {
69     private String JavaDoc name;
70     private String JavaDoc value;
71     private String JavaDoc message;
72     private XmlField parent;
73
74     /**
75      * Default Constructor
76      */
77     public Rule()
78     {
79     }
80
81     /**
82      * Imports a column from an XML specification
83      */
84     public void loadFromXML (Attributes JavaDoc attrib)
85     {
86         setName(attrib.getValue("name"));
87         setValue(attrib.getValue("value"));
88     }
89
90     /**
91      * Set the name of the parameter
92      */
93     public void setName(String JavaDoc newName)
94     {
95         name = newName;
96     }
97     /**
98      * Get the name of the parameter
99      */
100     public String JavaDoc getName()
101     {
102         return name;
103     }
104
105     /**
106      * Set the value of the parameter
107      */
108     public void setValue(String JavaDoc newValue)
109     {
110         value = newValue;
111     }
112     /**
113      * Get the value of the parameter
114      */
115     public String JavaDoc getValue()
116     {
117         return value;
118     }
119
120     /**
121      * Set the error message
122      */
123     public void setMessage(String JavaDoc newMessage)
124     {
125         message = newMessage;
126     }
127
128     /**
129      * Get the error message
130      */
131     public String JavaDoc getMessage()
132     {
133         return message;
134     }
135
136     /**
137      * Set the parent Field of the rule
138      */
139     public void setField(XmlField parent)
140     {
141         this.parent = parent;
142     }
143
144     /**
145      * Get the parent Field of the rule
146      */
147     public XmlField getField()
148     {
149         return parent;
150     }
151
152     /**
153      * String representation of the column. This
154      * is an xml representation.
155      */
156     public String JavaDoc toString()
157     {
158         StringBuffer JavaDoc result = new StringBuffer JavaDoc(100);
159
160         result.append("<rule name=\""+name+"\"")
161               .append(" value=\""+value+"\"");
162
163
164         if (message == null)
165         {
166             result.append(" />\n");
167         }
168         else
169         {
170             result.append(">")
171                   .append(message)
172                   .append("</rule>\n");
173         }
174
175         return result.toString();
176     }
177
178 }
179
180
181
182
Popular Tags