KickJava   Java API By Example, From Geeks To Geeks.

Java > Open Source Codes > org > objectstyle > cayenne > exp > ListExpression


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
57 package org.objectstyle.cayenne.exp;
58
59 import java.io.PrintWriter JavaDoc;
60 import java.util.ArrayList JavaDoc;
61 import java.util.Collection JavaDoc;
62 import java.util.List JavaDoc;
63
64 import org.apache.commons.collections.Transformer;
65
66 /**
67  * An expression with a varying number of operands. Usually this is
68  * used for the list expressions when the list size may vary.
69  *
70  * @author Andrei Adamchik
71  */

72 public class ListExpression extends Expression {
73     protected List JavaDoc operands = new ArrayList JavaDoc();
74
75     public ListExpression() {
76     }
77
78     public ListExpression(int type) {
79         this.type = type;
80     }
81     
82     protected void flattenTree() {
83         
84     }
85
86     protected boolean pruneNodeForPrunedChild(Object JavaDoc prunedChild) {
87         return false;
88     }
89
90     public Expression transform(Transformer transformer) {
91         Expression copy = super.transform(transformer);
92
93         if (!(copy instanceof ListExpression)) {
94             return copy;
95         }
96
97         // prune itself if the transformation resulted in
98
// no children or a single child
99
switch (copy.getOperandCount()) {
100             case 1 :
101                 return (Expression) copy.getOperand(0);
102             case 0 :
103                 return null;
104             default :
105                 return copy;
106         }
107     }
108
109     /**
110      * Creates a copy of this expression node, without copying children.
111      *
112      * @since 1.1
113      */

114     public Expression shallowCopy() {
115         return new ListExpression(type);
116     }
117
118     /**
119      * Returns the number of operands currently in the list.
120      */

121     public int getOperandCount() {
122         return operands.size();
123     }
124
125     /**
126      * @see org.objectstyle.cayenne.exp.Expression#getOperand(int)
127      */

128     public Object JavaDoc getOperand(int index) {
129         if (operands.size() <= index) {
130             throw new IllegalArgumentException JavaDoc(
131                 "Attempt to retrieve operand "
132                     + index
133                     + ", while current number of operands is "
134                     + operands.size());
135         }
136
137         return operands.get(index);
138     }
139
140     /**
141      *
142      */

143     public void setOperand(int index, Object JavaDoc value) {
144         if (operands.size() == index) {
145             appendOperand(value);
146         }
147         else if (operands.size() > index) {
148             operands.set(index, value);
149         }
150         else {
151             throw new IllegalArgumentException JavaDoc(
152                 "Attempt to set operand "
153                     + index
154                     + ", while current number of operands is "
155                     + operands.size());
156         }
157     }
158
159     public void appendOperand(Object JavaDoc value) {
160         operands.add(value);
161     }
162
163     public void appendOperands(Collection JavaDoc operands) {
164         this.operands.addAll(operands);
165     }
166
167     public void removeOperand(Object JavaDoc value) {
168         operands.remove(value);
169     }
170
171     /**
172      * In case requested expression type is the same as internal type,
173      * creates and returns a copy of this expression with the internal list of
174      * operands expanded with the new expression. If the type of expression is
175      * different from this, calls superclass's implementation.
176      */

177     public Expression joinExp(int type, Expression exp) {
178         if (type != this.type) {
179             return super.joinExp(type, exp);
180         }
181
182         // create a copy of self
183
ListExpression copy = new ListExpression();
184         copy.setType(type);
185         copy.appendOperands(operands);
186         copy.appendOperand(exp);
187
188         return copy;
189     }
190
191     /**
192      * @since 1.1
193      */

194     public void encodeAsString(PrintWriter JavaDoc pw) {
195         // this class will be deprecated soon, so using
196
// a deprecated "toStringBuffer" is OK
197
StringBuffer JavaDoc buffer = new StringBuffer JavaDoc();
198         toStringBuffer(buffer);
199         pw.print(buffer.toString());
200     }
201 }
202
Popular Tags