1*b1cdbd2cSJim Jagielski /**************************************************************
2*b1cdbd2cSJim Jagielski  *
3*b1cdbd2cSJim Jagielski  * Licensed to the Apache Software Foundation (ASF) under one
4*b1cdbd2cSJim Jagielski  * or more contributor license agreements.  See the NOTICE file
5*b1cdbd2cSJim Jagielski  * distributed with this work for additional information
6*b1cdbd2cSJim Jagielski  * regarding copyright ownership.  The ASF licenses this file
7*b1cdbd2cSJim Jagielski  * to you under the Apache License, Version 2.0 (the
8*b1cdbd2cSJim Jagielski  * "License"); you may not use this file except in compliance
9*b1cdbd2cSJim Jagielski  * with the License.  You may obtain a copy of the License at
10*b1cdbd2cSJim Jagielski  *
11*b1cdbd2cSJim Jagielski  *   http://www.apache.org/licenses/LICENSE-2.0
12*b1cdbd2cSJim Jagielski  *
13*b1cdbd2cSJim Jagielski  * Unless required by applicable law or agreed to in writing,
14*b1cdbd2cSJim Jagielski  * software distributed under the License is distributed on an
15*b1cdbd2cSJim Jagielski  * "AS IS" BASIS, WITHOUT WARRANTIES OR CONDITIONS OF ANY
16*b1cdbd2cSJim Jagielski  * KIND, either express or implied.  See the License for the
17*b1cdbd2cSJim Jagielski  * specific language governing permissions and limitations
18*b1cdbd2cSJim Jagielski  * under the License.
19*b1cdbd2cSJim Jagielski  *
20*b1cdbd2cSJim Jagielski  *************************************************************/
21*b1cdbd2cSJim Jagielski 
22*b1cdbd2cSJim Jagielski 
23*b1cdbd2cSJim Jagielski 
24*b1cdbd2cSJim Jagielski package ifc.sdb;
25*b1cdbd2cSJim Jagielski 
26*b1cdbd2cSJim Jagielski import com.sun.star.sdb.XSingleSelectQueryAnalyzer;
27*b1cdbd2cSJim Jagielski import lib.MultiMethodTest;
28*b1cdbd2cSJim Jagielski import com.sun.star.sdb.XSingleSelectQueryComposer;
29*b1cdbd2cSJim Jagielski import com.sun.star.uno.UnoRuntime;
30*b1cdbd2cSJim Jagielski import lib.StatusException;
31*b1cdbd2cSJim Jagielski import lib.Status;
32*b1cdbd2cSJim Jagielski import com.sun.star.beans.PropertyValue;
33*b1cdbd2cSJim Jagielski import com.sun.star.container.XIndexAccess;
34*b1cdbd2cSJim Jagielski 
35*b1cdbd2cSJim Jagielski /**
36*b1cdbd2cSJim Jagielski * Testing <code>com.sun.star.sdb.XSingleSelectQueryAnalyzer</code>
37*b1cdbd2cSJim Jagielski * interface methods :
38*b1cdbd2cSJim Jagielski * <ul>
39*b1cdbd2cSJim Jagielski *  <li><code>getQuery()</code></li>
40*b1cdbd2cSJim Jagielski *  <li><code>setQuery()</code></li>
41*b1cdbd2cSJim Jagielski *  <li><code>getFilter()</code></li>
42*b1cdbd2cSJim Jagielski *  <li><code>getStructuredFilter()</code></li>
43*b1cdbd2cSJim Jagielski *  <li><code>getGroup()</code></li>
44*b1cdbd2cSJim Jagielski *  <li><code>getGroupColumns()</code></li>
45*b1cdbd2cSJim Jagielski *  <li><code>getHavingClause()</code></li>
46*b1cdbd2cSJim Jagielski *  <li><code>getStructuredHavingClause()</code></li>
47*b1cdbd2cSJim Jagielski *  <li><code>getOrder()</code></li>
48*b1cdbd2cSJim Jagielski *  <li><code>getOrderColumns()</code></li>
49*b1cdbd2cSJim Jagielski 
50*b1cdbd2cSJim Jagielski * </ul> <p>
51*b1cdbd2cSJim Jagielski * @see com.sun.star.sdb.XSingleSelectQueryAnalyzer
52*b1cdbd2cSJim Jagielski */
53*b1cdbd2cSJim Jagielski public class _XSingleSelectQueryAnalyzer extends MultiMethodTest {
54*b1cdbd2cSJim Jagielski 
55*b1cdbd2cSJim Jagielski     // oObj filled by MultiMethodTest
56*b1cdbd2cSJim Jagielski     public XSingleSelectQueryAnalyzer oObj = null ;
57*b1cdbd2cSJim Jagielski 
58*b1cdbd2cSJim Jagielski     private String queryString = "SELECT * FROM \"biblio\"";
59*b1cdbd2cSJim Jagielski 
60*b1cdbd2cSJim Jagielski     private XSingleSelectQueryComposer xComposer = null;
61*b1cdbd2cSJim Jagielski 
62*b1cdbd2cSJim Jagielski     /**
63*b1cdbd2cSJim Jagielski      * Recieves the object relations:
64*b1cdbd2cSJim Jagielski     * <ul>
65*b1cdbd2cSJim Jagielski     *  <li><code>XSingleSelectQueryComposer xCompoer</code></li>
66*b1cdbd2cSJim Jagielski     * </ul> <p>
67*b1cdbd2cSJim Jagielski      * @see com.sun.star.sdb.XSingleSelectQueryComposer
68*b1cdbd2cSJim Jagielski      */
before()69*b1cdbd2cSJim Jagielski     protected void before() {
70*b1cdbd2cSJim Jagielski 
71*b1cdbd2cSJim Jagielski         xComposer = (XSingleSelectQueryComposer)
72*b1cdbd2cSJim Jagielski                       UnoRuntime.queryInterface(XSingleSelectQueryComposer.class,
73*b1cdbd2cSJim Jagielski                       tEnv.getObjRelation("xComposer"));
74*b1cdbd2cSJim Jagielski 
75*b1cdbd2cSJim Jagielski         if (xComposer == null) {
76*b1cdbd2cSJim Jagielski             throw new StatusException(Status.failed(
77*b1cdbd2cSJim Jagielski            "Couldn't get object relation 'xComposer'. Test must be modified"));
78*b1cdbd2cSJim Jagielski 
79*b1cdbd2cSJim Jagielski         }
80*b1cdbd2cSJim Jagielski 
81*b1cdbd2cSJim Jagielski     }
82*b1cdbd2cSJim Jagielski     /**
83*b1cdbd2cSJim Jagielski     * call <code>setQuery()</code> once with valid query, once with invalid
84*b1cdbd2cSJim Jagielski     * query. Has ok if only on sceond call <code>SQLException</code> was thrwon
85*b1cdbd2cSJim Jagielski     */
_setQuery()86*b1cdbd2cSJim Jagielski     public void _setQuery() {
87*b1cdbd2cSJim Jagielski 
88*b1cdbd2cSJim Jagielski         try{
89*b1cdbd2cSJim Jagielski             oObj.setQuery("This is an invalid SQL query");
90*b1cdbd2cSJim Jagielski         } catch (com.sun.star.sdbc.SQLException e){
91*b1cdbd2cSJim Jagielski             log.println("expected Exception. ");
92*b1cdbd2cSJim Jagielski         }
93*b1cdbd2cSJim Jagielski 
94*b1cdbd2cSJim Jagielski         try{
95*b1cdbd2cSJim Jagielski             oObj.setQuery(queryString);
96*b1cdbd2cSJim Jagielski         } catch (com.sun.star.sdbc.SQLException e){
97*b1cdbd2cSJim Jagielski             log.println("unexpected Exception: " + e.toString());
98*b1cdbd2cSJim Jagielski             tRes.tested("setQuery()", false);
99*b1cdbd2cSJim Jagielski         }
100*b1cdbd2cSJim Jagielski         tRes.tested("setQuery()", true);
101*b1cdbd2cSJim Jagielski     }
102*b1cdbd2cSJim Jagielski 
103*b1cdbd2cSJim Jagielski     /**
104*b1cdbd2cSJim Jagielski     * checks of the returned value of <code>getQuery()</code>
105*b1cdbd2cSJim Jagielski     * equals the string which was set by <code>setQuery()</code>
106*b1cdbd2cSJim Jagielski     * <p>
107*b1cdbd2cSJim Jagielski     * required methods:
108*b1cdbd2cSJim Jagielski     *<ul>
109*b1cdbd2cSJim Jagielski     * <li><code>setQuery</code></li>
110*b1cdbd2cSJim Jagielski     *</ul>
111*b1cdbd2cSJim Jagielski     */
_getQuery()112*b1cdbd2cSJim Jagielski     public void _getQuery() {
113*b1cdbd2cSJim Jagielski         this.requiredMethod("setQuery()");
114*b1cdbd2cSJim Jagielski 
115*b1cdbd2cSJim Jagielski         boolean res = false;
116*b1cdbd2cSJim Jagielski 
117*b1cdbd2cSJim Jagielski         res = oObj.getQuery().equals(queryString);
118*b1cdbd2cSJim Jagielski 
119*b1cdbd2cSJim Jagielski         tRes.tested("getQuery()", res);
120*b1cdbd2cSJim Jagielski     }
121*b1cdbd2cSJim Jagielski 
122*b1cdbd2cSJim Jagielski 
123*b1cdbd2cSJim Jagielski     /**
124*b1cdbd2cSJim Jagielski     * Object relation <code>xComposer</code> set a filter. This filter
125*b1cdbd2cSJim Jagielski     * must returned while calling <code>getFilter</code>
126*b1cdbd2cSJim Jagielski     */
_getFilter()127*b1cdbd2cSJim Jagielski     public void _getFilter() {
128*b1cdbd2cSJim Jagielski         try{
129*b1cdbd2cSJim Jagielski             String filter = "\"Identifier\" = 'BOR02b'";
130*b1cdbd2cSJim Jagielski             xComposer.setFilter(filter);
131*b1cdbd2cSJim Jagielski             tRes.tested("getFilter()", (oObj.getFilter().equals(filter)));
132*b1cdbd2cSJim Jagielski 
133*b1cdbd2cSJim Jagielski         } catch (com.sun.star.sdbc.SQLException e){
134*b1cdbd2cSJim Jagielski             log.println("unexpected Exception: " + e.toString());
135*b1cdbd2cSJim Jagielski             tRes.tested("getFilter()", false);
136*b1cdbd2cSJim Jagielski         }
137*b1cdbd2cSJim Jagielski     }
138*b1cdbd2cSJim Jagielski 
139*b1cdbd2cSJim Jagielski     /**
140*b1cdbd2cSJim Jagielski     * Object relation <code>xComposer</code> set a complex filter with method
141*b1cdbd2cSJim Jagielski     . <code>setFilter</code>. Then <code>getStructuredFilter</code> returns a
142*b1cdbd2cSJim Jagielski     * sequenze of <code>PropertyValue</code> which was set with method
143*b1cdbd2cSJim Jagielski     * <code>setStructuredFilter</code> from <xComposer>.
144*b1cdbd2cSJim Jagielski     * Then test has ok status if <getFilter> returns the complex filter.
145*b1cdbd2cSJim Jagielski     * <p>
146*b1cdbd2cSJim Jagielski     * required methods:
147*b1cdbd2cSJim Jagielski     *<ul>
148*b1cdbd2cSJim Jagielski     * <li><code>setQuery</code></li>
149*b1cdbd2cSJim Jagielski     * <li><code>getFilter</code></li>
150*b1cdbd2cSJim Jagielski     *</ul>
151*b1cdbd2cSJim Jagielski     */
_getStructuredFilter()152*b1cdbd2cSJim Jagielski     public void _getStructuredFilter() {
153*b1cdbd2cSJim Jagielski         requiredMethod("setQuery()");
154*b1cdbd2cSJim Jagielski         requiredMethod("getFilter()");
155*b1cdbd2cSJim Jagielski         try{
156*b1cdbd2cSJim Jagielski             oObj.setQuery("SELECT \"Identifier\", \"Type\", \"Address\" FROM \"biblio\" \"biblio\"");
157*b1cdbd2cSJim Jagielski             String complexFilter = "( \"Identifier\" = '1' AND \"Type\" = '4' ) OR ( \"Identifier\" = '2' AND \"Type\" = '5' ) OR ( \"Identifier\" = '3' AND \"Type\" = '6' AND \"Address\" = '7' ) OR ( \"Address\" = '8' ) OR ( \"Type\" = '9' )";
158*b1cdbd2cSJim Jagielski             xComposer.setFilter(complexFilter);
159*b1cdbd2cSJim Jagielski             PropertyValue[][] aStructuredFilter = oObj.getStructuredFilter();
160*b1cdbd2cSJim Jagielski             xComposer.setFilter("");
161*b1cdbd2cSJim Jagielski             xComposer.setStructuredFilter(aStructuredFilter);
162*b1cdbd2cSJim Jagielski             tRes.tested("getStructuredFilter()", (oObj.getFilter().equals(complexFilter)));
163*b1cdbd2cSJim Jagielski 
164*b1cdbd2cSJim Jagielski         } catch (com.sun.star.sdbc.SQLException e){
165*b1cdbd2cSJim Jagielski             log.println("unexpected Exception: " + e.toString());
166*b1cdbd2cSJim Jagielski             tRes.tested("getStructuredFilter()", false);
167*b1cdbd2cSJim Jagielski         } catch (com.sun.star.lang.IllegalArgumentException e){
168*b1cdbd2cSJim Jagielski             log.println("unexpected Exception: " + e.toString());
169*b1cdbd2cSJim Jagielski             tRes.tested("getStructuredFilter()", false);
170*b1cdbd2cSJim Jagielski         }
171*b1cdbd2cSJim Jagielski     }
172*b1cdbd2cSJim Jagielski 
173*b1cdbd2cSJim Jagielski     /**
174*b1cdbd2cSJim Jagielski     * Object relation <code>xComposer</code> set a goup. This group
175*b1cdbd2cSJim Jagielski     * must returned while calling <code>getGroup</code>
176*b1cdbd2cSJim Jagielski     */
_getGroup()177*b1cdbd2cSJim Jagielski     public void _getGroup() {
178*b1cdbd2cSJim Jagielski         try{
179*b1cdbd2cSJim Jagielski             String group = "\"Identifier\"";
180*b1cdbd2cSJim Jagielski             xComposer.setGroup(group);
181*b1cdbd2cSJim Jagielski             tRes.tested("getGroup()", (oObj.getGroup().equals(group)));
182*b1cdbd2cSJim Jagielski 
183*b1cdbd2cSJim Jagielski         } catch (com.sun.star.sdbc.SQLException e){
184*b1cdbd2cSJim Jagielski             log.println("unexpected Exception: " + e.toString());
185*b1cdbd2cSJim Jagielski             tRes.tested("getGroup()", false);
186*b1cdbd2cSJim Jagielski         }
187*b1cdbd2cSJim Jagielski     }
188*b1cdbd2cSJim Jagielski 
189*b1cdbd2cSJim Jagielski     /**
190*b1cdbd2cSJim Jagielski     * Method <code>getGroupColumns</code> retunrs a <code>XIndexAccess</code>
191*b1cdbd2cSJim Jagielski     * Test has ok status if returned value is an useable <code>XIndexAccess</code>
192*b1cdbd2cSJim Jagielski     */
_getGroupColumns()193*b1cdbd2cSJim Jagielski     public void _getGroupColumns() {
194*b1cdbd2cSJim Jagielski         try{
195*b1cdbd2cSJim Jagielski            XIndexAccess xGroupColumns = oObj.getGroupColumns();
196*b1cdbd2cSJim Jagielski 
197*b1cdbd2cSJim Jagielski            tRes.tested("getGroupColumns()", (xGroupColumns != null &&
198*b1cdbd2cSJim Jagielski                                             xGroupColumns.getCount() == 1 &&
199*b1cdbd2cSJim Jagielski                                         xGroupColumns.getByIndex(0) != null));
200*b1cdbd2cSJim Jagielski 
201*b1cdbd2cSJim Jagielski         } catch (com.sun.star.lang.IndexOutOfBoundsException e){
202*b1cdbd2cSJim Jagielski             log.println("unexpected Exception: " + e.toString());
203*b1cdbd2cSJim Jagielski             tRes.tested("getGroupColumns()", false);
204*b1cdbd2cSJim Jagielski         } catch (com.sun.star.lang.WrappedTargetException e){
205*b1cdbd2cSJim Jagielski             log.println("unexpected Exception: " + e.toString());
206*b1cdbd2cSJim Jagielski             tRes.tested("getGroupColumns()", false);
207*b1cdbd2cSJim Jagielski         }
208*b1cdbd2cSJim Jagielski     }
209*b1cdbd2cSJim Jagielski 
210*b1cdbd2cSJim Jagielski     /**
211*b1cdbd2cSJim Jagielski     * Object relation <code>xComposer</code> set a clause. This clause
212*b1cdbd2cSJim Jagielski     * must returned while calling <code>getHavingClause</code>
213*b1cdbd2cSJim Jagielski     */
_getHavingClause()214*b1cdbd2cSJim Jagielski     public void _getHavingClause() {
215*b1cdbd2cSJim Jagielski         try{
216*b1cdbd2cSJim Jagielski             String clause = "\"Identifier\" = 'BOR02b'";
217*b1cdbd2cSJim Jagielski             xComposer.setHavingClause(clause);
218*b1cdbd2cSJim Jagielski             tRes.tested("getHavingClause()", (
219*b1cdbd2cSJim Jagielski                                         oObj.getHavingClause().equals(clause)));
220*b1cdbd2cSJim Jagielski 
221*b1cdbd2cSJim Jagielski         } catch (com.sun.star.sdbc.SQLException e){
222*b1cdbd2cSJim Jagielski             log.println("unexpected Exception: " + e.toString());
223*b1cdbd2cSJim Jagielski             tRes.tested("getHavingClause()", false);
224*b1cdbd2cSJim Jagielski         }
225*b1cdbd2cSJim Jagielski     }
226*b1cdbd2cSJim Jagielski 
227*b1cdbd2cSJim Jagielski     /**
228*b1cdbd2cSJim Jagielski     * Object relation <code>xComposer</code> set a clause. This clause
229*b1cdbd2cSJim Jagielski     * must returned while calling <code>getHavingClause</code>
230*b1cdbd2cSJim Jagielski     * <p>
231*b1cdbd2cSJim Jagielski     * required methods:
232*b1cdbd2cSJim Jagielski     *<ul>
233*b1cdbd2cSJim Jagielski     * <li><code>setQuery</code></li>
234*b1cdbd2cSJim Jagielski     * <li><code>getFilter</code></li>
235*b1cdbd2cSJim Jagielski     * <li><code>getStructuredFilter</code></li>
236*b1cdbd2cSJim Jagielski     *</ul>
237*b1cdbd2cSJim Jagielski     */
_getStructuredHavingClause()238*b1cdbd2cSJim Jagielski     public void _getStructuredHavingClause() {
239*b1cdbd2cSJim Jagielski         requiredMethod("setQuery()");
240*b1cdbd2cSJim Jagielski         requiredMethod("getFilter()");
241*b1cdbd2cSJim Jagielski         executeMethod("getStructuredFilter()");
242*b1cdbd2cSJim Jagielski         String complexFilter = "( \"Identifier\" = '1' AND \"Type\" = '4' ) OR ( \"Identifier\" = '2' AND \"Type\" = '5' ) OR ( \"Identifier\" = '3' AND \"Type\" = '6' AND \"Address\" = '7' ) OR ( \"Address\" = '8' ) OR ( \"Type\" = '9' )";
243*b1cdbd2cSJim Jagielski 
244*b1cdbd2cSJim Jagielski         try{
245*b1cdbd2cSJim Jagielski            xComposer.setHavingClause(complexFilter);
246*b1cdbd2cSJim Jagielski            PropertyValue[][] aStructuredHaving = oObj.getStructuredHavingClause();
247*b1cdbd2cSJim Jagielski            xComposer.setHavingClause("");
248*b1cdbd2cSJim Jagielski            xComposer.setStructuredHavingClause(aStructuredHaving);
249*b1cdbd2cSJim Jagielski            tRes.tested("getStructuredHavingClause()",
250*b1cdbd2cSJim Jagielski                                 (oObj.getHavingClause().equals(complexFilter)));
251*b1cdbd2cSJim Jagielski 
252*b1cdbd2cSJim Jagielski         } catch (com.sun.star.sdbc.SQLException e){
253*b1cdbd2cSJim Jagielski             log.println("unexpected Exception: " + e.toString());
254*b1cdbd2cSJim Jagielski             tRes.tested("getStructuredHavingClause()", false);
255*b1cdbd2cSJim Jagielski         }
256*b1cdbd2cSJim Jagielski     }
257*b1cdbd2cSJim Jagielski 
258*b1cdbd2cSJim Jagielski     /**
259*b1cdbd2cSJim Jagielski     * Object relation <code>xComposer</code> set an order. This order
260*b1cdbd2cSJim Jagielski     * must returned while calling <code>getOrder</code>
261*b1cdbd2cSJim Jagielski     */
_getOrder()262*b1cdbd2cSJim Jagielski     public void _getOrder() {
263*b1cdbd2cSJim Jagielski         try{
264*b1cdbd2cSJim Jagielski             String order = "\"Identifier\"";
265*b1cdbd2cSJim Jagielski             xComposer.setOrder(order);
266*b1cdbd2cSJim Jagielski             tRes.tested("getOrder()", (oObj.getOrder().equals(order)));
267*b1cdbd2cSJim Jagielski 
268*b1cdbd2cSJim Jagielski         } catch (com.sun.star.sdbc.SQLException e){
269*b1cdbd2cSJim Jagielski             log.println("unexpected Exception: " + e.toString());
270*b1cdbd2cSJim Jagielski             tRes.tested("getOrder()", false);
271*b1cdbd2cSJim Jagielski         }
272*b1cdbd2cSJim Jagielski     }
273*b1cdbd2cSJim Jagielski 
274*b1cdbd2cSJim Jagielski     /**
275*b1cdbd2cSJim Jagielski     * Method <code>getGroupColumns</code> retunrs a <code>XIndexAccess</code>
276*b1cdbd2cSJim Jagielski     * Test has ok status if returned value is an useable <code>XIndexAccess</code>
277*b1cdbd2cSJim Jagielski     */
_getOrderColumns()278*b1cdbd2cSJim Jagielski     public void _getOrderColumns() {
279*b1cdbd2cSJim Jagielski         try{
280*b1cdbd2cSJim Jagielski             XIndexAccess xOrderColumns = oObj.getOrderColumns();
281*b1cdbd2cSJim Jagielski             tRes.tested("getOrderColumns()", (xOrderColumns != null &&
282*b1cdbd2cSJim Jagielski                                               xOrderColumns.getCount() == 1 &&
283*b1cdbd2cSJim Jagielski                                          xOrderColumns.getByIndex(0) != null));
284*b1cdbd2cSJim Jagielski 
285*b1cdbd2cSJim Jagielski         } catch (com.sun.star.lang.IndexOutOfBoundsException e){
286*b1cdbd2cSJim Jagielski             log.println("unexpected Exception: " + e.toString());
287*b1cdbd2cSJim Jagielski             tRes.tested("getOrderColumns()", false);
288*b1cdbd2cSJim Jagielski         } catch (com.sun.star.lang.WrappedTargetException e){
289*b1cdbd2cSJim Jagielski             log.println("unexpected Exception: " + e.toString());
290*b1cdbd2cSJim Jagielski             tRes.tested("getOrderColumns()", false);
291*b1cdbd2cSJim Jagielski         }
292*b1cdbd2cSJim Jagielski     }
293*b1cdbd2cSJim Jagielski 
294*b1cdbd2cSJim Jagielski 
295*b1cdbd2cSJim Jagielski }  // finish class _XSingleSelectQueryAnalyzer
296