summaryrefslogtreecommitdiff
path: root/core/src/main/java/org/elasticsearch/index/query/EmptyQueryBuilder.java
blob: 7d1761a44b21fc72973b75dd21d391eb9a2da791 (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
/*
 * Licensed to Elasticsearch under one or more contributor
 * license agreements. See the NOTICE file distributed with
 * this work for additional information regarding copyright
 * ownership. Elasticsearch licenses this file to you 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 org.elasticsearch.index.query;

import org.apache.lucene.search.Query;
import org.elasticsearch.action.support.ToXContentToBytes;
import org.elasticsearch.common.io.stream.StreamInput;
import org.elasticsearch.common.io.stream.StreamOutput;
import org.elasticsearch.common.xcontent.XContentBuilder;
import org.elasticsearch.common.xcontent.XContentType;

import java.io.IOException;

/**
 * A {@link QueryBuilder} that is a stand in replacement for an empty query clause in the DSL.
 * The current DSL allows parsing inner queries / filters like "{ }", in order to have a
 * valid non-null representation of these clauses that actually do nothing we can use this class.
 *
 * This builder has no corresponding parser and it is not registered under the query name. It is
 * intended to be used internally as a stand-in for nested queries that are left empty and should
 * be ignored upstream.
 */
public class EmptyQueryBuilder extends ToXContentToBytes implements QueryBuilder<EmptyQueryBuilder> {

    public static final String NAME = "empty_query";

    /** the one and only empty query builder */
    public static final EmptyQueryBuilder PROTOTYPE = new EmptyQueryBuilder();

    // prevent instances other than prototype
    private EmptyQueryBuilder() {
        super(XContentType.JSON);
    }

    @Override
    public String getWriteableName() {
        return NAME;
    }

    @Override
    public String getName() {
        return getWriteableName();
    }

    @Override
    public XContentBuilder toXContent(XContentBuilder builder, Params params) throws IOException {
        builder.startObject();
        builder.endObject();
        return builder;
    }

    @Override
    public Query toQuery(QueryShardContext context) throws IOException {
        // empty
        return null;
    }

    @Override
    public Query toFilter(QueryShardContext context) throws IOException {
        // empty
        return null;
    }

    @Override
    public void writeTo(StreamOutput out) throws IOException {
    }

    @Override
    public EmptyQueryBuilder readFrom(StreamInput in) throws IOException {
        return EmptyQueryBuilder.PROTOTYPE;
    }

    @Override
    public EmptyQueryBuilder queryName(String queryName) {
        //no-op
        return this;
    }

    @Override
    public String queryName() {
        return null;
    }

    @Override
    public float boost() {
        return -1;
    }

    @Override
    public EmptyQueryBuilder boost(float boost) {
        //no-op
        return this;
    }
}