/*
 * 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", the "GNU Affero General Public License v3.0 only", 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", the "GNU Affero General Public
 * License v3.0 only", or the "Server Side Public License, v 1".
 */

package org.elasticsearch.script;

import org.apache.lucene.search.DoubleValues;
import org.apache.lucene.search.DoubleValuesSource;
import org.apache.lucene.search.Rescorer;
import org.apache.lucene.search.SortField;

import java.util.function.Function;

/**
 * A custom script that can be used for various DoubleValue Lucene operations.
 */
public abstract class DoubleValuesScript {

    public DoubleValuesScript() {}

    public abstract double execute();

    public abstract double evaluate(DoubleValues[] functionValues);

    public abstract DoubleValuesSource getDoubleValuesSource(Function<String, DoubleValuesSource> sourceProvider);

    public abstract SortField getSortField(Function<String, DoubleValuesSource> sourceProvider, boolean reverse);

    public abstract Rescorer getRescorer(Function<String, DoubleValuesSource> sourceProvider);

    public abstract String sourceText();

    public abstract String[] variables();

    /** A factory to construct {@link DoubleValuesScript} instances. */
    public interface Factory extends ScriptFactory {
        DoubleValuesScript newInstance();
    }

    @SuppressWarnings("rawtypes")
    public static final ScriptContext<Factory> CONTEXT = new ScriptContext<>("double_values", Factory.class);
}