pylucene 3.5.0-3
[pylucene.git] / lucene-java-3.5.0 / lucene / contrib / benchmark / src / java / org / apache / lucene / benchmark / byTask / tasks / AddDocTask.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
24 /**
25  * Add a document, optionally of a certain size.
26  * <br>Other side effects: none.
27  * <br>Takes optional param: document size. 
28  */
29 public class AddDocTask extends PerfTask {
30
31   public AddDocTask(PerfRunData runData) {
32     super(runData);
33   }
34
35   private int docSize = 0;
36   
37   /** 
38    * volatile data passed between setup(), doLogic(), tearDown().
39    * the doc is created at setup() and added at doLogic(). 
40    */
41   protected 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   protected String getLogMessage(int recsCount) {
62     return String.format("added %9d docs",recsCount);
63   }
64   
65   @Override
66   public int doLogic() throws Exception {
67     getRunData().getIndexWriter().addDocument(doc);
68     return 1;
69   }
70
71   /**
72    * Set the params (docSize only)
73    * @param params docSize, or 0 for no limit.
74    */
75   @Override
76   public void setParams(String params) {
77     super.setParams(params);
78     docSize = (int) Float.parseFloat(params); 
79   }
80
81   /* (non-Javadoc)
82    * @see org.apache.lucene.benchmark.byTask.tasks.PerfTask#supportsParams()
83    */
84   @Override
85   public boolean supportsParams() {
86     return true;
87   }
88   
89 }