Package org.apache.lucene.facet

Class DrillSideways

java.lang.Object

org.apache.lucene.facet.DrillSideways

public class DrillSideways
extends java.lang.Object

Computes drill down and sideways counts for the provided DrillDownQuery. Drill sideways counts include alternative values/aggregates for the drill-down dimensions so that a dimension does not disappear after the user drills down into it.

Use one of the static search methods to do the search, and then get the hits and facet results from the returned DrillSideways.DrillSidewaysResult.

NOTE: this allocates one FacetsCollector for each drill-down, plus one. If your index has high number of facet labels then this will multiply your memory usage.

Nested Class Summary

Nested Classes

Modifier and Type	Class	Description
static class	DrillSideways.DrillSidewaysResult	Result of a drill sideways search, including the Facets and TopDocs.

Constructor Summary

Constructors

Constructor	Description
DrillSideways(IndexSearcher searcher, FacetsConfig config, SortedSetDocValuesReaderState state)	Create a new DrillSideways instance, assuming the categories were indexed with SortedSetDocValuesFacetField.
DrillSideways(IndexSearcher searcher, FacetsConfig config, TaxonomyReader taxoReader)	Create a new DrillSideways instance.
DrillSideways(IndexSearcher searcher, FacetsConfig config, TaxonomyReader taxoReader, SortedSetDocValuesReaderState state)	Create a new DrillSideways instance, where some dimensions were indexed with SortedSetDocValuesFacetField and others were indexed with FacetField.

Method Summary

Modifier and Type	Method	Description
DrillSideways.DrillSidewaysResult	search(DrillDownQuery query, int topN)	Search, sorting by score, and computing drill down and sideways counts.
DrillSideways.DrillSidewaysResult	search(DrillDownQuery query, Collector hitCollector)	Search, collecting hits with a Collector, and computing drill down and sideways counts.
DrillSideways.DrillSidewaysResult	search(DrillDownQuery query, Filter filter, FieldDoc after, int topN, Sort sort, boolean doDocScores, boolean doMaxScore)	Search, sorting by Sort, and computing drill down and sideways counts.
DrillSideways.DrillSidewaysResult	search(ScoreDoc after, DrillDownQuery query, int topN)	Search, sorting by score, and computing drill down and sideways counts.

Methods inherited from class java.lang.Object

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

Constructor Detail

DrillSideways

public DrillSideways(IndexSearcher searcher,
                     FacetsConfig config,
                     TaxonomyReader taxoReader)

Create a new DrillSideways instance.

DrillSideways

public DrillSideways(IndexSearcher searcher,
                     FacetsConfig config,
                     SortedSetDocValuesReaderState state)

Create a new DrillSideways instance, assuming the categories were indexed with SortedSetDocValuesFacetField.

DrillSideways

public DrillSideways(IndexSearcher searcher,
                     FacetsConfig config,
                     TaxonomyReader taxoReader,
                     SortedSetDocValuesReaderState state)

Create a new DrillSideways instance, where some dimensions were indexed with SortedSetDocValuesFacetField and others were indexed with FacetField.

Method Detail

search

public DrillSideways.DrillSidewaysResult search(DrillDownQuery query,
                                                Collector hitCollector)
                                         throws java.io.IOException

Search, collecting hits with a Collector, and computing drill down and sideways counts.

Throws:

java.io.IOException

search

public DrillSideways.DrillSidewaysResult search(DrillDownQuery query,
                                                Filter filter,
                                                FieldDoc after,
                                                int topN,
                                                Sort sort,
                                                boolean doDocScores,
                                                boolean doMaxScore)
                                         throws java.io.IOException

Search, sorting by Sort, and computing drill down and sideways counts.

Throws:

java.io.IOException

search

public DrillSideways.DrillSidewaysResult search(DrillDownQuery query,
                                                int topN)
                                         throws java.io.IOException

Search, sorting by score, and computing drill down and sideways counts.

Throws:

java.io.IOException

search

public DrillSideways.DrillSidewaysResult search(ScoreDoc after,
                                                DrillDownQuery query,
                                                int topN)
                                         throws java.io.IOException

Search, sorting by score, and computing drill down and sideways counts.

Throws:

java.io.IOException