org.apache.lucene.facet

Class MultiFacets

java.lang.Object

org.apache.lucene.facet.Facets

org.apache.lucene.facet.MultiFacets

public class MultiFacets
extends Facets

Maps specified dims to provided Facets impls; else, uses the default Facets impl.

Constructor Summary

Constructors

Constructor and Description
MultiFacets(java.util.Map<java.lang.String,Facets> dimToFacets) Create this, with no default Facets.
MultiFacets(java.util.Map<java.lang.String,Facets> dimToFacets, Facets defaultFacets) Create this, with the specified default Facets for fields not included in dimToFacets.

Method Summary

Modifier and Type	Method and Description
java.util.List<FacetResult>	getAllDims(int topN) Returns topN labels for any dimension that had hits, sorted by the number of hits that dimension matched; this is used for "sparse" faceting, where many different dimensions were indexed, for example depending on the type of document.
java.lang.Number	getSpecificValue(java.lang.String dim, java.lang.String... path) Return the count or value for a specific path.
FacetResult	getTopChildren(int topN, java.lang.String dim, java.lang.String... path) Returns the topN child labels under the specified path.

Methods inherited from class java.lang.Object

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

Constructor Detail

MultiFacets

public MultiFacets(java.util.Map<java.lang.String,Facets> dimToFacets)

Create this, with no default Facets.

MultiFacets

public MultiFacets(java.util.Map<java.lang.String,Facets> dimToFacets,
                   Facets defaultFacets)

Create this, with the specified default Facets for fields not included in dimToFacets.

Method Detail

getTopChildren

public FacetResult getTopChildren(int topN,
                                  java.lang.String dim,
                                  java.lang.String... path)
                           throws java.io.IOException

Description copied from class: Facets

Returns the topN child labels under the specified path. Returns null if the specified path doesn't exist or if this dimension was never seen.

Specified by:

getTopChildren in class Facets

Throws:

java.io.IOException

getSpecificValue

public java.lang.Number getSpecificValue(java.lang.String dim,
                                         java.lang.String... path)
                                  throws java.io.IOException

Description copied from class: Facets

Return the count or value for a specific path. Returns -1 if this path doesn't exist, else the count.

Specified by:

getSpecificValue in class Facets

Throws:

java.io.IOException

getAllDims

public java.util.List<FacetResult> getAllDims(int topN)
                                       throws java.io.IOException

Description copied from class: Facets

Returns topN labels for any dimension that had hits, sorted by the number of hits that dimension matched; this is used for "sparse" faceting, where many different dimensions were indexed, for example depending on the type of document.

Specified by:

getAllDims in class Facets

Throws:

java.io.IOException