org.apache.lucene.facet.MultiLongValues 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;

import java.io.IOException;
import org.apache.lucene.search.LongValues;

/**
 * Per-segment, per-document long values, which can be calculated at search-time. Documents may
 * produce multiple values. See also {@link LongValues} for a single-valued version.
 *
 * Currently meant only for use within the faceting module. Could be further generalized and made
 * available for more use-cases outside faceting if there is a desire to do so.
 *
 * @lucene.experimental
 */
public abstract class MultiLongValues {

  /** Instantiates a new MultiLongValues */
  public MultiLongValues() {}

  /**
   * Retrieves the number of values for the current document. This must always be greater than zero.
   * It is illegal to call this method after {@link #advanceExact(int)} returned {@code false}.
   */
  public abstract long getValueCount();

  /**
   * Iterates to the next value in the current document. Do not call this more than {@link
   * #getValueCount} times for the document.
   */
  public abstract long nextValue() throws IOException;

  /** Advance to exactly {@code target} and return whether {@code target} has a value. */
  public abstract boolean advanceExact(int doc) throws IOException;
}