org.codelibs.elasticsearch.script.LeafSearchScript Maven / Gradle / Ivy

Go to download
/*
 * 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.codelibs.elasticsearch.script;

import org.codelibs.elasticsearch.common.lucene.ScorerAware;

import java.util.Map;

/**
 * A per-segment {SearchScript}.
 */
public interface LeafSearchScript extends ScorerAware, ExecutableScript {

    void setDocument(int doc);

    void setSource(Map source);

    /**
     * Sets per-document aggregation {@code _value}.
     * 
     * The default implementation just calls {@code setNextVar("_value", value)} but
     * some engines might want to handle this differently for better performance.
     * 
     * @param value per-document value, typically a String, Long, or Double
     */
    default void setNextAggregationValue(Object value) {
        setNextVar("_value", value);
    }

    long runAsLong();

    double runAsDouble();

}