ivory.bloomir.util

Class QueryUtility

java.lang.Object

ivory.bloomir.util.QueryUtility

public class QueryUtility
extends Object

Provides auxiliary functions for query processing.

Author:

Nima Asadi

Constructor Summary

Constructors

Constructor and Description
QueryUtility()

Method Summary

Methods

Modifier and Type	Method and Description
static HMapIF	loadCf(RetrievalEnvironment env, HMapIV<String> parsedQueries)
static HMapIF	loadCf(RetrievalEnvironment env, String queryPath) Loads CF values for the set of terms extracted from a query file.
static HMapIF	loadIdf(RetrievalEnvironment env, HMapIV<String> parsedQueries)
static HMapIF	loadIdf(RetrievalEnvironment env, String queryPath) Loads IDF values for the set of terms extracted from a query file.
static HMapIV<String>	loadQueries(com.google.common.io.InputSupplier<? extends InputStream> queryInputSupplier) Reads a query set in an XML format as follows: <parameters> <query qid="Query_ID">Query Text</query> </parameters>
static HMapIV<String>	loadQueries(String queryPath) Loads a set of queries from an input file.
static HMapIV<String[]>	parseQueries(RetrievalEnvironment env, String queryPath) Loads and tokenizes a set of queries.
static HMapIV<int[]>	queryToIntegerCode(RetrievalEnvironment env, HMapIV<String> parsedQueries)
static HMapIV<int[]>	queryToIntegerCode(RetrievalEnvironment env, String queryPath) Reads and converts queries into their integer forms.

Methods inherited from class java.lang.Object

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

Constructor Detail

QueryUtility

public QueryUtility()

Method Detail

loadCf

public static HMapIF loadCf(RetrievalEnvironment env,
            HMapIV<String> parsedQueries)
                     throws Exception

Throws:

Exception

loadCf

public static HMapIF loadCf(RetrievalEnvironment env,
            String queryPath)
                     throws Exception

Loads CF values for the set of terms extracted from a query file.

Parameters:

env - RetrievalEnvironment object associated with the index

queryPath - Path to the query file

Returns:

A Map of term ids to its cf values.

Throws:

Exception

loadIdf

public static HMapIF loadIdf(RetrievalEnvironment env,
             HMapIV<String> parsedQueries)
                      throws Exception

Throws:

Exception

loadIdf

public static HMapIF loadIdf(RetrievalEnvironment env,
             String queryPath)
                      throws Exception

Loads IDF values for the set of terms extracted from a query file.

Parameters:

env - RetrievalEnvironment object associated with the index

queryPath - Path to the query file

Returns:

A Map of term ids to its idf.

Throws:

Exception

loadQueries

public static HMapIV<String> loadQueries(com.google.common.io.InputSupplier<? extends InputStream> queryInputSupplier)
                                  throws ParserConfigurationException,
                                         SAXException,
                                         IOException

Reads a query set in an XML format as follows: <parameters> <query qid="Query_ID">Query Text</query> </parameters>

Parameters:

queryInputSupplier - An input supplier that provides the queries

Returns:

A map of query id to query text

Throws:

ParserConfigurationException

SAXException

IOException

loadQueries

public static HMapIV<String> loadQueries(String queryPath)
                                  throws Exception

Loads a set of queries from an input file.

Parameters:

queryPath - Path to the query file

Returns:

A Map of query id to query text

Throws:

Exception

parseQueries

public static HMapIV<String[]> parseQueries(RetrievalEnvironment env,
                            String queryPath)
                                     throws Exception

Loads and tokenizes a set of queries.

Parameters:

queryPath - Path to the file containing the queries

Returns:

Map of query id to an array of strings (i.e., the tokens of the original query)

Throws:

Exception

queryToIntegerCode

public static HMapIV<int[]> queryToIntegerCode(RetrievalEnvironment env,
                               HMapIV<String> parsedQueries)
                                        throws Exception

Throws:

Exception

queryToIntegerCode

public static HMapIV<int[]> queryToIntegerCode(RetrievalEnvironment env,
                               String queryPath)
                                        throws Exception

Reads and converts queries into their integer forms.

Parameters:

env - RetrievalEnvironment object associated with the index

queryPath - Path to the query file

Returns:

A Map of query ids to a list of integers. Each integer i is the code for term i in the query. Note that depending on the tokenizer, stopwords may be removed and/or stemming might apply to the given query phrase.

Throws:

Exception