SearchHelper.java revision e8003fb3e52d438e9111a1833e48473f6e44e27d
/*
* CDDL HEADER START
*
* The contents of this file are subject to the terms of the
* Common Development and Distribution License (the "License").
* You may not use this file except in compliance with the License.
*
* See LICENSE.txt included in this distribution for the specific
* language governing permissions and limitations under the License.
*
* When distributing Covered Code, include this CDDL HEADER in each
* file and include the License file at LICENSE.txt.
* If applicable, add the following below this CDDL HEADER, with the
* fields enclosed by brackets "[]" replaced with your own identifying
* information: Portions Copyright [yyyy] [name of copyright owner]
*
* CDDL HEADER END
*/
/*
* Portions copyright (c) 2011 Jens Elkner.
*/
/**
* complexity from UI design.
*
* @author Jens Elkner
* @version $Revision$
*/
public class SearchHelper {
/**
* max number of words to suggest for spellcheck
*/
public int SPELLCHECK_SUGGEST_WORD_COUNT = 5;
/**
* opengrok's data root: used to find the search index file
*/
/**
* context path, i.e. the applications context path (usually /source) to use
* when generating a redirect URL
*/
public String contextPath;
/**
* piggyback: if {@code true}, files in opengrok's data directory are
* gzipped compressed.
*/
public boolean compressed;
/**
* piggyback: the source root directory.
*/
public File sourceRoot;
/**
* piggyback: the eftar filereader to use.
*/
public EftarFileReader desc;
/**
* the result cursor start index, i.e. where to start displaying results
*/
public int start;
/**
* max. number of result items to show
*/
public int maxItems;
/**
* the QueryBuilder used to create the query
*/
public QueryBuilder builder;
/**
* the order used for ordering query results
*/
/**
* if {@code true} multi-threaded search will be used.
*/
public boolean parallel;
/**
* Indicate, whether this is search from a cross reference. If {@code true}
* {@link #executeQuery()} sets {@link #redirect} if certain conditions are
* met.
*/
public boolean isCrossRefSearch;
/**
* if not {@code null}, the consumer should redirect the client to a
* separate result page denoted by the value of this field. Automatically
* set via {@link #prepareExec(SortedSet)} and {@link #executeQuery()}.
*/
/**
* if not {@code null}, the UI should show this error message and stop
* processing the search. Automatically set via
* {@link #prepareExec(SortedSet)} and {@link #executeQuery()}.
*/
/**
* {@link #prepareExec(SortedSet)}.
*/
public IndexSearcher searcher;
/**
* If performing multi-project search, the indexSearcher objects will be
* tracked by the indexSearcherMap so that they can be properly released
* once the results are read.
*/
/**
* close IndexReader associated with searches on destroy()
*/
private Boolean closeOnDestroy;
/**
* list of docs which result from the executing the query
*/
/**
* total number of hits
*/
public int totalHits;
/**
* the query created by the used {@link QueryBuilder} via
* {@link #prepareExec(SortedSet)}.
*/
/**
* the Lucene sort instruction based on {@link #order} created via
* {@link #prepareExec(SortedSet)}.
*/
/**
* the spellchecker object
*/
protected DirectSpellChecker checker;
/**
* projects to use to setup indexer searchers. Usually setup via
* {@link #prepareExec(SortedSet)}.
*/
/**
* opengrok summary context. Usually created via {@link #prepareSummary()}.
*/
/**
* result summarizer usually created via {@link #prepareSummary()}.
*/
/**
* history context usually created via {@link #prepareSummary()}.
*/
public HistoryContext historyContext;
/**
* display last edited date of a file in search results
*/
public boolean lastEditedDisplayMode = true;
/**
* Default query parse error message prefix
*/
/**
* User readable description for file types. Only those listed in
* fileTypeDescription will be shown to the user.
*
* Returns a set of file type descriptions to be used for a search form.
*
* @return Set of tuples with file type and description.
*/
}
/**
* Create the searcher to use wrt. to currently set parameters and the given
* projects. Does not produce any {@link #redirect} link. It also does
* nothing if {@link #redirect} or {@link #errorMsg} have a
* none-{@code null} value.
* <p>
* <li>{@link #builder}</li> <li>{@link #dataRoot}</li>
* <li>{@link #order} (falls back to relevance if unset)</li>
* <li>{@link #query}</li> <li>{@link #searcher}</li> <li>{@link #sort}</li>
* <li>{@link #projects}</li> <li>{@link #errorMsg} if an error occurs</li>
* </ul>
*
* @param projects project to use query. If empty, a no-project setup
* @return this instance
*/
return this;
}
// the Query created by the QueryBuilder
try {
errorMsg = "No project selected!";
return this;
}
// no project setup
closeOnDestroy = true;
} else {
// We use MultiReader even for single project. This should
// not matter given that MultiReader is just a cheap wrapper
// around set of IndexReader objects.
closeOnDestroy = false;
}
// TODO check if below is somehow reusing sessions so we don't
// requery again and again, I guess 2min timeout sessions could be
// usefull, since you click on the next page within 2mins, if not,
// then wait ;)
// Most probably they are not reused. SearcherLifetimeManager might help here.
switch (order) {
case LASTMODIFIED:
break;
case BY_PATH:
break;
default:
break;
}
checker = new DirectSpellChecker();
} catch (ParseException e) {
} catch (FileNotFoundException e) {
// errorMsg = "Index database(s) not found: " + e.getMessage();
errorMsg = "Index database(s) not found.";
} catch (IOException e) {
errorMsg = e.getMessage();
}
return this;
}
/**
* Start the search prepared by {@link #prepareExec(SortedSet)}. It does
* nothing if {@link #redirect} or {@link #errorMsg} have a
* none-{@code null} value.
* <p>
* fields required for and populated by
* {@link #prepareExec(SortedSet)})</li> <li>{@link #start} (default:
* 0)</li> <li>{@link #maxItems} (default: 0)</li>
* <ul> <li>{@link #hits} (see {@link TopFieldDocs#scoreDocs})</li>
* <li>{@link #totalHits} (see {@link TopFieldDocs#totalHits})</li>
* <li>{@link #contextPath}</li> <li>{@link #errorMsg} if an error
* occurs</li> <li>{@link #redirect} if certain conditions are met</li>
* </ul>
*
* @return this instance
*/
public SearchHelper executeQuery() {
return this;
}
try {
// Bug #3900: Check if this is a search for a single term, and that
// term is a definition. If that's the case, and we only have one match,
// we'll generate a direct link instead of a listing.
boolean isSingleDefinitionSearch
// Attempt to create a direct link to the definition if we search for
// one single definition term AND we have exactly one match AND there
// is only one definition of that symbol in the document that matches.
boolean uniqueDefinition = false;
uniqueDefinition = true;
}
}
}
// @TODO fix me. I should try to figure out where the exact hit is
// instead of returning a page with just _one_ entry in....
}
} catch (BooleanQuery.TooManyClauses e) {
errorMsg = "Too many results for wildcard!";
} catch (IOException | ClassNotFoundException e) {
errorMsg = e.getMessage();
}
return this;
}
return;
}
for (SuggestWord w : words) {
}
}
}
/**
* If a search did not return a hit, one may use this method to obtain
* suggestions for a new search.
*
* <p>
* <li>{@link #projects}</li> <li>{@link #dataRoot}</li>
* <li>{@link #builder}</li> </ul>
*
* @return a possible empty list of suggestions.
*/
return new ArrayList<>(0);
}
} else {
int ii = 0;
}
}
Term t;
try {
if (!closeOnDestroy) {
} else {
}
}
}
}
//TODO suggest also for path and history?
}
} catch (IOException e) {
+ "spelling suggestions: ", e);
} finally {
try {
} catch (IOException ex) {
+ "getting spelling suggestions: ", ex);
}
}
}
}
return res;
}
/**
* Prepare the fields to support printing a full blown summary. Does nothing
* if {@link #redirect} or {@link #errorMsg} have a none-{@code null} value.
*
* <p>
* Otherwise the following fields are set (includes {@code null}): <ul>
* <li>{@link #sourceContext}</li> <li>{@link #summarizer}</li>
* <li>{@link #historyContext}</li> </ul>
*
* @return this instance.
*/
public SearchHelper prepareSummary() {
return this;
}
try {
} catch (Exception e) {
}
try {
} catch (Exception e) {
}
return this;
}
/**
* Free any resources associated with this helper (that includes closing the
* used {@link #searcher} in case of no-project setup).
*/
public void destroy() {
}
try {
} catch (IOException ex) {
}
}
}
}