← 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/search/grouping/endresulttransformer/EndResultTransformer.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/search/grouping/endresulttransformer/EndResultTransformer.java
1
 
package org.apache.solr.search.grouping.endresulttransformer;
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.search.ScoreDoc;
21
 
import org.apache.solr.common.SolrDocument;
22
 
import org.apache.solr.response.SolrQueryResponse;
23
 
import org.apache.solr.search.grouping.GroupingSpecification;
24
 
 
25
 
import java.util.Map;
26
 
 
27
 
/**
28
 
 * Responsible for transforming the grouped result into the final format for displaying purposes.
29
 
 *
30
 
 * @lucene.experimental
31
 
 */
32
 
public interface EndResultTransformer {
33
 
 
34
 
  /**
35
 
   * Transforms the specified result into its final form and puts it into the specified response.
36
 
   *
37
 
   * @param result The map containing the grouping result (for grouping by field and query)
38
 
   * @param response The response that will be rendered to the client
39
 
   * @param groupingSpecification The grouping specification
40
 
   * @param solrDocumentSource The source of {@link SolrDocument} instances
41
 
   */
42
 
  void transform(Map<String, ?> result, SolrQueryResponse response, GroupingSpecification groupingSpecification, SolrDocumentSource solrDocumentSource);
43
 
 
44
 
  /**
45
 
   * Abstracts the source for {@link SolrDocument} instances.
46
 
   * The source of documents is different for a distributed search than local search
47
 
   */
48
 
  public interface SolrDocumentSource {
49
 
 
50
 
    SolrDocument retrieve(ScoreDoc doc);
51
 
 
52
 
  }
53
 
 
54
 
}