org.apache.lucene.facet.index.categorypolicy
Interface PathPolicy
- All Superinterfaces:
- Serializable
- All Known Implementing Classes:
- NonTopLevelPathPolicy
public interface PathPolicy
- extends Serializable
Determines which categories
should be added as terms to
the DrillDownStream
. The default approach is implemented by
ALL_CATEGORIES
.
- WARNING: This API is experimental and might change in incompatible ways in the next release.
Method Summary |
boolean |
shouldAdd(CategoryPath categoryPath)
Check whether a given category path should be added to the stream. |
ALL_CATEGORIES
static final PathPolicy ALL_CATEGORIES
- A
PathPolicy
which adds all CategoryPath
that have at least
one component (i.e. CategoryPath.length
> 0) to the categories
stream.
shouldAdd
boolean shouldAdd(CategoryPath categoryPath)
- Check whether a given category path should be added to the stream.
- Parameters:
categoryPath
- A given category path which is to be tested for stream
addition.
- Returns:
true
if the category path should be added.
false
otherwise.
Copyright © 2000-2013 Apache Software Foundation. All Rights Reserved.