org.openimaj.text.nlp.namedentity

Class QuickSearcher

java.lang.Object

org.openimaj.text.nlp.namedentity.QuickSearcher

public class QuickSearcher
extends Object

Given a lucene Directory index and an Analyzer allow for searches of particular fields.

Author:

Laurence Willmore (lgw1e10@ecs.soton.ac.uk), Sina Samangooei (ss@ecs.soton.ac.uk)

Constructor Summary

Constructors

Constructor and Description
QuickSearcher(org.apache.lucene.store.Directory index, org.apache.lucene.analysis.Analyzer analyser) the index to search and the analyser to use to process queries

Method Summary

Modifier and Type	Method and Description
HashMap<String[],Float>	search(String searchfieldName, String[] returnFieldName, String queryStr, int limit) Given a search field to search,the name of the field to return results in and a query string, return search results up to the limit.
HashMap<String[],Float>	searchFiltered(String searchfieldName, String[] returnFieldName, String queryStr, String filterFieldName, List<String> filterQueries) Given a list of values for the filterField, this method will return the scores of a search for the documents which satisfy one of those filter values.

Methods inherited from class java.lang.Object

clone, equals, finalize, getClass, hashCode, notify, notifyAll, toString, wait, wait, wait

Constructor Detail

QuickSearcher

public QuickSearcher(org.apache.lucene.store.Directory index,
                     org.apache.lucene.analysis.Analyzer analyser)

the index to search and the analyser to use to process queries

Parameters:

index -

analyser -

Method Detail

search

public HashMap<String[],Float> search(String searchfieldName,
                                      String[] returnFieldName,
                                      String queryStr,
                                      int limit)
                               throws org.apache.lucene.queryparser.classic.ParseException,
                                      IOException

Given a search field to search,the name of the field to return results in and a query string, return search results up to the limit.

Parameters:

searchfieldName -

returnFieldName -

queryStr -

limit -

Returns:

search results (with confidences)

Throws:

org.apache.lucene.queryparser.classic.ParseException

IOException

searchFiltered

public HashMap<String[],Float> searchFiltered(String searchfieldName,
                                              String[] returnFieldName,
                                              String queryStr,
                                              String filterFieldName,
                                              List<String> filterQueries)

Given a list of values for the filterField, this method will return the scores of a search for the documents which satisfy one of those filter values.

Parameters:

searchfieldName - = Name of the field to search

returnFieldName - = Name of the Field to return

queryStr - = String that should be used to search

filterFieldName - = Name of field to filter on

filterQueries - = Values of the filterField. Only documents with one of these values will be returned.

Returns:

same as the other search

See Also:

search(String, String[], String, int)