/*
* Licensed to Elasticsearch under one or more contributor
* license agreements. See the NOTICE file distributed with
* this work for additional information regarding copyright
* ownership. Elasticsearch 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.elasticsearch.index.fielddata;
import org.apache.lucene.index.SortedNumericDocValues;
import java.io.IOException;
/**
* Clone of {@link SortedNumericDocValues} for double values.
*/
public abstract class SortedNumericDoubleValues {
/** Sole constructor. (For invocation by subclass
* constructors, typically implicit.) */
protected SortedNumericDoubleValues() {}
/** Advance the iterator to exactly {@code target} and return whether
* {@code target} has a value.
* {@code target} must be greater than or equal to the current
* doc ID and must be a valid doc ID, ie. ≥ 0 and
* < {@code maxDoc}.*/
public abstract boolean advanceExact(int target) throws IOException;
/**
* Iterates to the next value in the current document. Do not call this more than
* {@link #docValueCount} times for the document.
*/
public abstract double nextValue() throws IOException;
/**
* 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 int docValueCount();
}