SearchHelper

java.lang.Object
- org.opensolaris.opengrok.web.SearchHelper

```
public class SearchHelper
extends java.lang.Object
```
Working set for a search basically to factor out/separate search related complexity from UI design.

Field Summary

Fields
Modifier and Type	Field and Description
`QueryBuilder`	`builder` the QueryBuilder used to create the query
`boolean`	`compressed` piggyback: if `true`, files in opengrok's data directory are gzipped compressed.
`java.lang.String`	`contextPath` context path, i.e.
`java.io.File`	`dataRoot` opengrok's data root: used to find the search index file
`EftarFileReader`	`desc` piggyback: the eftar filereader to use.
`java.lang.String`	`errorMsg` if not `null`, the UI should show this error message and stop processing the search.
`HistoryContext`	`historyContext` history context usually created via `prepareSummary()`.
`org.apache.lucene.search.ScoreDoc[]`	`hits` list of docs which result from the executing the query
`boolean`	`isCrossRefSearch` Indicate, whether this is search from a cross reference.
`int`	`maxItems` max.
`SortOrder`	`order` the order to use to ordery query results
`boolean`	`parallel` if `true` a `ParallelMultiSearcher` will be used instead of a `MultiSearcher`.
`static java.lang.String`	`PARSE_ERROR_MSG` Default query parse error message prefix
`java.util.SortedSet<java.lang.String>`	`projects` projects to use to setup indexer searchers.
`org.apache.lucene.search.Query`	`query` the query created by the used `QueryBuilder` via `prepareExec(SortedSet)`.
`java.lang.String`	`redirect` if not `null`, the consumer should redirect the client to a separate result page denoted by the value of this field.
`org.apache.lucene.search.Searcher`	`searcher` the searcher used to open/search the index.
`protected org.apache.lucene.search.Sort`	`sort` the lucene sort instruction based on `order` created via `prepareExec(SortedSet)`.
`Context`	`sourceContext` opengrok summary context.
`java.io.File`	`sourceRoot` piggyback: the source root directory.
`int`	`start` the result cursor start index, i.e.
`Summarizer`	`summerizer` result summarizer usually created via `prepareSummary()`.
`int`	`totalHits` total number of hits

Constructor Summary

Constructors
Constructor and Description

SearchHelper()

Constructors
Constructor and Description
`SearchHelper()`

Method Summary

Methods
Modifier and Type	Method and Description
`void`	`destroy()` Free any resources associated with this helper (that includes closing the used `searcher`).
`SearchHelper`	`executeQuery()` Start the search prepared by `prepareExec(SortedSet)`.
`java.util.List<Suggestion>`	`getSuggestions()` If a search did not return a hit, one may use this method to obtain suggestions for a new search.
`SearchHelper`	`prepareExec(java.util.SortedSet<java.lang.String> projects)` Create the searcher to use wrt.
`SearchHelper`	`prepareSummary()` Prepare the fields to support printing a fullblown summary.

Methods inherited from class java.lang.Object
clone, equals, finalize, getClass, hashCode, notify, notifyAll, toString, wait, wait, wait

- Field Detail
  - dataRoot
```
public java.io.File dataRoot
```
    opengrok's data root: used to find the search index file
  - contextPath
```
public java.lang.String contextPath
```
    context path, i.e. the applications context path (usually /source) to use when generating a redirect URL
  - compressed
```
public boolean compressed
```
    piggyback: if true, files in opengrok's data directory are gzipped compressed.
  - sourceRoot
```
public java.io.File sourceRoot
```
    piggyback: the source root directory.
  - desc
```
public EftarFileReader desc
```
    piggyback: the eftar filereader to use.
  - start
```
public int start
```
    the result cursor start index, i.e. where to start displaying results
  - maxItems
```
public int maxItems
```
    max. number of result items to show
  - builder
```
public QueryBuilder builder
```
    the QueryBuilder used to create the query
  - order
```
public SortOrder order
```
    the order to use to ordery query results
  - parallel
```
public boolean parallel
```
    if true a ParallelMultiSearcher will be used instead of a MultiSearcher.
  - isCrossRefSearch
```
public boolean isCrossRefSearch
```
    Indicate, whether this is search from a cross reference. If true executeQuery() sets redirect if certain conditions are met.
  - redirect
```
public java.lang.String redirect
```
    if not null, the consumer should redirect the client to a separate result page denoted by the value of this field. Automatically set via prepareExec(SortedSet) and executeQuery().
  - errorMsg
```
public java.lang.String errorMsg
```
    if not null, the UI should show this error message and stop processing the search. Automatically set via prepareExec(SortedSet) and executeQuery().
  - searcher
```
public org.apache.lucene.search.Searcher searcher
```
    the searcher used to open/search the index. Automatically set via prepareExec(SortedSet).
  - hits
```
public org.apache.lucene.search.ScoreDoc[] hits
```
    list of docs which result from the executing the query
  - totalHits
```
public int totalHits
```
    total number of hits
  - query
```
public org.apache.lucene.search.Query query
```
    the query created by the used QueryBuilder via prepareExec(SortedSet).
  - sort
```
protected org.apache.lucene.search.Sort sort
```
    the lucene sort instruction based on order created via prepareExec(SortedSet).
  - projects
```
public java.util.SortedSet<java.lang.String> projects
```
    projects to use to setup indexer searchers. Usually setup via prepareExec(SortedSet).
  - sourceContext
```
public Context sourceContext
```
    opengrok summary context. Usually created via prepareSummary().
  - summerizer
```
public Summarizer summerizer
```
    result summarizer usually created via prepareSummary().
  - historyContext
```
public HistoryContext historyContext
```
    history context usually created via prepareSummary().
  - PARSE_ERROR_MSG
```
public static final java.lang.String PARSE_ERROR_MSG
```
    Default query parse error message prefix
    
    See Also:
    Constant Field Values
- Constructor Detail
  - SearchHelper
```
public SearchHelper()
```
- Method Detail
  - prepareExec
```
public SearchHelper prepareExec(java.util.SortedSet<java.lang.String> projects)
```
    Create the searcher to use wrt. to currently set parameters and the given projects. Does not produce any redirect link. It also does nothing if redirect or errorMsg have a none-null value.
    Parameters which should be populated/set at this time:
    - builder
    - dataRoot
    - order (falls back to relevance if unset)
    - parallel (default: false)
    Populates/sets:
    - query
    - searcher
    - sort
    - projects
    - errorMsg if an error occurs
    Parameters:
    projects - project to use query. If empty, a none-project opengrok setup is assumed (i.e. DATA_ROOT/index will be used instead of possible multiple DATA_ROOT/$project/index).
    
    Returns:
    this instance
  - executeQuery
```
public SearchHelper executeQuery()
```
    Start the search prepared by prepareExec(SortedSet). It does nothing if redirect or errorMsg have a none-null value.
    Parameters which should be populated/set at this time:
    - all fields required for and populated by prepareExec(SortedSet))
    - start (default: 0)
    - maxItems (default: 0)
    - isCrossRefSearch (default: false)
    Populates/sets:
    - hits (see TopDocs.scoreDocs)
    - totalHits (see TopDocs.totalHits)
    - contextPath
    - errorMsg if an error occurs
    - redirect if certain conditions are met
    Returns:
    this instance
  - getSuggestions
```
public java.util.List<Suggestion> getSuggestions()
```
    If a search did not return a hit, one may use this method to obtain suggestions for a new search.
    Parameters which should be populated/set at this time:
    Returns:
    a possible empty list of sugeestions.
  - prepareSummary
```
public SearchHelper prepareSummary()
```
    Prepare the fields to support printing a fullblown summary. Does nothing if redirect or errorMsg have a none-null value.
    Parameters which should be populated/set at this time:
    - query
    - builder
    Populates/sets: Otherwise the following fields are set (includes null):
    Returns:
    this instance.
  - destroy
```
public void destroy()
```
    Free any resources associated with this helper (that includes closing the used searcher).

Class SearchHelper

Field Summary

Constructor Summary

Method Summary

Methods inherited from class java.lang.Object

Field Detail

dataRoot

contextPath

compressed

sourceRoot

desc

start

maxItems

builder

order

parallel

isCrossRefSearch

redirect

errorMsg

searcher

hits

totalHits

query

sort

projects

sourceContext

summerizer

historyContext

PARSE_ERROR_MSG

Constructor Detail

SearchHelper

Method Detail

prepareExec

executeQuery

getSuggestions

prepareSummary

destroy