summaryrefslogtreecommitdiff
path: root/src/main/java/com/amazon/carbonado/qe/EmptyQuery.java
blob: 6c597dbbc1029eb565c0e943dc8efc50086ec77a (plain)
1
2
3
4
5
6
7
8
9
10
11
12
13
14
15
16
17
18
19
20
21
22
23
24
25
26
27
28
29
30
31
32
33
34
35
36
37
38
39
40
41
42
43
44
45
46
47
48
49
50
51
52
53
54
55
56
57
58
59
60
61
62
63
64
65
66
67
68
69
70
71
72
73
74
75
76
77
78
79
80
81
82
83
84
85
86
87
88
89
90
91
92
93
94
95
96
97
98
99
100
101
102
103
104
105
106
107
108
109
110
111
112
113
114
115
116
117
118
119
120
121
122
123
124
125
126
127
128
129
130
131
132
133
134
135
136
137
138
139
140
141
142
143
144
145
146
147
148
149
150
151
152
153
154
155
156
157
158
159
160
161
162
163
164
165
166
167
168
169
170
171
172
173
174
175
176
177
178
179
180
181
182
183
184
185
186
187
188
189
190
191
192
193
194
195
196
197
198
199
200
201
202
203
204
205
206
207
208
209
210
211
212
213
214
215
216
217
218
219
220
221
222
223
224
225
226
227
228
229
230
231
232
233
234
235
236
237
238
239
240
241
242
243
244
245
246
247
248
249
250
251
252
253
254
255
256
257
258
259
260
261
262
263
264
265
266
267
268
269
270
271
272
273
274
275
276
277
278
279
280
281
282
283
284
285
286
287
288
289
290
291
292
293
294
295
296
297
298
299
300
301
302
303
304
305
306
307
308
309
310
311
312
313
314
315
316
317
318
319
320
321
322
323
324
325
326
327
328
329
330
331
332
333
334
335
336
337
338
339
340
341
342
343
344
345
346
347
348
349
350
351
352
353
354
355
356
357
358
359
360
361
362
363
364
365
366
367
368
369
370
371
372
373
374
375
376
377
378
379
380
381
382
383
384
385
386
387
388
389
390
391
392
393
394
395
396
397
398
399
400
401
/*
 * Copyright 2006-2012 Amazon Technologies, Inc. or its affiliates.
 * Amazon, Amazon.com and Carbonado are trademarks or registered trademarks
 * of Amazon Technologies, Inc. or its affiliates.  All rights reserved.
 *
 * Licensed under the Apache License, Version 2.0 (the "License");
 * you may not use this file except in compliance with the License.
 * You may obtain a copy of the License at
 *
 *     http://www.apache.org/licenses/LICENSE-2.0
 *
 * Unless required by applicable law or agreed to in writing, software
 * distributed under the License is distributed on an "AS IS" BASIS,
 * WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
 * See the License for the specific language governing permissions and
 * limitations under the License.
 */

package com.amazon.carbonado.qe;

import java.io.IOException;

import com.amazon.carbonado.Cursor;
import com.amazon.carbonado.FetchException;
import com.amazon.carbonado.PersistNoneException;
import com.amazon.carbonado.Storable;
import com.amazon.carbonado.Query;

import com.amazon.carbonado.cursor.EmptyCursor;

import com.amazon.carbonado.filter.Filter;
import com.amazon.carbonado.filter.FilterValues;

/**
 * Special query implementation that fetches nothing.
 *
 * @author Brian S O'Neill
 */
public final class EmptyQuery<S extends Storable> extends AbstractQuery<S> {
    private final QueryFactory<S> mFactory;

    // Properties that this query is ordered by.
    private final OrderingList<S> mOrdering;

    /**
     * @param factory required query factory, used by 'or' and 'not' methods
     * @param ordering optional order-by properties
     */
    public EmptyQuery(QueryFactory<S> factory, OrderingList<S> ordering) {
        if (factory == null) {
            throw new IllegalArgumentException();
        }
        mFactory = factory;
        if (ordering == null) {
            ordering = OrderingList.emptyList();
        }
        mOrdering = ordering;
    }

    /**
     * @param factory required query factory, used by 'or' and 'not' methods
     * @param ordering optional order-by property
     */
    public EmptyQuery(QueryFactory<S> factory, String ordering) {
        this(factory, OrderingList.get(factory.getStorableType(), ordering));
    }

    /**
     * @param factory required query factory, used by 'or' and 'not' methods
     * @param orderings optional order-by properties
     */
    public EmptyQuery(QueryFactory<S> factory, String... orderings) {
        this(factory, OrderingList.get(factory.getStorableType(), orderings));
    }

    /**
     * Used only by test suite. Query throws NullPointerException when invoked.
     */
    EmptyQuery() {
        mFactory = null;
        mOrdering = OrderingList.emptyList();
    }

    @Override
    public Class<S> getStorableType() {
        return mFactory.getStorableType();
    }

    /**
     * Always returns a {@link com.amazon.carbonado.filter.ClosedFilter ClosedFilter}.
     */
    @Override
    public Filter<S> getFilter() {
        return Filter.getClosedFilter(getStorableType());
    }

    /**
     * Always returns null.
     */
    @Override
    public FilterValues<S> getFilterValues() {
        return null;
    }

    /**
     * Always returns zero.
     */
    @Override
    public int getBlankParameterCount() {
        return 0;
    }

    /**
     * Always throws an IllegalStateException.
     */
    @Override
    public Query<S> with(int value) {
        throw error();
    }

    /**
     * Always throws an IllegalStateException.
     */
    @Override
    public Query<S> with(long value) {
        throw error();
    }

    /**
     * Always throws an IllegalStateException.
     */
    @Override
    public Query<S> with(float value) {
        throw error();
    }

    /**
     * Always throws an IllegalStateException.
     */
    @Override
    public Query<S> with(double value) {
        throw error();
    }

    /**
     * Always throws an IllegalStateException.
     */
    @Override
    public Query<S> with(boolean value) {
        throw error();
    }

    /**
     * Always throws an IllegalStateException.
     */
    @Override
    public Query<S> with(char value) {
        throw error();
    }

    /**
     * Always throws an IllegalStateException.
     */
    @Override
    public Query<S> with(byte value) {
        throw error();
    }

    /**
     * Always throws an IllegalStateException.
     */
    @Override
    public Query<S> with(short value) {
        throw error();
    }

    /**
     * Always throws an IllegalStateException.
     */
    @Override
    public Query<S> with(Object value) {
        throw error();
    }

    /**
     * Throws an IllegalStateException unless no values passed in.
     */
    @Override
    public Query<S> withValues(Object... values) {
        if (values == null || values.length == 0) {
            return this;
        }
        throw error();
    }

    /**
     * Always throws an IllegalStateException.
     */
    @Override
    public Query<S> and(Filter<S> filter) {
        throw new IllegalStateException("Query is already guaranteed to fetch nothing");
    }

    @Override
    public Query<S> or(Filter<S> filter) throws FetchException {
        return mFactory.query(filter, null, mOrdering, null);
    }

    /**
     * Returns a query that fetches everything, possibly in a specified order.
     */
    @Override
    public Query<S> not() throws FetchException {
        return mFactory.query(null, null, mOrdering, null);
    }

    @Override
    public Query<S> orderBy(String property) throws FetchException {
        return new EmptyQuery<S>(mFactory, property);
    }

    @Override
    public Query<S> orderBy(String... properties) throws FetchException {
        return new EmptyQuery<S>(mFactory, properties);
    }

    @Override
    public <T extends S> Query<S> after(T start) {
        return this;
    }

    /**
     * Always returns an {@link EmptyCursor}.
     */
    @Override
    public Cursor<S> fetch() {
        return EmptyCursor.the();
    }

    /**
     * Always returns an {@link EmptyCursor}.
     */
    @Override
    public Cursor<S> fetch(Controller controller) {
        return EmptyCursor.the();
    }

    /**
     * Always returns an {@link EmptyCursor}.
     */
    @Override
    public Cursor<S> fetchSlice(long from, Long to) {
        checkSliceArguments(from, to);
        return EmptyCursor.the();
    }

    /**
     * Always returns an {@link EmptyCursor}.
     */
    @Override
    public Cursor<S> fetchSlice(long from, Long to, Controller controller) {
        return fetchSlice(from, to);
    }

    /**
     * Always throws {@link PersistNoneException}.
     */
    @Override
    public void deleteOne() throws PersistNoneException {
        throw new PersistNoneException();
    }

    /**
     * Always throws {@link PersistNoneException}.
     */
    @Override
    public void deleteOne(Controller controller) throws PersistNoneException {
        throw new PersistNoneException();
    }

    /**
     * Always returns false.
     */
    @Override
    public boolean tryDeleteOne() {
        return false;
    }

    /**
     * Always returns false.
     */
    @Override
    public boolean tryDeleteOne(Controller controller) {
        return false;
    }

    /**
     * Does nothing.
     */
    @Override
    public void deleteAll() {
    }

    /**
     * Does nothing.
     */
    @Override
    public void deleteAll(Controller controller) {
    }

    /**
     * Always returns zero.
     */
    @Override
    public long count() {
        return 0;
    }

    /**
     * Always returns zero.
     */
    @Override
    public long count(Controller controller) {
        return 0;
    }

    /**
     * Always returns false.
     */
    @Override
    public boolean exists() {
        return false;
    }

    /**
     * Always returns false.
     */
    @Override
    public boolean exists(Controller controller) {
        return false;
    }

    @Override
    public void appendTo(Appendable app) throws IOException {
        app.append("Query {type=");
        app.append(getStorableType().getName());
        app.append(", filter=");
        getFilter().appendTo(app);

        if (mOrdering != null && mOrdering.size() > 0) {
            app.append(", orderBy=[");
            for (int i=0; i<mOrdering.size(); i++) {
                if (i > 0) {
                    app.append(", ");
                }
                app.append(mOrdering.get(i).toString());
            }
            app.append(']');
        }

        app.append('}');
    }

    /**
     * Always returns false.
     */
    @Override
    public boolean printNative(Appendable app, int indentLevel) {
        return false;
    }

    /**
     * Always returns false.
     */
    @Override
    public boolean printPlan(Appendable app, int indentLevel) {
        return false;
    }

    @Override
    public int hashCode() {
        return mFactory.hashCode() * 31 + mOrdering.hashCode();
    }

    @Override
    public boolean equals(Object obj) {
        if (this == obj) {
            return true;
        }
        if (obj instanceof EmptyQuery) {
            EmptyQuery<?> other = (EmptyQuery<?>) obj;
            return mFactory.equals(other.mFactory)
                && mOrdering.equals(other.mOrdering);
        }
        return false;
    }

    private IllegalStateException error() {
        return new IllegalStateException("Query doesn't have any parameters");
    }
}