KickJava   Java API By Example, From Geeks To Geeks.

Java > Open Source Codes > org > objectstyle > cayenne > map > ProcedureParameter


1 /* ====================================================================
2  *
3  * The ObjectStyle Group Software License, version 1.1
4  * ObjectStyle Group - http://objectstyle.org/
5  *
6  * Copyright (c) 2002-2005, Andrei (Andrus) Adamchik and individual authors
7  * of the software. All rights 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, if any,
22  * must include the following acknowlegement:
23  * "This product includes software developed by independent contributors
24  * and hosted on ObjectStyle Group web site (http://objectstyle.org/)."
25  * Alternately, this acknowlegement may appear in the software itself,
26  * if and wherever such third-party acknowlegements normally appear.
27  *
28  * 4. The names "ObjectStyle Group" and "Cayenne" must not be used to endorse
29  * or promote products derived from this software without prior written
30  * permission. For written permission, email
31  * "andrus at objectstyle dot org".
32  *
33  * 5. Products derived from this software may not be called "ObjectStyle"
34  * or "Cayenne", nor may "ObjectStyle" or "Cayenne" appear in their
35  * names without prior written permission.
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 OBJECTSTYLE GROUP 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 and hosted on ObjectStyle Group web site. For more
53  * information on the ObjectStyle Group, please see
54  * <http://objectstyle.org/>.
55  */
56 package org.objectstyle.cayenne.map;
57
58 import org.objectstyle.cayenne.dba.TypesMapping;
59 import org.objectstyle.cayenne.util.Util;
60 import org.objectstyle.cayenne.util.XMLEncoder;
61 import org.objectstyle.cayenne.util.XMLSerializable;
62
63 /**
64  * A descriptor for the StoredProcedure parameter.
65  *
66  * @author Andrei Adamchik
67  */
68 public class ProcedureParameter extends MapObject implements XMLSerializable {
69     public static final int IN_OUT_PARAMETER = 3;
70     public static final int IN_PARAMETER = 1;
71     public static final int OUT_PARAMETER = 2;
72
73     protected int direction = -1;
74
75     // The length of CHAR or VARCHAR or max num of digits for DECIMAL.
76 protected int maxLength = -1;
77
78     // The number of digits after period for DECIMAL.
79 protected int precision = -1;
80     protected int type = TypesMapping.NOT_DEFINED;
81
82     /**
83      * Constructor for ProcedureParam.
84      */
85     public ProcedureParameter() {
86         super();
87     }
88
89     public ProcedureParameter(String JavaDoc name) {
90         super(name);
91     }
92
93     public ProcedureParameter(String JavaDoc name, int type, int direction) {
94         super(name);
95         setType(type);
96         setDirection(direction);
97     }
98
99     /**
100      * Prints itself as XML to the provided PrintWriter.
101      *
102      * @since 1.1
103      */
104     public void encodeAsXML(XMLEncoder encoder) {
105         encoder.print("<procedure-parameter name=\"" + Util.encodeXmlAttribute(getName()) + '\"');
106
107         String JavaDoc type = TypesMapping.getSqlNameByType(getType());
108         if (type != null) {
109             encoder.print(" type=\"" + type + '\"');
110         }
111
112         if (getMaxLength() > 0) {
113             encoder.print(" length=\"");
114             encoder.print(getMaxLength());
115             encoder.print('\"');
116         }
117
118         if (getPrecision() > 0) {
119             encoder.print(" precision=\"");
120             encoder.print(getPrecision());
121             encoder.print('\"');
122         }
123
124         int direction = getDirection();
125         if (direction == ProcedureParameter.IN_PARAMETER) {
126             encoder.print(" direction=\"in\"");
127         }
128         else if (direction == ProcedureParameter.IN_OUT_PARAMETER) {
129             encoder.print(" direction=\"in_out\"");
130         }
131         else if (direction == ProcedureParameter.OUT_PARAMETER) {
132             encoder.print(" direction=\"out\"");
133         }
134
135         encoder.println("/>");
136     }
137
138     /**
139      * Returns the direction of this parameter. Possible values
140      * can be IN_PARAMETER, OUT_PARAMETER, IN_OUT_PARAMETER, VOID_PARAMETER.
141      */
142     public int getDirection() {
143         return direction;
144     }
145
146     /** Returns the procedure that holds this parameter. */
147     public Procedure getEntity() {
148         return (Procedure) getParent();
149     }
150
151     public int getMaxLength() {
152         return maxLength;
153     }
154
155     public int getPrecision() {
156         return precision;
157     }
158
159     public int getType() {
160         return type;
161     }
162
163     /**
164      * @return <code>true</code> if this is IN or INOUT parameter.
165      */
166     public boolean isInParameter() {
167         return direction == IN_PARAMETER || direction == IN_OUT_PARAMETER;
168     }
169
170     /**
171      * @return <code>true</code> if this is OUT or INOUT parameter.
172      */
173     public boolean isOutParam() {
174         return direction == OUT_PARAMETER || direction == IN_OUT_PARAMETER;
175     }
176
177     /**
178      * Sets the direction of this parameter. Acceptable values of direction are
179      * defined as int constants in ProcedureParam class. If an attempt is
180      * made to set an invalid attribute's direction, an IllegalArgumentException
181      * is thrown by this method.
182      */
183     public void setDirection(int direction) {
184         if (direction != IN_PARAMETER
185             && direction != OUT_PARAMETER
186             && direction != IN_OUT_PARAMETER) {
187             throw new IllegalArgumentException JavaDoc("Unknown parameter type: " + direction);
188         }
189
190         this.direction = direction;
191     }
192
193     public void setMaxLength(int i) {
194         maxLength = i;
195     }
196
197     public void setPrecision(int i) {
198         precision = i;
199     }
200
201     public void setType(int i) {
202         type = i;
203     }
204
205     /** Returns the procedure that holds this parameter. */
206     public Procedure getProcedure() {
207         return (Procedure) getParent();
208     }
209
210     /** Sets the procedure that holds this parameter. */
211     public void setProcedure(Procedure procedure) {
212         setParent(procedure);
213     }
214 }
215
Popular Tags