Class DefaultEnhancementsIndexingParams
- java.lang.Object
-
- org.apache.lucene.facet.index.params.DefaultFacetIndexingParams
-
- org.apache.lucene.facet.index.params.PerDimensionIndexingParams
-
- org.apache.lucene.facet.enhancements.params.DefaultEnhancementsIndexingParams
-
- All Implemented Interfaces:
Serializable
,EnhancementsIndexingParams
,FacetIndexingParams
public class DefaultEnhancementsIndexingParams extends PerDimensionIndexingParams implements EnhancementsIndexingParams
Default implementation ofEnhancementsIndexingParams
- See Also:
- Serialized Form
- WARNING: This API is experimental and might change in incompatible ways in the next release.
-
-
Field Summary
-
Fields inherited from class org.apache.lucene.facet.index.params.DefaultFacetIndexingParams
DEFAULT_FACET_DELIM_CHAR
-
-
Constructor Summary
Constructors Constructor Description DefaultEnhancementsIndexingParams(CategoryEnhancement... enhancements)
Construct with a certainenhancement
DefaultEnhancementsIndexingParams(CategoryListParams categoryListParams, CategoryEnhancement... enhancements)
Construct with certainenhancements
andCategoryListParams
-
Method Summary
All Methods Instance Methods Concrete Methods Modifier and Type Method Description void
addCategoryEnhancements(CategoryEnhancement... enhancements)
AddCategoryEnhancement
s to the indexing parametersList<CategoryEnhancement>
getCategoryEnhancements()
Get a list of the active category enhancements.List<Class<? extends CategoryProperty>>
getRetainableProperties()
Get a list ofCategoryProperty
classes to be retained when creatingCategoryParentsStream
.-
Methods inherited from class org.apache.lucene.facet.index.params.PerDimensionIndexingParams
addCategoryListParams, getAllCategoryListParams, getCategoryListParams
-
Methods inherited from class org.apache.lucene.facet.index.params.DefaultFacetIndexingParams
drillDownTermText, equals, fixedOrdinalPolicy, fixedPartitionSize, fixedPathPolicy, getFacetDelimChar, getOrdinalPolicy, getPartitionSize, getPathPolicy, hashCode
-
Methods inherited from class java.lang.Object
clone, finalize, getClass, notify, notifyAll, toString, wait, wait, wait
-
Methods inherited from interface org.apache.lucene.facet.index.params.FacetIndexingParams
drillDownTermText, getAllCategoryListParams, getCategoryListParams, getFacetDelimChar, getOrdinalPolicy, getPartitionSize, getPathPolicy
-
-
-
-
Constructor Detail
-
DefaultEnhancementsIndexingParams
public DefaultEnhancementsIndexingParams(CategoryEnhancement... enhancements)
Construct with a certainenhancement
- Throws:
IllegalArgumentException
- if no enhancements are provided
-
DefaultEnhancementsIndexingParams
public DefaultEnhancementsIndexingParams(CategoryListParams categoryListParams, CategoryEnhancement... enhancements)
Construct with certainenhancements
andCategoryListParams
- Throws:
IllegalArgumentException
- if no enhancements are provided
-
-
Method Detail
-
addCategoryEnhancements
public void addCategoryEnhancements(CategoryEnhancement... enhancements)
Description copied from interface:EnhancementsIndexingParams
AddCategoryEnhancement
s to the indexing parameters- Specified by:
addCategoryEnhancements
in interfaceEnhancementsIndexingParams
- Parameters:
enhancements
- enhancements to add
-
getCategoryEnhancements
public List<CategoryEnhancement> getCategoryEnhancements()
Description copied from interface:EnhancementsIndexingParams
Get a list of the active category enhancements. If no enhancements exist returnnull
. The order of enhancements in the returned list dictates the order in which the enhancements data appear in the category tokens payload.- Specified by:
getCategoryEnhancements
in interfaceEnhancementsIndexingParams
- Returns:
- A list of the active category enhancements, or
null
if there are no enhancements.
-
getRetainableProperties
public List<Class<? extends CategoryProperty>> getRetainableProperties()
Description copied from interface:EnhancementsIndexingParams
Get a list ofCategoryProperty
classes to be retained when creatingCategoryParentsStream
.- Specified by:
getRetainableProperties
in interfaceEnhancementsIndexingParams
- Returns:
- the list of
CategoryProperty
classes to be retained when creatingCategoryParentsStream
, ornull
if there are no such properties.
-
-