org.apache.lucene.facet.facetset.ExactFacetSetMatcher 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 only if all dimension values are equal
 * to the given one.
 *
 * @lucene.experimental
 */
public class ExactFacetSetMatcher extends FacetSetMatcher {

  private final long[] values;

  /** Constructs an instance to match the given facet set. */
  public ExactFacetSetMatcher(String label, FacetSet facetSet) {
    super(label, facetSet.dims);

    this.values = facetSet.getComparableValues();
  }

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

    return Arrays.equals(dimValues, values);
  }
}