org.cdlib.xtf.textEngine
Class QueryRequest

Object
  extended by QueryRequest
All Implemented Interfaces:
Cloneable

public class QueryRequest
extends Object
implements Cloneable

Stores a single query request to be processed by the XTF text engine.

Author:
Martin Haye

Field Summary
 BoostSetParams boostSetParams
          Experimental, and probably temporary: Boost set info
 String displayStyle
          Path (base dir relative) for the resultFormatter stylesheet
 boolean explainScores
          Whether to calculate an explanation of each score.
 FacetSpec[] facetSpecs
          Facet specifications (if any)
 String indexPath
          Path to the Lucene index we want to search
 int maxContext
          Target size, in characters, for snippets
 int maxDocs
          Max # documents to return from this query
 boolean normalizeScores
          Whether to normalize scores (turn off to help debug ranking problems)
 String parserInput
          Optional: the block sent to the query parser stylesheet
 String parserOutput
          Optional: the raw output of the query parser stylesheet
 Query query
          The Lucene query to perform
 String returnMetaFields
          Optional: list of metadata fields to return (defaults to all)
 String sortMetaFields
          Optional list of fields to sort documents by
 SpellcheckParams spellcheckParams
          Experimental: provide spelling suggestions
 int startDoc
          Document rank to start with (0-based)
 int termLimit
          Limit on the total number of terms allowed
 int termMode
          Term marking mode
 int workLimit
          Limit on the total amount of "work"
 
Constructor Summary
QueryRequest()
           
 
Method Summary
 Object clone()
           
 
Methods inherited from class Object
equals, finalize, getClass, hashCode, notify, notifyAll, toString, wait, wait, wait
 

Field Detail

displayStyle

public String displayStyle
Path (base dir relative) for the resultFormatter stylesheet


startDoc

public int startDoc
Document rank to start with (0-based)


maxDocs

public int maxDocs
Max # documents to return from this query


indexPath

public String indexPath
Path to the Lucene index we want to search


query

public Query query
The Lucene query to perform


sortMetaFields

public String sortMetaFields
Optional list of fields to sort documents by


maxContext

public int maxContext
Target size, in characters, for snippets


termLimit

public int termLimit
Limit on the total number of terms allowed


workLimit

public int workLimit
Limit on the total amount of "work"


termMode

public int termMode
Term marking mode


facetSpecs

public FacetSpec[] facetSpecs
Facet specifications (if any)


normalizeScores

public boolean normalizeScores
Whether to normalize scores (turn off to help debug ranking problems)


explainScores

public boolean explainScores
Whether to calculate an explanation of each score. Time-consuming, so should not be used except during development


boostSetParams

public BoostSetParams boostSetParams
Experimental, and probably temporary: Boost set info


spellcheckParams

public SpellcheckParams spellcheckParams
Experimental: provide spelling suggestions


parserInput

public String parserInput
Optional: the block sent to the query parser stylesheet


parserOutput

public String parserOutput
Optional: the raw output of the query parser stylesheet


returnMetaFields

public String returnMetaFields
Optional: list of metadata fields to return (defaults to all)

Constructor Detail

QueryRequest

public QueryRequest()
Method Detail

clone

public Object clone()
Overrides:
clone in class Object