com.couchbase.client.java.search.queries.GeoDistanceQuery Maven / Gradle / Ivy

Go to download

Show more of this group Show more artifacts with this name
Show all versions of java-client Show documentation

The official Couchbase Java SDK

There is a newer version: 3.7.5

/*
 * Copyright (c) 2017 Couchbase, Inc.
 *
 * 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.couchbase.client.java.search.queries;

import com.couchbase.client.core.api.search.CoreSearchQuery;
import com.couchbase.client.core.api.search.queries.CoreGeoDistanceQuery;
import com.couchbase.client.java.search.SearchQuery;

/**
 * A FTS query which allows to match on geo distances.
 *
 * @author Michael Nitschinger
 * @since 2.4.5
 */
public class GeoDistanceQuery extends SearchQuery {

    private final double locationLon;
    private final double locationLat;
    private final String distance;

    private String field;

    public GeoDistanceQuery(double locationLon, double locationLat, String distance) {
        this.locationLon = locationLon;
        this.locationLat = locationLat;
        this.distance = distance;
    }

    public GeoDistanceQuery field(String field) {
        this.field = field;
        return this;
    }

    @Override
    public GeoDistanceQuery boost(double boost) {
        super.boost(boost);
        return this;
    }

    @Override
    public CoreSearchQuery toCore() {
        return new CoreGeoDistanceQuery(locationLon, locationLat, distance, field, boost);
    }
}