lucene-java-3.5.0/lucene/contrib/benchmark/src/java/org/apache/lucene/benchmark/byTask/tasks/UpdateDocTask.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.DocMaker;
  22 import org.apache.lucene.document.Document;
  23 import org.apache.lucene.index.Term;
  24 import org.apache.lucene.index.IndexWriter;
  25
  26 /**
  27  * Update a document, using IndexWriter.updateDocument,
  28  * optionally with of a certain size.
  29  * <br>Other side effects: none.
  30  * <br>Takes optional param: document size.
  31  */
  32 public class UpdateDocTask extends PerfTask {
  33
  34   public UpdateDocTask(PerfRunData runData) {
  35     super(runData);
  36   }
  37
  38   private int docSize = 0;
  39
  40   // volatile data passed between setup(), doLogic(), tearDown().
  41   private Document doc = null;
  42
  43   @Override
  44   public void setup() throws Exception {
  45     super.setup();
  46     DocMaker docMaker = getRunData().getDocMaker();
  47     if (docSize > 0) {
  48       doc = docMaker.makeDocument(docSize);
  49     } else {
  50       doc = docMaker.makeDocument();
  51     }
  52   }
  53
  54   @Override
  55   public void tearDown() throws Exception {
  56     doc = null;
  57     super.tearDown();
  58   }
  59
  60   @Override
  61   public int doLogic() throws Exception {
  62     final String docID = doc.get(DocMaker.ID_FIELD);
  63     if (docID == null) {
  64       throw new IllegalStateException("document must define the docid field");
  65     }
  66     final IndexWriter iw = getRunData().getIndexWriter();
  67     iw.updateDocument(new Term(DocMaker.ID_FIELD, docID), doc);
  68     return 1;
  69   }
  70
  71   @Override
  72   protected String getLogMessage(int recsCount) {
  73     return "updated " + recsCount + " docs";
  74   }
  75
  76   /**
  77    * Set the params (docSize only)
  78    * @param params docSize, or 0 for no limit.
  79    */
  80   @Override
  81   public void setParams(String params) {
  82     super.setParams(params);
  83     docSize = (int) Float.parseFloat(params);
  84   }
  85
  86   /* (non-Javadoc)
  87    * @see org.apache.lucene.benchmark.byTask.tasks.PerfTask#supportsParams()
  88    */
  89   @Override
  90   public boolean supportsParams() {
  91     return true;
  92   }
  93
  94 }