KickJava   Java API By Example, From Geeks To Geeks.

Java > Open Source Codes > org > objectstyle > cayenne > exp > parser > ASTList


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.exp.parser;
57
58 import java.io.PrintWriter JavaDoc;
59 import java.util.ArrayList JavaDoc;
60 import java.util.Collection JavaDoc;
61 import java.util.Iterator JavaDoc;
62 import java.util.List JavaDoc;
63
64 import org.objectstyle.cayenne.exp.Expression;
65
66 /**
67  * A leaf expression representing an immutable collection of values.
68  *
69  * @since 1.1
70  * @author Andrei Adamchik
71  */

72 public class ASTList extends SimpleNode {
73     protected Object JavaDoc[] values;
74
75     ASTList(int id) {
76         super(id);
77     }
78
79     public ASTList() {
80         super(ExpressionParserTreeConstants.JJTLIST);
81     }
82
83     /**
84      * Initializes a list expression with an Object[].
85      */

86     public ASTList(Object JavaDoc[] objects) {
87         super(ExpressionParserTreeConstants.JJTLIST);
88         setValues(objects);
89     }
90
91     /**
92      * Initializes a list expression with a Java Collection
93      */

94     public ASTList(Collection JavaDoc objects) {
95         super(ExpressionParserTreeConstants.JJTLIST);
96         setValues(objects);
97     }
98
99     /**
100      * Initializes a list expression with a Java Iterator.
101      */

102     public ASTList(Iterator JavaDoc objects) {
103         super(ExpressionParserTreeConstants.JJTLIST);
104         setValues(objects);
105     }
106
107     /**
108      * Creates a copy of this expression node, without copying children.
109      */

110     public Expression shallowCopy() {
111         return new ASTList(id);
112     }
113
114     protected Object JavaDoc evaluateNode(Object JavaDoc o) throws Exception JavaDoc {
115         return values;
116     }
117
118     public int getType() {
119         return Expression.LIST;
120     }
121
122     protected String JavaDoc getExpressionOperator(int index) {
123         return ",";
124     }
125
126     public void encodeAsString(PrintWriter JavaDoc pw) {
127         pw.print('(');
128
129         if ((values != null) && (values.length > 0)) {
130             for (int i = 0; i < values.length; ++i) {
131                 if (i > 0) {
132                     pw.print(getExpressionOperator(i));
133                     pw.print(' ');
134                 }
135
136                 if (values[i] instanceof Expression) {
137                     ((Expression) values[i]).encodeAsString(pw);
138                 }
139                 else {
140                     encodeScalarAsString(pw, values[i]);
141                 }
142             }
143         }
144
145         pw.print(')');
146     }
147
148     public int getOperandCount() {
149         return 1;
150     }
151
152     public Object JavaDoc getOperand(int index) {
153         if (index == 0) {
154             return values;
155         }
156
157         throw new ArrayIndexOutOfBoundsException JavaDoc(index);
158     }
159
160     public void setOperand(int index, Object JavaDoc value) {
161         if (index != 0) {
162             throw new ArrayIndexOutOfBoundsException JavaDoc(index);
163         }
164
165         setValues(value);
166     }
167
168     /**
169      * Sets an internal collection of values. Value argument
170      * can be an Object[], a Collection or an iterator.
171      */

172     protected void setValues(Object JavaDoc value) {
173         if (value == null) {
174             this.values = null;
175         }
176         else if (value instanceof Object JavaDoc[]) {
177             this.values = (Object JavaDoc[]) value;
178         }
179         else if (value instanceof Collection JavaDoc) {
180             this.values = ((Collection JavaDoc) value).toArray();
181         }
182         else if (value instanceof Iterator JavaDoc) {
183             List JavaDoc values = new ArrayList JavaDoc();
184             Iterator JavaDoc it = (Iterator JavaDoc) value;
185             while (it.hasNext()) {
186                 values.add(it.next());
187             }
188
189             this.values = values.toArray();
190         }
191         else {
192             throw new IllegalArgumentException JavaDoc(
193                 "Invalid value class '"
194                     + value.getClass().getName()
195                     + "', expected null, Object[], Collection, Iterator");
196         }
197     }
198
199     public void jjtClose() {
200         super.jjtClose();
201
202         // For backwards compatibility set a List value wrapping the nodes.
203
// or maybe we should rewrite the parser spec to insert children
204
// directly into internal collection?
205
int size = jjtGetNumChildren();
206         Object JavaDoc[] listValue = new Object JavaDoc[size];
207         for (int i = 0; i < size; i++) {
208             listValue[i] = unwrapChild(jjtGetChild(i));
209         }
210
211         setValues(listValue);
212
213         // clean children - we are not supposed to use them anymore
214
children = null;
215     }
216 }
217
Popular Tags