lucene/spatial-extras/src/java/org/apache/lucene/spatial/ShapeValues.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.spatial;

import java.io.IOException;

import org.locationtech.spatial4j.shape.Shape;

/**
 * Iterator over {@link Shape} objects for an index segment
 */
public abstract class ShapeValues {

  /**
   * Advance the iterator to the given document
   * @param doc the document to advance to
   * @return {@code true} if there is a value for this document
   */
  public abstract boolean advanceExact(int doc) throws IOException;

  /**
   * Returns a {@link Shape} for the current document
   */
  public abstract Shape value() throws IOException;

}