solr/core/src/java/org/apache/solr/handler/export/SortValue.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.solr.handler.export;

import java.io.IOException;

import org.apache.lucene.index.LeafReaderContext;

interface SortValue extends Comparable<SortValue> {
  void setCurrentValue(int docId) throws IOException;
  void setNextReader(LeafReaderContext context) throws IOException;
  void setCurrentValue(SortValue value);
  void toGlobalValue(SortValue previousValue);
  void reset();
  SortValue copy();
  Object getCurrentValue() throws IOException;
  String getField();

  /**
   *
   * @return true if document has a value for the specified field
   */
  boolean isPresent();
}