C# Class Lucene.Net.Facet.DrillDownQuery

A Query for drill-down over facet categories. You should call Add(string, string[]) for every group of categories you want to drill-down over.

NOTE: if you choose to create your own Query by calling Term, it is recommended to wrap it with ConstantScoreQuery and set the boost to 0.0f, so that it does not affect the scores of the documents. @lucene.experimental

Inheritance: Query

Datei anzeigen Open project: apache/lucenenet Class Usage Examples

Private Properties

Property	Type	Description
DrillDownQuery	Lucene.Net.Support
DrillDownQuery	Lucene.Net.Support
DrillDownQuery	Lucene.Net.Support
GetFilter	Filter
Merge	void

Public Methods

Method	Description
Add ( string dim ) : void	Adds one dimension of drill downs; if you pass the same dimension more than once it is OR'd with the previous cofnstraints on that dimension, and all dimensions are AND'd against each other and the base query.
Add ( string dim, Filter subFilter ) : void	Expert: add a custom drill-down Filter, e.g. when drilling down after range faceting.
Add ( string dim, Query subQuery ) : void	Expert: add a custom drill-down subQuery. Use this when you have a separate way to drill-down on the dimension than the indexed facet ordinals.
Clone ( ) : object
DrillDownQuery ( Lucene.Net.Facet.FacetsConfig config ) : Lucene.Net.Support	Creates a new DrillDownQuery without a base query, to perform a pure browsing query (equivalent to using MatchAllDocsQuery as base).
DrillDownQuery ( Lucene.Net.Facet.FacetsConfig config, Query baseQuery ) : Lucene.Net.Support	Creates a new DrillDownQuery over the given base query. Can be `null`, in which case the result Query from Rewrite(IndexReader) will be a pure browsing query, filtering on the added categories only.
Equals ( object obj ) : bool
GetHashCode ( ) : int
Rewrite ( IndexReader r ) : Query
Term ( string field, string dim ) : Term	Creates a drill-down term.
ToString ( string field ) : string

Private Methods

Method	Description
DrillDownQuery ( Lucene.Net.Facet.FacetsConfig config, BooleanQuery query, int?>.IDictionary drillDownDims ) : Lucene.Net.Support	Used by Clone
DrillDownQuery ( Lucene.Net.Facet.FacetsConfig config, Filter filter, DrillDownQuery other ) : Lucene.Net.Support	Used by DrillSideways
DrillDownQuery ( Lucene.Net.Facet.FacetsConfig config, Query baseQuery, IList clauses, int?>.IDictionary drillDownDims ) : Lucene.Net.Support	Used by DrillSideways
GetFilter ( Query query ) : Filter
Merge ( string dim, string path ) : void	Merges (ORs) a new path into an existing AND'd clause.

Method Details

Add() public method

Adds one dimension of drill downs; if you pass the same dimension more than once it is OR'd with the previous cofnstraints on that dimension, and all dimensions are AND'd against each other and the base query.

public Add ( string dim ) : void
dim	string
return	void

Add() public method

Expert: add a custom drill-down Filter, e.g. when drilling down after range faceting.

public Add ( string dim, Filter subFilter ) : void
dim	string
subFilter	Filter
return	void

Add() public method

Expert: add a custom drill-down subQuery. Use this when you have a separate way to drill-down on the dimension than the indexed facet ordinals.

public Add ( string dim, Query subQuery ) : void
dim	string
subQuery	Query
return	void

Clone() public method

public Clone ( ) : object
return	object

DrillDownQuery() public method

Creates a new DrillDownQuery without a base query, to perform a pure browsing query (equivalent to using MatchAllDocsQuery as base).

public DrillDownQuery ( Lucene.Net.Facet.FacetsConfig config ) : Lucene.Net.Support
config	Lucene.Net.Facet.FacetsConfig
return	Lucene.Net.Support

DrillDownQuery() public method

Creates a new DrillDownQuery over the given base query. Can be null, in which case the result Query from Rewrite(IndexReader) will be a pure browsing query, filtering on the added categories only.

public DrillDownQuery ( Lucene.Net.Facet.FacetsConfig config, Query baseQuery ) : Lucene.Net.Support
config	Lucene.Net.Facet.FacetsConfig
baseQuery	Query
return	Lucene.Net.Support

Equals() public method

public Equals ( object obj ) : bool
obj	object
return	bool

GetHashCode() public method

public GetHashCode ( ) : int
return	int

Rewrite() public method

public Rewrite ( IndexReader r ) : Query
r	IndexReader
return	Query

Term() public static method

Creates a drill-down term.

public static Term ( string field, string dim ) : Term
field	string
dim	string
return	Term

ToString() public method

public ToString ( string field ) : string
field	string
return	string