summaryrefslogtreecommitdiff
path: root/core/src/main/java/org/elasticsearch/search/suggest/completion/context/GeoQueryContext.java
blob: caf1a3eeb93b261ba146553f2b1be0ce5aaef6ea (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
/*
 * 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.search.suggest.completion.context;

import org.elasticsearch.common.geo.GeoPoint;
import org.elasticsearch.common.xcontent.ToXContent;
import org.elasticsearch.common.xcontent.XContentBuilder;

import java.io.IOException;

import static org.elasticsearch.search.suggest.completion.context.GeoContextMapping.*;

/**
 * Defines the query context for {@link GeoContextMapping}
 */
public class GeoQueryContext extends CategoryQueryContext {
    public final int precision;
    public final int[] neighbours;

    /**
     * Creates a query context for a given geo point with a boost of 1
     * and a precision of {@value GeoContextMapping#DEFAULT_PRECISION}
     */
    public GeoQueryContext(GeoPoint geoPoint) {
        this(geoPoint.geohash());
    }

    /**
     * Creates a query context for a given geo point with a
     * provided boost
     */
    public GeoQueryContext(GeoPoint geoPoint, int boost) {
        this(geoPoint.geohash(), boost);
    }

    /**
     * Creates a query context with a given geo hash with a boost of 1
     * and a precision of {@value GeoContextMapping#DEFAULT_PRECISION}
     */
    public GeoQueryContext(CharSequence geoHash) {
        this(geoHash, 1);
    }

    /**
     * Creates a query context for a given geo hash with a
     * provided boost
     */
    public GeoQueryContext(CharSequence geoHash, int boost) {
        this(geoHash, boost, DEFAULT_PRECISION);
    }

    /**
     * Creates a query context for a geo point with
     * a provided boost and enables generating neighbours
     * at specified precisions
     */
    public GeoQueryContext(GeoPoint geoPoint, int boost, int precision, int... neighbours) {
        this(geoPoint.geohash(), boost, precision, neighbours);
    }

    /**
     * Creates a query context for a geo hash with
     * a provided boost and enables generating neighbours
     * at specified precisions
     */
    public GeoQueryContext(CharSequence geoHash, int boost, int precision, int... neighbours) {
        super(geoHash, boost, true);
        this.precision = precision;
        this.neighbours = neighbours;
    }

    @Override
    public XContentBuilder toXContent(XContentBuilder builder, Params params) throws IOException {
        builder.startObject();
        builder.field(CONTEXT_VALUE, context);
        builder.field(CONTEXT_BOOST, boost);
        builder.field(CONTEXT_NEIGHBOURS, neighbours);
        builder.endObject();
        return builder;
    }
}