Package 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.
-
-
Method Summary
All Methods Instance Methods Concrete Methods Modifier and Type Method Description FacetResultgetAllChildren(String dim, String... path)Returns all child labels with non-zero counts under the specified path.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.NumbergetSpecificValue(String dim, String... path)Return the count or value for a specific path.FacetResultgetTopChildren(int topN, String dim, String... path)Returns the topN child labels under the specified path.-
Methods inherited from class org.apache.lucene.facet.Facets
getTopDims, validateTopN
-
-
-
-
Method Detail
-
getAllChildren
public FacetResult getAllChildren(String dim, String... path) throws IOException
Description copied from class:FacetsReturns all child labels with non-zero counts under the specified path. Users should make no assumptions about ordering of the children. Returns null if the specified path doesn't exist or if this dimension was never seen.- Specified by:
getAllChildrenin classFacets- Throws:
IOException
-
getTopChildren
public FacetResult getTopChildren(int topN, String dim, String... path) throws IOException
Description copied from class:FacetsReturns 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:
getTopChildrenin classFacets- Throws:
IOException
-
getSpecificValue
public Number getSpecificValue(String dim, String... path) throws IOException
Description copied from class:FacetsReturn the count or value for a specific path. Returns -1 if this path doesn't exist, else the count.- Specified by:
getSpecificValuein classFacets- Throws:
IOException
-
getAllDims
public List<FacetResult> getAllDims(int topN) throws IOException
Description copied from class:FacetsReturns 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:
getAllDimsin classFacets- Throws:
IOException
-
-