DocIdBuilder.java

package org.apache.lucene.search.concordance.classic;

import java.util.Set;
import org.apache.lucene.document.Document;

/*
 * 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.
 */


/**
 * Returns a unique string for each document.
 * Some implementations may be able to rely only
 * on the ephemeral Lucene docId.  Others, may
 * want to use a field within the document.
 */
public interface DocIdBuilder {

  Set getFields();
  String build(Document document, long docId);
}