SearchHelper.java revision 1190
1364N/A * The contents of this file are subject to the terms of the 1364N/A * Common Development and Distribution License (the "License"). 1364N/A * You may not use this file except in compliance with the License. 1364N/A * language governing permissions and limitations under the License. 1364N/A * When distributing Covered Code, include this CDDL HEADER in each 1364N/A * If applicable, add the following below this CDDL HEADER, with the 1364N/A * fields enclosed by brackets "[]" replaced with your own identifying 1364N/A * information: Portions Copyright [yyyy] [name of copyright owner] 1364N/A * Copyright (c) 2011 Jens Elkner. 1383N/A * complexity from UI design. 1364N/A /** opengrok's data root: used to find the search index file */ 1364N/A /** context path, i.e. the applications context path (usually /source) to 1364N/A * use when generating a redirect URL */ 1364N/A /** piggyback: if {@code true}, files in opengrok's data directory are 1364N/A /** piggyback: the source root directory. */ 1364N/A /** piggyback: the eftar filereader to use. */ 1364N/A /** the result cursor start index, i.e. where to start displaying results */ 1364N/A /** max. number of result items to show */ 1364N/A /** the QueryBuilder used to create the query */ 1364N/A /** the order to use to ordery query results */ 1364N/A /** if {@code true} a {@link ParallelMultiSearcher} will be used instead of 1370N/A * a {@link MultiSearcher}. */ 1364N/A /** Indicate, whether this is search from a cross reference. If {@code true} 1370N/A * {@link #executeQuery()} sets {@link #redirect} if certain conditions are 1370N/A /** if not {@code null}, the consumer should redirect the client to a 1364N/A * separate result page denoted by the value of this field. Automatically 1364N/A * set via {@link #prepareExec(TreeSet)} and {@link #executeQuery()}. */ 1370N/A /** if not {@code null}, the UI should show this error message and stop 1364N/A * processing the search. Automatically set via {@link #prepareExec(TreeSet)} 1364N/A * and {@link #executeQuery()}.*/ 1364N/A * {@link #prepareExec(TreeSet)}. */ 1383N/A /** list of docs which result from the executing the query */ 1370N/A /** total number of hits */ 1364N/A /** the query created by the used {@link QueryBuilder} via 1364N/A * {@link #prepareExec(TreeSet)}. */ 1383N/A /** the lucene sort instruction based on {@link #order} created via 1364N/A * {@link #prepareExec(TreeSet)}. */ 1383N/A /** projects to use to setup indexer searchers. Usually setup via 1364N/A * {@link #prepareExec(TreeSet)}. */ 1383N/A /** opengrok summary context. Usually created via {@link #prepareSummary()}. */ 1364N/A /** result summarizer usually created via {@link #prepareSummary()}. */ 1364N/A /** history context usually created via {@link #prepareSummary()}.*/ 1370N/A /** Default query parse error message prefix */ 1383N/A * Create the searcher to use wrt. to currently set parameters and the given 1383N/A * projects. Does not produce any {@link #redirect} link. It also does 1364N/A * nothing if {@link #redirect} or {@link #errorMsg} have a none-{@code null} 1364N/A * <li>{@link #builder}</li> 1364N/A * <li>{@link #dataRoot}</li> 1370N/A * <li>{@link #order} (falls back to relevance if unset)</li> 1364N/A * <li>{@link #parallel} (default: false)</li> 1383N/A * <li>{@link #searcher}</li> 1383N/A * <li>{@link #projects}</li> 1389N/A * <li>{@link #errorMsg} if an error occurs</li> 1383N/A * @param projects project to use query. If empty, a none-project opengrok 1383N/A // the Query created by the QueryBuilder 1364N/A //TODO might need to rewrite to Project instead of 1364N/A // String , need changes in projects.jspf too 1364N/A // TODO check if below is somehow reusing sessions so we don't 1364N/A // requery again and again, I guess 2min timeout sessions could be 1364N/A // usefull, since you click on the next page within 2mins, if not, 1364N/A// errorMsg = "Index database(s) not found: " + e.getMessage(); 1364N/A * Start the search prepared by {@link #prepareExec(TreeSet)}. 1364N/A * It does nothing if {@link #redirect} or {@link #errorMsg} have a 1364N/A * <li>all fields required for and populated by {@link #prepareExec(TreeSet)})</li> 1364N/A * <li>{@link #start} (default: 0)</li> 1364N/A * <li>{@link #maxItems} (default: 0)</li> 1364N/A * <li>{@link #isCrossRefSearch} (default: false)</li> 1364N/A * <li>{@link #hits} (see {@link TopFieldDocs#scoreDocs})</li> 1364N/A * <li>{@link #totalHits} (see {@link TopFieldDocs#totalHits})</li> 1364N/A * <li>{@link #contextPath}</li> 1364N/A * <li>{@link #errorMsg} if an error occurs</li> 1364N/A * <li>{@link #redirect} if certain conditions are met</li> 1364N/A // Bug #3900: Check if this is a search for a single term, and that 1364N/A // term is a definition. If that's the case, and we only have one match, 1364N/A // we'll generate a direct link instead of a listing. 1364N/A // Attempt to create a direct link to the definition if we search for 1364N/A // one single definition term AND we have exactly one match AND there 1364N/A // is only one definition of that symbol in the document that matches. 1364N/A // @TODO fix me. I should try to figure out where the exact hit is 1364N/A // instead of returning a page with just _one_ entry in.... 1364N/A * If a search did not return a hit, one may use this method to obtain 1364N/A * suggestions for a new search. 1186N/A * <li>{@link #projects}</li> 949N/A * <li>{@link #dataRoot}</li> 954N/A * <li>{@link #builder}</li> 949N/A * @return a possible empty list of sugeestions. 1186N/A // TODO it seems the only true spellchecker is for 1390N/A // below field, see IndexDatabase 1390N/A // createspellingsuggestions ... 1186N/A * Prepare the fields to support printing a fullblown summary. Does nothing 1186N/A * if {@link #redirect} or {@link #errorMsg} have a none-{@code null} value. 1186N/A * <li>{@link #builder}</li> 1186N/A * Otherwise the following fields are set (includes {@code null}): 1186N/A * <li>{@link #sourceContext}</li> 1186N/A * <li>{@link #summerizer}</li> 1186N/A * <li>{@link #historyContext}</li> 1186N/A * Free any resources associated with this helper (that includes closing 1186N/A * the used {@link #searcher}).