senselogic.sitevision.api.search

Interface SearchUtil

@Requireable(value="SearchUtil")
public interface SearchUtil

Convenience interface for querying the default index.

Note! This interface contains convenience methods for basic search in the default index. When more powerful search behaviour is needed - use Searcher instead! Actually, you can always use Searcher, but not always SearchUtil.

Examples of when you must use Searcher instead is:

• You want to query another index (not the default index).
• You want to do multi-field querying and want to specify query fields (not use the default ones specified by the index).
• You want to use a filter to separate the "user" query and the "filter" query (which also improves performance).
• You want to highlight one or more fields in the search result.
• You want suggestions ("did you mean") in the search result.

Query syntax note! Query strings should be expressed according to the Solr query syntax. The syntax is basically the Lucene query syntax with some minor differences (solr syntax allows open-ended range queries and pure negative queries). Also note that a general recommendation is to always use the prefix operators (+/-) instead of the boolean keywords (AND/OR/NOT) to avoid unexpected behaviour. For deeper understanding, see for example Why Not AND, OR, And NOT?.

An instance of the Sitevision class implementing this interface can be obtained via Utils.getSearchUtil(). See Utils for how to obtain an instance of the Utils interface.

Since:

Sitevision 2.6_06

Author:

Mikael Wikblom

See Also:

Searcher

Method Summary

Modifier and Type	Method and Description
SearchResult	search(String aQuery, List<SearchSortField> sortFields, int aStartAtHit, int aMaxHitsToReturn) Searches the default index using the multi-field ("edismax") parser.
SearchResult	search(String aQuery, String aFieldName, List<SearchSortField> sortFields, int aStartAtHit, int aMaxHitsToReturn) Searches the default index using the single-field ("standard") parser with a specified default field.

Method Detail

search

SearchResult search(String aQuery,
                    List<SearchSortField> sortFields,
                    int aStartAtHit,
                    int aMaxHitsToReturn)

Searches the default index using the multi-field ("edismax") parser.

Here is a simple example written in server-side javascript:

 var searchUtil = request.getAttribute("sitevision.utils").getSearchUtil();
 var result = searchUtil.search("test*", null, 0, 10);
 if (result.hasHits()) {
    out.println("Approximate hit count: " + result.getApproximateCount() + "<br/>");
    var hits = result.getHits();
    while (hits.hasNext()) {
       var hit = hits.next();
       out.print("<a href=\"" + hit.getField('uri') + "\" title=\"\">");
       out.print(hit.getField('title'));
       out.print("</a>");
       out.println("<br/>");
    }
 } else {
    out.println("No hits for query = '" + result.getQuery() + "'<br/>");
 }
 

Note! aQuery will be stripped from Local params, see QueryStringUtil.stripLocalParams(String).

Parameters:

aQuery - The search query according to the Solr query syntax

sortFields - A List of SearchSortField objects. May be null.

aStartAtHit - number of leading hits to be skipped

aMaxHitsToReturn - maximum total number of hits to be returned

Returns:

The search returns a SearchResult and is never null

search

SearchResult search(String aQuery,
                    String aFieldName,
                    List<SearchSortField> sortFields,
                    int aStartAtHit,
                    int aMaxHitsToReturn)

Searches the default index using the single-field ("standard") parser with a specified default field.

Note! aQuery will be stripped from Local params, see QueryStringUtil.stripLocalParams(String).

Parameters:

aQuery - The search query according to the Solr query syntax

aFieldName - name of the field that should be queried

sortFields - A List of SearchSortField objects. May be null.

aStartAtHit - number of leading hits to be skipped

aMaxHitsToReturn - maximum total number of hits to be returned

Returns:

a SearchResult and is never null

Since:

Sitevision 2.7_06, Sitevision 3.0