JahiaSearchResultHandler


1   //
2   //                                   ____.
3   //                       __/\ ______|    |__/\.     _______
4   //            __   .____|    |       \   |    +----+       \
5   //    _______|  /--|    |    |    -   \  _    |    :    -   \_________
6   //   \\______: :---|    :    :           |    :    |         \________>
7   //           |__\---\_____________:______:    :____|____:_____\
8   //                                      /_____|
9   //
10  //                 . . . i n   j a h i a   w e   t r u s t . . .
11  //
12  package org.jahia.services.search;
13  
14  import java.util.Collection  ;
15  import java.util.Map  ;
16  
17  import org.jahia.params.ParamBean;
18  import org.jahia.data.search.JahiaSearchResult;
19  
20  /**
21   * Jahia Search result builder
22   *
23   * @author NK
24   */
25  public interface JahiaSearchResultHandler
26  {
27      public static final String   JAHIASEARCHRESULTHANDLER_PARAMETER_NAME =
28          "org.jahia.services.search.JahiaSearchResultHandler";
29  
30      public static final String   JAHIASEARCHRESULTHANDLER_METHOD_PARAMETER_NAME =
31          "org.jahia.services.search.JahiaSearchResultHandler.method";
32  
33      /**
34       * the default method used to build Search result from vector of ParsedObject instance
35       *
36       * @param parsedObjects Collection a collection of ParsedObject instance
37       * @param jParams ParamBean
38       * @return JahiaSearchResult
39       */
40      public abstract JahiaSearchResult buildResult(Collection   parsedObjects,
41                                                    ParamBean jParams);
42  
43      /**
44       * Build the map of JahiaSearchHits by page, see @JahiaSearchResult#hitsByPage
45       *
46       * @param jahiaSearchResult JahiaSearchResult
47       * @return Map
48       */
49      public abstract Map   groupResultByPage(JahiaSearchResult jahiaSearchResult);
50  
51  }
52
A to Z: JavaDoc & Examples Daily Java News & Articles Open Source Projects Open Source Codes Free Computer Books Remove Frame
Popular Tags