lucene-java-3.5.0/lucene/contrib/benchmark/src/java/org/apache/lucene/benchmark/byTask/feeds/ContentSource.java

   1 package org.apache.lucene.benchmark.byTask.feeds;
   2
   3 /**
   4  * Licensed to the Apache Software Foundation (ASF) under one or more
   5  * contributor license agreements.  See the NOTICE file distributed with
   6  * this work for additional information regarding copyright ownership.
   7  * The ASF licenses this file to You under the Apache License, Version 2.0
   8  * (the "License"); you may not use this file except in compliance with
   9  * the License.  You may obtain a copy of the License at
  10  *
  11  *     http://www.apache.org/licenses/LICENSE-2.0
  12  *
  13  * Unless required by applicable law or agreed to in writing, software
  14  * distributed under the License is distributed on an "AS IS" BASIS,
  15  * WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
  16  * See the License for the specific language governing permissions and
  17  * limitations under the License.
  18  */
  19
  20 import java.io.IOException;
  21
  22 /**
  23  * Represents content from a specified source, such as TREC, Reuters etc. A
  24  * {@link ContentSource} is responsible for creating {@link DocData} objects for
  25  * its documents to be consumed by {@link DocMaker}. It also keeps track
  26  * of various statistics, such as how many documents were generated, size in
  27  * bytes etc.
  28  * <p>
  29  * For supported configuration parameters see {@link ContentItemsSource}.
  30  */
  31 public abstract class ContentSource extends ContentItemsSource {
  32
  33   /** Returns the next {@link DocData} from the content source.
  34    * Implementations must account for multi-threading, as multiple threads
  35    * can call this method simultaneously. */
  36   public abstract DocData getNextDocData(DocData docData) throws NoMoreDataException, IOException;
  37
  38 }