pylucene 3.5.0-3
[pylucene.git] / lucene-java-3.5.0 / lucene / contrib / benchmark / src / java / org / apache / lucene / benchmark / byTask / tasks / SearchTravTask.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  * Search and Traverse task.
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>Takes optional param: traversal size (otherwise all results are traversed).</p>
31  * 
32  * <p>Other side effects: counts additional 1 (record) for each traversed hit.</p>
33  */
34 public class SearchTravTask extends ReadTask {
35   protected int traversalSize = Integer.MAX_VALUE;
36
37   public SearchTravTask(PerfRunData runData) {
38     super(runData);
39   }
40
41   @Override
42   public boolean withRetrieve() {
43     return false;
44   }
45
46   @Override
47   public boolean withSearch() {
48     return true;
49   }
50
51   @Override
52   public boolean withTraverse() {
53     return true;
54   }
55
56   @Override
57   public boolean withWarm() {
58     return false;
59   }
60
61   
62
63   @Override
64   public QueryMaker getQueryMaker() {
65     return getRunData().getQueryMaker(this);
66   }
67
68   @Override
69   public int traversalSize() {
70     return traversalSize;
71   }
72
73   @Override
74   public void setParams(String params) {
75     super.setParams(params);
76     traversalSize = (int)Float.parseFloat(params);
77   }
78
79   /* (non-Javadoc)
80    * @see org.apache.lucene.benchmark.byTask.tasks.PerfTask#supportsParams()
81    */
82   @Override
83   public boolean supportsParams() {
84     return true;
85   }
86 }