org.elasticsearch.index.fielddata.GeoPointValues Maven / Gradle / Ivy

Show more of this group Show more artifacts with this name
Show all versions of elasticsearch Show documentation

Elasticsearch subproject :server

There is a newer version: 8.13.4

/*
 * Copyright Elasticsearch B.V. and/or licensed to Elasticsearch B.V. under one
 * or more contributor license agreements. Licensed under the Elastic License
 * 2.0 and the Server Side Public License, v 1; you may not use this file except
 * in compliance with, at your election, the Elastic License 2.0 or the Server
 * Side Public License, v 1.
 */

package org.elasticsearch.index.fielddata;

import org.apache.lucene.index.NumericDocValues;
import org.elasticsearch.common.geo.GeoPoint;

import java.io.IOException;

/**
 * Per-document geo-point values.
 */
public final class GeoPointValues {

    private final GeoPoint point = new GeoPoint();
    private final NumericDocValues values;

    GeoPointValues(NumericDocValues values) {
        this.values = values;
    }

    /**
     * Advance this instance to the given document id
     * @return true if there is a value for this document
     */
    public boolean advanceExact(int doc) throws IOException {
        return values.advanceExact(doc);
    }

    /**
     * Get the {@link GeoPoint} associated with the current document.
     * The returned {@link GeoPoint} might be reused across calls.
     */
    public GeoPoint geoPointValue() throws IOException {
        return point.resetFromEncoded(values.longValue());
    }
}