Class 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(String, String, String[]), 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.

This is a Lucene.NET EXPERIMENTAL API, use at your own risk

Inheritance
System.Object
Query
DrillDownQuery
Inherited Members
System.Object.Equals(System.Object, System.Object)
System.Object.GetType()
System.Object.MemberwiseClone()
System.Object.ReferenceEquals(System.Object, System.Object)
Namespace: Lucene.Net.Facet
Assembly: Lucene.Net.Facet.dll
Syntax
public sealed class DrillDownQuery : Query

Constructors

| Improve this Doc View Source

DrillDownQuery(FacetsConfig)

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

Declaration
public DrillDownQuery(FacetsConfig config)
Parameters
Type Name Description
FacetsConfig config
| Improve this Doc View Source

DrillDownQuery(FacetsConfig, Query)

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.

Declaration
public DrillDownQuery(FacetsConfig config, Query baseQuery)
Parameters
Type Name Description
FacetsConfig config
Query baseQuery

Methods

| Improve this Doc View Source

Add(String, Filter)

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

Declaration
public void Add(string dim, Filter subFilter)
Parameters
Type Name Description
System.String dim
Filter subFilter
| Improve this Doc View Source

Add(String, Query)

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.

Declaration
public void Add(string dim, Query subQuery)
Parameters
Type Name Description
System.String dim
Query subQuery
| Improve this Doc View Source

Add(String, String[])

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.

Declaration
public void Add(string dim, params string[] path)
Parameters
Type Name Description
System.String dim
System.String[] path
| Improve this Doc View Source

Clone()

Declaration
public override object Clone()
Returns
Type Description
System.Object
Overrides
| Improve this Doc View Source

Equals(Object)

Declaration
public override bool Equals(object obj)
Parameters
Type Name Description
System.Object obj
Returns
Type Description
System.Boolean
Overrides
| Improve this Doc View Source

GetHashCode()

Declaration
public override int GetHashCode()
Returns
Type Description
System.Int32
Overrides
| Improve this Doc View Source

Rewrite(IndexReader)

Declaration
public override Query Rewrite(IndexReader r)
Parameters
Type Name Description
IndexReader r
Returns
Type Description
Query
Overrides
| Improve this Doc View Source

Term(String, String, String[])

Creates a drill-down term.

Declaration
public static Term Term(string field, string dim, params string[] path)
Parameters
Type Name Description
System.String field
System.String dim
System.String[] path
Returns
Type Description
Term
| Improve this Doc View Source

ToString(String)

Declaration
public override string ToString(string field)
Parameters
Type Name Description
System.String field
Returns
Type Description
System.String
Overrides