Uses of Interface
org.terrier.querying.SearchRequest

Packages that use SearchRequest

Package	Description
org.terrier.applications	Provides application-level code that use the Terrier platform to perform indexing and retrieval from either standard test collections, interactive querying of a indexed collection.
org.terrier.applications.batchquerying	Contains application-level programs for performing batch-based query operations, such as generating runs for TREC.
org.terrier.querying	Provides the interfaces and classes for the querying API of the Terrier platform, the controls, post processors and filters.
org.terrier.rest	Provides a HTTP REST service for providing results
org.terrier.structures.cache	Provides caching of search results when performing batch querying operations.
org.terrier.structures.outputformat	Provides functionality for writing Terrier ResultSets to disk as .res files, e.g.

Uses of SearchRequest in org.terrier.applications

Methods in org.terrier.applications that return SearchRequest

Modifier and Type	Method	Description
SearchRequest	AbstractQuerying.processQuery(java.lang.String queryId, java.lang.String query)	According to the given parameters, it sets up the correct matching class.
SearchRequest	InteractiveQuerying.processQuery(java.lang.String queryId, java.lang.String query)	According to the given parameters, it sets up the correct matching class.

Methods in org.terrier.applications with parameters of type SearchRequest

Modifier and Type	Method	Description
void	InteractiveQuerying.printResults(java.io.PrintWriter pw, SearchRequest q)	Prints the results

Uses of SearchRequest in org.terrier.applications.batchquerying

Methods in org.terrier.applications.batchquerying that return SearchRequest

Modifier and Type	Method	Description
SearchRequest	TRECQuerying.processQuery(java.lang.String queryId, java.lang.String query)	According to the given parameters, it sets up the correct matching class and performs retrieval for the given query.

Methods in org.terrier.applications.batchquerying with parameters of type SearchRequest

Modifier and Type	Method	Description
protected void	TRECQuerying.initSearchRequestModification(java.lang.String queryId, SearchRequest srq)
protected void	TRECQuerying.preQueryingSearchRequestModification(java.lang.String queryId, SearchRequest srq)
void	TRECQuerying.printSettings(SearchRequest default_q, java.lang.String[] topicsFiles, java.lang.String otherComments)	prints the current settings to a file with the same name as the current results file.

Uses of SearchRequest in org.terrier.querying

Classes in org.terrier.querying that implement SearchRequest

Modifier and Type	Class	Description
class	Request	Request contains the details of the search engine for one query, including the query itself, the resultset, the controls and the context objects.

Methods in org.terrier.querying that return SearchRequest

Modifier and Type	Method	Description
SearchRequest	LocalManager.newSearchRequest()
SearchRequest	LocalManager.newSearchRequest(java.lang.String QueryID)
SearchRequest	LocalManager.newSearchRequest(java.lang.String QueryID, java.lang.String query)
SearchRequest	Manager.newSearchRequest()	Ask for new SearchRequest object to be made.
SearchRequest	Manager.newSearchRequest(java.lang.String QueryID)	Ask for new SearchRequest object to be made.
SearchRequest	Manager.newSearchRequest(java.lang.String QueryID, java.lang.String query)	Ask for new SearchRequest object to be made, instantiated using the specified query id, and that the specified query should be parsed.
SearchRequest	LocalManager.newSearchRequestFromQuery(java.lang.String query)
SearchRequest	Manager.newSearchRequestFromQuery(java.lang.String query)	Ask for new SearchRequest object to be made given a query to be parsed

Methods in org.terrier.querying with parameters of type SearchRequest

Modifier and Type	Method	Description
protected boolean	Decorate.checkControl(java.lang.String control_name, SearchRequest srq)
byte	Decorate.filter(Manager m, SearchRequest q, ResultSet rs, int rank, int docid)	Called for each result in the resultset, used to filter out unwanted results.
byte	PostFilter.filter(Manager m, SearchRequest srq, ResultSet results, int DocAtNumber, int docid)	Called for each result in the resultset, used to filter out unwanted results.
byte	Scope.filter(Manager m, SearchRequest srq, ResultSet rs, int rank, int docid)	Called for each result in the resultset, used to filter out unwanted results, based on the presence of some strings in the document number.
byte	SimpleDecorate.filter(Manager m, SearchRequest srq, ResultSet results, int rank, int docid)	Adds all the metadata for the specified document occurring at the specified rank to the ResultSet Called for each result in the resultset, used to filter out unwanted results.
byte	SiteFilter.filter(Manager m, SearchRequest srq, ResultSet rs, int rank, int docid)	Called for each result in the resultset, used to filter out unwanted results.
java.lang.String	LocalManager.getInfo(SearchRequest srq)	Returns information about the weighting models and the post processors used for the given search request.
protected void	DependenceModelPreProcess.initialise(SearchRequest q)
void	Decorate.new_query(Manager m, SearchRequest q, ResultSet rs)	Called before the processing of a resultset using this PostFilter is applied.
void	PostFilter.new_query(Manager m, SearchRequest srq, ResultSet rs)	Called before the processing of a resultset using this PostFilter is applied.
void	Scope.new_query(Manager m, SearchRequest srq, ResultSet rs)	Creates a HashSet of scopes that can are allowed to be in the document number prefix.
void	SimpleDecorate.new_query(Manager m, SearchRequest srq, ResultSet rs)	Called before the processing of a resultset using this PostFilter is applied.
void	SiteFilter.new_query(Manager m, SearchRequest srq, ResultSet rs)	Called before the processing of a resultset using this PostFilter is applied.
void	DependenceModelPreProcess.process(Manager manager, SearchRequest q)
void	NoNegativeReq.process(Manager manager, SearchRequest q)
default void	Process.process(Manager manager, SearchRequest q)	Deprecated.
void	LocalManager.runSearchRequest(SearchRequest srq)
void	Manager.runSearchRequest(SearchRequest srq)	This runs a given SearchRequest through the four retrieval stages and adds the ResultSet to the SearchRequest object.

Uses of SearchRequest in org.terrier.rest

Methods in org.terrier.rest with parameters of type SearchRequest

Modifier and Type	Method	Description
void	JSONOutputFormat.printResults(java.io.PrintWriter pw, SearchRequest q, java.lang.String method, java.lang.String iteration, int _RESULTS_LENGTH)

Uses of SearchRequest in org.terrier.structures.cache

Methods in org.terrier.structures.cache with parameters of type SearchRequest

Modifier and Type	Method	Description
void	GrowingMapQueryResultCache.add(SearchRequest q)
void	NullQueryResultCache.add(SearchRequest q)
void	QueryResultCache.add(SearchRequest q)	Add the results for the specified query to the cache
ResultSet	GrowingMapQueryResultCache.checkCache(SearchRequest q)
ResultSet	NullQueryResultCache.checkCache(SearchRequest q)
ResultSet	QueryResultCache.checkCache(SearchRequest q)	Returns the ResultSet for the specified query, or null if that query has no cached results.
protected abstract K	GrowingMapQueryResultCache.hashQuery(SearchRequest q)
protected java.lang.String	GrowingMapQueryStringResultCache.hashQuery(SearchRequest q)

Uses of SearchRequest in org.terrier.structures.outputformat

Methods in org.terrier.structures.outputformat with parameters of type SearchRequest

Modifier and Type	Method	Description
protected java.lang.String[]	TRECDocnoOutputFormat.obtainDocnos(java.lang.String metaIndexDocumentKey, SearchRequest q, ResultSet set)	method which extracts the docnos for the prescribed resultset
void	LETOROutputFormat.printResults(java.io.PrintWriter pw, SearchRequest q, java.lang.String method, java.lang.String iteration, int numberOfResults)
void	Normalised2LETOROutputFormat.printResults(java.io.PrintWriter pw, SearchRequest q, java.lang.String method, java.lang.String iteration, int numberOfResults)
void	NormalisedLETOROutputFormat.printResults(java.io.PrintWriter pw, SearchRequest q, java.lang.String method, java.lang.String iteration, int numberOfResults)
void	NullOutputFormat.printResults(java.io.PrintWriter pw, SearchRequest q, java.lang.String method, java.lang.String iteration, int numberOfResults)	Null implementation - does nothing.
void	OutputFormat.printResults(java.io.PrintWriter pw, SearchRequest q, java.lang.String method, java.lang.String iteration, int numberOfResults)	Outputs the results of query q to PrintWriter pw, described by the method, iteration, and the specified limit on the number of results (0 means no limit).
void	TRECDocidOutputFormat.printResults(java.io.PrintWriter pw, SearchRequest q, java.lang.String method, java.lang.String iteration, int _RESULTS_LENGTH)	Prints the results for the given search request, using the specified destination.
void	TRECDocnoOutputFormat.printResults(java.io.PrintWriter pw, SearchRequest q, java.lang.String method, java.lang.String iteration, int _RESULTS_LENGTH)	Prints the results for the given search request, using the specified destination.
void	WritableOutputFormat.printResults(java.io.PrintWriter pw, SearchRequest q, java.lang.String method, java.lang.String iteration, int numberOfResults)
void	RawOutputFormat.writeResults(java.io.OutputStream os, SearchRequest q, java.lang.String method, java.lang.String iteration, int numberOfResults)
void	WritableOutputFormat.writeResults(java.io.OutputStream os, SearchRequest q, java.lang.String method, java.lang.String iteration, int numberOfResults)