← Back to branch summary

~slub.team/goobi-indexserver/3.x

« back to all changes in this revision

Viewing changes to solr/core/src/java/org/apache/solr/handler/component/StatsValues.java

  • Committer: Sebastian Meyer
  • Date: 2012-08-03 09:12:40 UTC
  • Revision ID: sebastian.meyer@slub-dresden.de-20120803091240-x6861b0vabq1xror
https://launchpad.net/bugs/985487
Remove Lucene and Solr source code and add patches instead
Fix Bug #985487: Auto-suggestion for the search interface

Show diffs side-by-side

added added

removed removed

Lines of Context:
solr/core/src/java/org/apache/solr/handler/component/StatsValues.java
1
 
/**
2
 
 * Licensed to the Apache Software Foundation (ASF) under one or more
3
 
 * contributor license agreements.  See the NOTICE file distributed with
4
 
 * this work for additional information regarding copyright ownership.
5
 
 * The ASF licenses this file to You under the Apache License, Version 2.0
6
 
 * (the "License"); you may not use this file except in compliance with
7
 
 * the License.  You may obtain a copy of the License at
8
 
 *
9
 
 *     http://www.apache.org/licenses/LICENSE-2.0
10
 
 *
11
 
 * Unless required by applicable law or agreed to in writing, software
12
 
 * distributed under the License is distributed on an "AS IS" BASIS,
13
 
 * WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
14
 
 * See the License for the specific language governing permissions and
15
 
 * limitations under the License.
16
 
 */
17
 
 
18
 
 
19
 
package org.apache.solr.handler.component;
20
 
 
21
 
 
22
 
import java.util.Map;
23
 
 
24
 
import org.apache.solr.common.util.NamedList;
25
 
 
26
 
/**
27
 
 * StatsValue defines the interface for the collection of statistical values about fields and facets.
28
 
 */
29
 
public interface StatsValues {
30
 
 
31
 
  /**
32
 
   * Accumulate the values based on those in the given NamedList
33
 
   *
34
 
   * @param stv NamedList whose values will be used to accumulate the current values
35
 
   */
36
 
  void accumulate(NamedList stv);
37
 
 
38
 
  /**
39
 
   * Accumulate the values based on the given value
40
 
   *
41
 
   * @param value Value to use to accumulate the current values
42
 
   */
43
 
  void accumulate(String value);
44
 
 
45
 
  /**
46
 
   * Accumulate the values based on the given value
47
 
   *
48
 
   * @param value Value to use to accumulate the current values
49
 
   * @param count number of times to accumulate this value
50
 
   */
51
 
  void accumulate(String value, int count);
52
 
 
53
 
  /**
54
 
   * Updates the statistics when a document is missing a value
55
 
   */
56
 
  void missing();
57
 
 
58
 
  /**
59
 
   * Updates the statistics when multiple documents are missing a value
60
 
   *
61
 
   * @param count number of times to count a missing value
62
 
   */
63
 
  void addMissing(int count);
64
 
 
65
 
   /**
66
 
   * Adds the facet statistics for the facet with the given name
67
 
   *
68
 
   * @param facetName Name of the facet
69
 
   * @param facetValues Facet statistics on a per facet value basis
70
 
   */
71
 
  void addFacet(String facetName, Map<String, StatsValues> facetValues);
72
 
 
73
 
  /**
74
 
   * Translates the values into a NamedList representation
75
 
   *
76
 
   * @return NamedList representation of the current values
77
 
   */
78
 
  NamedList<?> getStatsValues();
79
 
}