lucene-java-3.5.0/lucene/contrib/benchmark/src/java/org/apache/lucene/benchmark/byTask/tasks/WarmTask.java

   1 package org.apache.lucene.benchmark.byTask.tasks;
   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 org.apache.lucene.benchmark.byTask.PerfRunData;
  21 import org.apache.lucene.benchmark.byTask.feeds.QueryMaker;
  22
  23 /**
  24  * Warm reader task: retrieve all reader documents.
  25  *
  26  * <p>Note: This task reuses the reader if it is already open.
  27  * Otherwise a reader is opened at start and closed at the end.
  28  * </p>
  29  *
  30  * <p>Other side effects: counts additional 1 (record) for each
  31  * retrieved (non null) document.</p>
  32  */
  33 public class WarmTask extends ReadTask {
  34
  35   public WarmTask(PerfRunData runData) {
  36     super(runData);
  37   }
  38
  39   @Override
  40   public boolean withRetrieve() {
  41     return false;
  42   }
  43
  44   @Override
  45   public boolean withSearch() {
  46     return false;
  47   }
  48
  49   @Override
  50   public boolean withTraverse() {
  51     return false;
  52   }
  53
  54   @Override
  55   public boolean withWarm() {
  56     return true;
  57   }
  58
  59   @Override
  60   public QueryMaker getQueryMaker() {
  61     return null; // not required for this task.
  62   }
  63
  64
  65 }