org.apache.lucene.facet.facetset.RangeFacetSetMatcher 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)

There is a newer version: 10.0.0

/*
 * 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 java.util.Arrays;

/**
 * A {@link FacetSetMatcher} which considers a set as a match if all dimensions fall within the
 * given corresponding range.
 *
 * @lucene.experimental
 */
public class RangeFacetSetMatcher extends FacetSetMatcher {

  private final long[] lowerRanges;
  private final long[] upperRanges;

  /**
   * Constructs an instance to match facet sets with dimensions that fall within the given ranges.
   */
  public RangeFacetSetMatcher(String label, DimRange... dimRanges) {
    super(label, getDims(dimRanges));
    this.lowerRanges = Arrays.stream(dimRanges).mapToLong(range -> range.min).toArray();
    this.upperRanges = Arrays.stream(dimRanges).mapToLong(range -> range.max).toArray();
  }

  @Override
  public boolean matches(long[] dimValues) {
    assert dimValues.length == dims
        : "Encoded dimensions (dims="
            + dimValues.length
            + ") is incompatible with range dimensions (dims="
            + dims
            + ")";

    for (int i = 0; i < dimValues.length; i++) {
      if (dimValues[i] < lowerRanges[i]) {
        // Doc's value is too low in this dimension
        return false;
      }
      if (dimValues[i] > upperRanges[i]) {
        // Doc's value is too high in this dimension
        return false;
      }
    }
    return true;
  }

  private static int getDims(DimRange... dimRanges) {
    if (dimRanges == null || dimRanges.length == 0) {
      throw new IllegalArgumentException("dimRanges cannot be null or empty");
    }
    return dimRanges.length;
  }
}