TRECQuery (Terrier Information Retrieval Platform 5.0 API)

java.lang.Object
- org.terrier.applications.batchquerying.TRECQuery

All Implemented Interfaces:

Iterator<String>, QuerySource

Direct Known Subclasses:

SingleLineTRECQuery, TRECQuery
```
public class TRECQuery
extends Object
implements QuerySource
```
This class is used for reading the queries from TREC topic files.
Properties:
- trecquery.ignore.desc.narr.name.tokens - should the token DESCRIPTION and NARRATIVE in the desc and narr fields be ignored? Defaluts to true
- tokeniser - name of the Tokeniser class to use to tokenise topics. Defaults to EnglishTokeniser.
- trec.encoding - use to set the encoding of TREC topic files. Defaults to the systems default encoding.
Author:

Ben He & Craig Macdonald

Field Summary

Fields
Modifier and Type	Field and Description
`protected static String`	`desiredEncoding` Encoding to be used to open all files.
`protected static boolean`	`IGNORE_DESC_NARR_NAME_TOKENS` Value of `trecquery.ignore.desc.narr.name.tokens` - should the token DESCRIPTION and NARRATIVE in the desc and narr fields be ignored? Defaluts to true?
`protected int`	`index` The index of the queries.
`protected static org.slf4j.Logger`	`logger` The logger used for this class
`protected String[]`	`queries` The queries in the topic files.
`protected String[]`	`query_ids` The query identifiers in the topic files.
`protected String[]`	`topicFiles` The topic files used in this object

Constructor Summary

Constructors
Constructor and Description
`TRECQuery()` Constructs an instance of TRECQuery, that reads and stores all the queries from the files defined in the trec.topics property.
`TRECQuery(File queryfile)` Constructs an instance of TRECQuery that reads and stores all the queries from a the specified query file.
`TRECQuery(File[] queryfiles)` Constructs an instance of TRECQuery that reads and stores all the queries from the specified query files.
`TRECQuery(String queryfilename)` Constructs an instance of TRECQuery that reads and stores all the queries from a file with the specified filename.
`TRECQuery(String[] queryfilenames)` Constructs an instance of TRECQuery that reads and stores all the queries from files with the specified filename.

Method Summary

All Methods Static Methods Instance Methods Concrete Methods Deprecated Methods
Modifier and Type	Method and Description
`boolean`	`extractQuery(String[] queryfilenames, Vector<String> vecStringQueries, Vector<String> vecStringIds)` Extracts and stores all the queries from query files.
`boolean`	`extractQuery(String queryfilename, Vector<String> vecStringQueries, Vector<String> vecStringIds)` Extracts and stores all the queries from a query file.
`int`	`getIndexOfCurrentQuery()` Returns the index of the last obtained query.
`String[]`	`getInfo()` Returns the filenames of the topic files from which the queries were extracted
`int`	`getNumberOfQueries()` Returns the number of the queries read from the processed topic files.
`String`	`getQuery(String queryNo)` Return the query for the given query number.
`String`	`getQueryId()` Returns the query identifier of the last query fetched, or the first one, if none has been fetched yet.
`String[]`	`getQueryIds()` Returns the query ids
`String[]`	`getTopicFilenames()` Deprecated.
`boolean`	`hasMoreQueries()` Deprecated.
`boolean`	`hasNext()`
`static void`	`main(String[] args)` main
`String`	`next()`
`String`	`nextQuery()` Deprecated.
`void`	`remove()`
`void`	`reset()` Resets the query source back to the first query.
`String[]`	`toArray()` Returns the queries in an array of strings

Methods inherited from class java.lang.Object
clone, equals, finalize, getClass, hashCode, notify, notifyAll, toString, wait, wait, wait

Methods inherited from interface java.util.Iterator
forEachRemaining

- Field Detail
  - logger
```
protected static final org.slf4j.Logger logger
```
    The logger used for this class
  - IGNORE_DESC_NARR_NAME_TOKENS
```
protected static final boolean IGNORE_DESC_NARR_NAME_TOKENS
```
    Value of trecquery.ignore.desc.narr.name.tokens - should the token DESCRIPTION and NARRATIVE in the desc and narr fields be ignored? Defaluts to true?
  - desiredEncoding
```
protected static String desiredEncoding
```
    Encoding to be used to open all files.
  - topicFiles
```
protected String[] topicFiles
```
    The topic files used in this object
  - queries
```
protected String[] queries
```
    The queries in the topic files.
  - query_ids
```
protected String[] query_ids
```
    The query identifiers in the topic files.
  - index
```
protected int index
```
    The index of the queries.
- Constructor Detail
  - TRECQuery
```
public TRECQuery()
```
    Constructs an instance of TRECQuery, that reads and stores all the queries from the files defined in the trec.topics property.
  - TRECQuery
```
public TRECQuery(File queryfile)
```
    Constructs an instance of TRECQuery that reads and stores all the queries from a the specified query file.
    
    Parameters:
    
    queryfile - File the file containing the queries.
  - TRECQuery
```
public TRECQuery(File[] queryfiles)
```
    Constructs an instance of TRECQuery that reads and stores all the queries from the specified query files.
    
    Parameters:
    
    queryfiles - File the file containing the queries.
  - TRECQuery
```
public TRECQuery(String queryfilename)
```
    Constructs an instance of TRECQuery that reads and stores all the queries from a file with the specified filename.
    
    Parameters:
    
    queryfilename - String the name of the file containing all the queries.
  - TRECQuery
```
public TRECQuery(String[] queryfilenames)
```
    Constructs an instance of TRECQuery that reads and stores all the queries from files with the specified filename.
    
    Parameters:
    
    queryfilenames - String[] the name of the files containing all the queries.
- Method Detail
  - extractQuery
```
public boolean extractQuery(String[] queryfilenames,
                            Vector<String> vecStringQueries,
                            Vector<String> vecStringIds)
```
    Extracts and stores all the queries from query files.
    
    Parameters:
    
    queryfilenames - String the name of files containing topics.
    
    vecStringQueries - Vector a vector containing the queries as strings.
    
    vecStringIds - Vector a vector containing the query identifiers as strings.
    
    Returns:
    
    boolean true if some queries were successfully extracted.
  - extractQuery
```
public boolean extractQuery(String queryfilename,
                            Vector<String> vecStringQueries,
                            Vector<String> vecStringIds)
```
    Extracts and stores all the queries from a query file.
    
    Parameters:
    
    queryfilename - String the name of a file containing topics.
    
    vecStringQueries - Vector a vector containing the queries as strings.
    
    vecStringIds - Vector a vector containing the query identifiers as strings.
    
    Returns:
    
    boolean true if some queries were successfully extracted.
  - getIndexOfCurrentQuery
```
public int getIndexOfCurrentQuery()
```
    Returns the index of the last obtained query.
    
    Returns:
    
    int the index of the last obtained query.
  - getNumberOfQueries
```
public int getNumberOfQueries()
```
    Returns the number of the queries read from the processed topic files.
    
    Returns:
    
    int the number of topics contained in the processed topic files.
  - getInfo
```
public String[] getInfo()
```
    Returns the filenames of the topic files from which the queries were extracted
    
    Specified by:
    
    getInfo in interface QuerySource
  - getTopicFilenames
```
public String[] getTopicFilenames()
```
    Deprecated.
  - getQuery
```
public String getQuery(String queryNo)
```
    Return the query for the given query number.
    
    Parameters:
    
    queryNo - String The number of a query.
    
    Returns:
    
    String the string representing the query.
  - hasMoreQueries
```
public boolean hasMoreQueries()
```
    Deprecated.
    
    Test if there are more queries to process.
    
    Returns:
    
    boolean true if there are more queries to process, otherwise returns false.
  - hasNext
```
public boolean hasNext()
```
    Specified by:
    
    hasNext in interface Iterator<String>
  - nextQuery
```
public String nextQuery()
```
    Deprecated.
    
    Returns a query.
    
    Returns:
    
    String the next query.
  - next
```
public String next()
```
    Specified by:
    
    next in interface Iterator<String>
  - getQueryId
```
public String getQueryId()
```
    Returns the query identifier of the last query fetched, or the first one, if none has been fetched yet.
    
    Specified by:
    
    getQueryId in interface QuerySource
    
    Returns:
    
    String the query number of a query.
  - getQueryIds
```
public String[] getQueryIds()
```
    Returns the query ids
    
    Returns:
    
    String array containing the query ids.
    
    Since:
    
    2.2
  - toArray
```
public String[] toArray()
```
    Returns the queries in an array of strings
    
    Returns:
    
    String[] an array containing the strings that represent the queries.
  - reset
```
public void reset()
```
    Resets the query source back to the first query.
    
    Specified by:
    
    reset in interface QuerySource
  - remove
```
public void remove()
```
    Specified by:
    
    remove in interface Iterator<String>
  - main
```
public static void main(String[] args)
```
    main
    
    Parameters:
    
    args -

Class TRECQuery

Field Summary

Constructor Summary

Method Summary

Methods inherited from class java.lang.Object

Methods inherited from interface java.util.Iterator

Field Detail

logger

IGNORE_DESC_NARR_NAME_TOKENS

desiredEncoding

topicFiles

queries

query_ids

index

Constructor Detail

TRECQuery

TRECQuery

TRECQuery

TRECQuery

TRECQuery

Method Detail

extractQuery

extractQuery

getIndexOfCurrentQuery

getNumberOfQueries

getInfo

getTopicFilenames

getQuery

hasMoreQueries

hasNext

nextQuery

next

getQueryId

getQueryIds

toArray

reset

remove

main