Package org.apache.jackrabbit.oak.plugins.index.lucene.util

Class FacetHelper

java.lang.Object

org.apache.jackrabbit.oak.plugins.index.lucene.util.FacetHelper

public class FacetHelper
extends java.lang.Object

Field Summary

Fields

Modifier and Type	Field	Description
static java.lang.String	ATTR_FACET_FIELDS	IndexPaln Attribute name which refers to the name of the fields that should be used for facets.

Method Summary

Modifier and Type	Method	Description
static java.util.List<java.lang.String>	getFacetColumnNamesFromPlan(QueryIndex.IndexPlan plan)	Get the column names of all the facets from the index plan, if any.
static org.apache.lucene.facet.Facets	getFacets(IndexSearcher searcher, Query query, QueryIndex.IndexPlan plan, org.apache.jackrabbit.oak.plugins.index.search.IndexDefinition.SecureFacetConfiguration secureFacetConfiguration)
static org.apache.lucene.facet.FacetsConfig	getFacetsConfig(NodeBuilder definition)

Methods inherited from class java.lang.Object

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

Field Detail

ATTR_FACET_FIELDS

public static final java.lang.String ATTR_FACET_FIELDS

IndexPaln Attribute name which refers to the name of the fields that should be used for facets.

See Also:

Constant Field Values

Method Detail

getFacetsConfig

public static org.apache.lucene.facet.FacetsConfig getFacetsConfig(NodeBuilder definition)

getFacetColumnNamesFromPlan

public static java.util.List<java.lang.String> getFacetColumnNamesFromPlan(QueryIndex.IndexPlan plan)

Get the column names of all the facets from the index plan, if any.

Parameters:

plan - the plan

Returns:

a list (possibly empty)

getFacets

public static org.apache.lucene.facet.Facets getFacets(IndexSearcher searcher,
                                                       Query query,
                                                       QueryIndex.IndexPlan plan,
                                                       org.apache.jackrabbit.oak.plugins.index.search.IndexDefinition.SecureFacetConfiguration secureFacetConfiguration)
                                                throws java.io.IOException

Throws:

java.io.IOException