Package org.dlese.dpc.index

Class ResultDocConfig

java.lang.Object

org.dlese.dpc.index.ResultDocConfig

public final class ResultDocConfig
extends Object

Contains the arbitraty attributes, the index and the users query, making them available in DocReaders.

Author:

John Weatherley

See Also:

• DocReader

Field Summary

Fields

Modifier and Type	Field	Description
HashMap	attributes	The attributes that will be made availalbe to DocReaders at search time.
org.apache.lucene.search.Filter	filter	The Lucene serach Filter used
SimpleLuceneIndex	index	The index being used
org.apache.lucene.search.Query	luceneQuery	The Query used
String	query	The query used

Constructor Summary

Constructors

Constructor	Description
ResultDocConfig(String myQuery, org.apache.lucene.search.Query luceneQueryObj, org.apache.lucene.search.Filter myFilter, HashMap docReaderAttributes, SimpleLuceneIndex myIndex)	Constructor for the ResultDocConfig.
ResultDocConfig(SimpleLuceneIndex myIndex)	Minimum constructor for the ResultDocConfig.

Method Summary

Methods inherited from class java.lang.Object

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

Field Details

index

public SimpleLuceneIndex index

The index being used

query

public String query

The query used

luceneQuery

public org.apache.lucene.search.Query luceneQuery

The Query used

filter

public org.apache.lucene.search.Filter filter

The Lucene serach Filter used

attributes

public HashMap attributes

The attributes that will be made availalbe to DocReaders at search time.

Constructor Details

ResultDocConfig

public ResultDocConfig(String myQuery,
 org.apache.lucene.search.Query luceneQueryObj,
 org.apache.lucene.search.Filter myFilter,
 HashMap docReaderAttributes,
 SimpleLuceneIndex myIndex)

Constructor for the ResultDocConfig.

Parameters:

myQuery - The query that was used (as a String)

luceneQueryObj - The Lucene Query object used

myFilter - The Filter used to refine the search, or null if none used.

docReaderAttributes - Attributes that will be made availalbe to DocReaders. May be null.

myIndex - A pointer to the index that was searched over.

ResultDocConfig

public ResultDocConfig(SimpleLuceneIndex myIndex)

Minimum constructor for the ResultDocConfig.

Parameters:

myIndex - A pointer to the index that was searched over.