1 package org.apache.lucene.benchmark.byTask.tasks;
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
11 * http://www.apache.org/licenses/LICENSE-2.0
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.
20 import org.apache.lucene.benchmark.byTask.PerfRunData;
21 import org.apache.lucene.benchmark.byTask.feeds.FacetSource;
22 import org.apache.lucene.facet.index.CategoryContainer;
23 import org.apache.lucene.facet.index.CategoryDocumentBuilder;
26 * Add a faceted document.
30 * <li><b>with.facets</b>=<tells whether to actually add any facets to the document| Default: true>
31 * <br>This config property allows to easily compare the performance of adding docs with and without facets.
32 * Note that facets are created even when this is false, just that they are not added to the document (nor to the taxonomy).
35 * See {@link AddDocTask} for general document parameters and configuration.
37 * Makes use of the {@link FacetSource} in effect - see {@link PerfRunData} for facet source settings.
39 public class AddFacetedDocTask extends AddDocTask {
41 public AddFacetedDocTask(PerfRunData runData) {
45 private CategoryContainer facets = null;
46 private CategoryDocumentBuilder categoryDocBuilder = null;
47 private boolean withFacets = true;
50 public void setup() throws Exception {
52 // create the facets even if they should not be added - allows to measure the effect of just adding facets
53 facets = getRunData().getFacetSource().getNextFacets(facets);
54 withFacets = getRunData().getConfig().get("with.facets", true);
56 categoryDocBuilder = new CategoryDocumentBuilder(getRunData().getTaxonomyWriter());
57 categoryDocBuilder.setCategories(facets);
62 protected String getLogMessage(int recsCount) {
64 return super.getLogMessage(recsCount);
66 return super.getLogMessage(recsCount)+ " with facets";
70 public int doLogic() throws Exception {
72 categoryDocBuilder.build(doc);
74 return super.doLogic();