uk.ac.gla.terrier.structures
Class SingleLineTRECQuery

java.lang.Object
  uk.ac.gla.terrier.structures.TRECQuery
      uk.ac.gla.terrier.structures.SingleLineTRECQuery

public class SingleLineTRECQuery
extends TRECQuery

This class can be used to extract batch queries from a simpler format than the regular SGML TREC format. In particular, this class reads queries, one per line, verbatim from the specified file(s). Empty lines and lines starting with # are ignored. Queries are not tokenised by this class, and in general pased verbatim to the query parser. Moreover, it assumes that the first token on each line is the query Id. This can be controlled by the properties SingleLineTRECQuery.queryid.exists (default true). Trailing colons in the query Id are removed (aka TREC single line format from the Million Query track). Use this class by specifying trec.topics.parser=SingleLineTRECQuery and running TRECQuerying or TrecTerrier as normal.

Properties:

• SingleLineTRECQuery.queryid.exists - does the line start with a query Id?
• SingleLineTRECQuery.periods.allowed (defaults to false). By default, periods are removed from the query. Stop this by setting this property to true.

Constructor Summary

SingleLineTRECQuery()
Constructor - default

SingleLineTRECQuery(java.io.File queryfile)
Reads queries from the specified file

SingleLineTRECQuery(java.lang.String queryfilename)
Reads queries from the specified filename

Method Summary

boolean

extractQuery(java.lang.String queryfilename, java.util.Vector<java.lang.String> vecStringQueries, java.util.Vector<java.lang.String> vecStringIds) Extracts queries from the specified filename, adding their contents to vecStringQueries and the corresponding query ids to vecStringIds.

Methods inherited from class uk.ac.gla.terrier.structures.TRECQuery

getIndexOfCurrentQuery, getNumberOfQueries, getQuery, getQueryId, getQueryIds, getTopicFilenames, hasMoreQueries, nextQuery, reset, toArray

Methods inherited from class java.lang.Object

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

Constructor Detail

SingleLineTRECQuery

public SingleLineTRECQuery()

Constructor - default

SingleLineTRECQuery

public SingleLineTRECQuery(java.io.File queryfile)

Reads queries from the specified file

SingleLineTRECQuery

public SingleLineTRECQuery(java.lang.String queryfilename)

Reads queries from the specified filename

Method Detail

extractQuery

public boolean extractQuery(java.lang.String queryfilename,
                            java.util.Vector<java.lang.String> vecStringQueries,
                            java.util.Vector<java.lang.String> vecStringIds)

Extracts queries from the specified filename, adding their contents to vecStringQueries and the corresponding query ids to vecStringIds.

Overrides:

extractQuery in class TRECQuery

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:

true if some queries were successfully read