io.objectbox.query.ObjectWithScore Maven / Gradle / Ivy

Go to download

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

ObjectBox is a fast NoSQL database for Objects

The newest version!

/*
 * Copyright 2024 ObjectBox Ltd. 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 io.objectbox.query;

/**
 * Wraps a matching object and a score when using {@link Query#findWithScores}.
 */
public class ObjectWithScore {

    private final T object;
    private final double score;

    // Note: this constructor is called by JNI, check before modifying/removing it.
    public ObjectWithScore(T object, double score) {
        this.object = object;
        this.score = score;
    }

    // Do not use getObject() to avoid having to escape the name in Kotlin
    /**
     * Returns the matching object.
     */
    public T get() {
        return object;
    }

    /**
     * Returns the query score for the {@link #get() object}.
     * 
     * The query score indicates some quality measurement. E.g. for vector nearest neighbor searches, the score is the
     * distance to the given vector.
     */
    public double getScore() {
        return score;
    }
}