lucene/queries/src/java/org/apache/lucene/queries/payloads/PayloadDecoder.java

/*
 * Licensed to the Apache Software Foundation (ASF) under one or more
 * contributor license agreements.  See the NOTICE file distributed with
 * this work for additional information regarding copyright ownership.
 * The ASF 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.apache.lucene.queries.payloads;

import org.apache.lucene.util.BytesRef;

/**
 * Defines a way of converting payloads to float values, for use by {@link PayloadScoreQuery}
 */
public interface PayloadDecoder {

  /**
   * Compute a float value for the given payload
   */
  float computePayloadFactor(BytesRef payload);

  /**
   * A {@link PayloadDecoder} that interprets the bytes of a payload as a float
   */
  PayloadDecoder FLOAT_DECODER = bytes -> bytes == null ? 1 : bytes.bytes[bytes.offset];

}