org.terrier.querying

Interface Manager

All Known Implementing Classes:

LocalManager, ThreadSafeManager

public interface Manager

Method Summary

Modifier and Type	Method and Description
IndexRef	getIndexRef()
SearchRequest	newSearchRequest() Ask for new SearchRequest object to be made.
SearchRequest	newSearchRequest(String QueryID) Ask for new SearchRequest object to be made.
SearchRequest	newSearchRequest(String QueryID, 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	newSearchRequestFromQuery(String query) Ask for new SearchRequest object to be made given a query to be parsed
void	runSearchRequest(SearchRequest srq) This runs a given SearchRequest through the four retrieval stages and adds the ResultSet to the SearchRequest object.
void	setProperties(Properties p) Set all these properties.
void	setProperty(String key, String value) Provide a common interface for changing property values.

Method Detail

newSearchRequest

SearchRequest newSearchRequest()

Ask for new SearchRequest object to be made. This is internally a Request object

newSearchRequest

SearchRequest newSearchRequest(String QueryID)

Ask for new SearchRequest object to be made. This is internally a Request object

Parameters:

QueryID - The request should be identified by QueryID

newSearchRequest

SearchRequest newSearchRequest(String QueryID,
                               String query)

Ask for new SearchRequest object to be made, instantiated using the specified query id, and that the specified query should be parsed.

Parameters:

QueryID - The request should be identified by QueryID

query - The actual user query

Returns:

The fully init'd search request for use in the manager

Since:

2.0

newSearchRequestFromQuery

SearchRequest newSearchRequestFromQuery(String query)

Ask for new SearchRequest object to be made given a query to be parsed

Parameters:

query - The actual user query

Returns:

The fully init'd search request for use in the manager

Since:

4.2

setProperty

void setProperty(String key,
                 String value)

Provide a common interface for changing property values.

Parameters:

key - Key of property to set

value - Value of property to set

setProperties

void setProperties(Properties p)

Set all these properties. Implemented using setProperty(String,String).

Parameters:

p - All properties to set

runSearchRequest

void runSearchRequest(SearchRequest srq)

This runs a given SearchRequest through the four retrieval stages and adds the ResultSet to the SearchRequest object.

Parameters:

srq - - the SearchRequest to be processed

getIndexRef

IndexRef getIndexRef()