org.apache.lucene.index.SortedNumericDocValues Maven / Gradle / Ivy
package org.apache.lucene.index;
/*
* 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.
*/
/**
* A list of per-document numeric values, sorted
* according to {@link Long#compare(long, long)}.
*/
public abstract class SortedNumericDocValues {
/** Sole constructor. (For invocation by subclass
* constructors, typically implicit.) */
protected SortedNumericDocValues() {}
/**
* Positions to the specified document
*/
public abstract void setDocument(int doc);
/**
* Retrieve the value for the current document at the specified index.
* An index ranges from {@code 0} to {@code count()-1}.
*/
public abstract long valueAt(int index);
/**
* Retrieves the count of values for the current document.
* This may be zero if a document has no values.
*/
public abstract int count();
}