pylucene 3.5.0-3
[pylucene.git] / lucene-java-3.5.0 / lucene / contrib / benchmark / src / java / org / apache / lucene / benchmark / byTask / tasks / SearchTravRetTask.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
22 /**
23  * Search and Traverse and Retrieve docs task.
24  * 
25  * <p>Note: This task reuses the reader if it is already open. 
26  * Otherwise a reader is opened at start and closed at the end.
27  * </p>
28  * 
29  * <p>Takes optional param: traversal size (otherwise all results are traversed).</p>
30  * 
31  * <p>Other side effects: counts additional 1 (record) for each traversed hit, 
32  * and 1 more for each retrieved (non null) document.</p>
33  */
34 public class SearchTravRetTask extends SearchTravTask {
35
36   public SearchTravRetTask(PerfRunData runData) {
37     super(runData);
38   }
39
40   @Override
41   public boolean withRetrieve() {
42     return true;
43   }
44
45 }