org.apache.lucene.facet.facetset.FacetSetDecoder Maven / Gradle / Ivy

Go to download
Show more of this group Show more artifacts with this name
Show all versions of lucene-facet Show documentation
Apache Lucene (module: facet)
The newest version!
/*
 * 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.facet.facetset;

import org.apache.lucene.document.IntPoint;
import org.apache.lucene.document.LongPoint;
import org.apache.lucene.util.BytesRef;

/**
 * A functional interface for decoding facet set values into comparable `long` ones. You can use it
 * by e.g. implementing a static method with the same signature and then pass it as {@code
 * YourClass::decode}.
 *
 * @lucene.experimental
 */
public interface FacetSetDecoder {

  /**
   * An implementation of {@link FacetSetDecoder#decode(BytesRef, int, long[])} for long/double
   * dimension values which were encoded with {@link LongFacetSet} and {@link DoubleFacetSet}
   * respectively.
   */
  static int decodeLongs(BytesRef bytesRef, int start, long[] dest) {
    LongPoint.unpack(bytesRef, start, dest);
    return dest.length * Long.BYTES;
  }

  /**
   * An implementation of {@link FacetSetDecoder#decode(BytesRef, int, long[])} for int/float
   * dimension values which were encoded with {@link IntFacetSet} and {@link FloatFacetSet}
   * respectively.
   */
  static int decodeInts(BytesRef bytesRef, int start, long[] dest) {
    for (int i = 0, offset = start; i < dest.length; i++, offset += Integer.BYTES) {
      dest[i] = IntPoint.decodeDimension(bytesRef.bytes, offset);
    }
    return dest.length * Integer.BYTES;
  }

  /**
   * Decodes the facet set dimension values into the given destination buffer and returns the number
   * of bytes read.
   */
  int decode(BytesRef bytesRef, int start, long[] dest);
}