public class FacetsConfig extends Object
NOTE: this configuration is not saved into the
index, but it's vital, and up to the application to
ensure, that at search time the provided FacetsConfig
matches what was used during indexing.
Modifier and Type | Class and Description |
---|---|
static class |
FacetsConfig.DimConfig
Holds the configuration for one dimension
|
Modifier and Type | Field and Description |
---|---|
static FacetsConfig.DimConfig |
DEFAULT_DIM_CONFIG
Default per-dimension configuration.
|
static String |
DEFAULT_INDEX_FIELD_NAME
Which Lucene field holds the drill-downs and ords (as
doc values).
|
Constructor and Description |
---|
FacetsConfig()
Default constructor.
|
Modifier and Type | Method and Description |
---|---|
Document |
build(Document doc)
Translates any added
FacetField s into normal fields for indexing;
only use this version if you did not add any taxonomy-based fields (
FacetField or AssociationFacetField ). |
Document |
build(TaxonomyWriter taxoWriter,
Document doc)
Translates any added
FacetField s into normal fields for indexing. |
FacetsConfig.DimConfig |
getDimConfig(String dimName)
Get the current configuration for a dimension.
|
Map<String,FacetsConfig.DimConfig> |
getDimConfigs()
Returns map of field name to
FacetsConfig.DimConfig . |
static String |
pathToString(String[] path)
Turns a dim + path into an encoded string.
|
static String |
pathToString(String[] path,
int length)
Turns the first
length elements of path into an encoded string. |
static String |
pathToString(String dim,
String[] path)
Turns a dim + path into an encoded string.
|
void |
setHierarchical(String dimName,
boolean v)
Pass
true if this dimension is hierarchical
(has depth > 1 paths). |
void |
setIndexFieldName(String dimName,
String indexFieldName)
Specify which index field name should hold the
ordinals for this dimension; this is only used by the
taxonomy based facet methods.
|
void |
setMultiValued(String dimName,
boolean v)
Pass
true if this dimension may have more than
one value per document. |
void |
setRequireDimCount(String dimName,
boolean v)
Pass
true if at search time you require
accurate counts of the dimension, i.e. |
static String[] |
stringToPath(String s)
Turns an encoded string (from a previous call to
pathToString(java.lang.String, java.lang.String[]) ) back into the original String[] . |
public static final String DEFAULT_INDEX_FIELD_NAME
public static final FacetsConfig.DimConfig DEFAULT_DIM_CONFIG
public FacetsConfig.DimConfig getDimConfig(String dimName)
public void setHierarchical(String dimName, boolean v)
true
if this dimension is hierarchical
(has depth > 1 paths).public void setMultiValued(String dimName, boolean v)
true
if this dimension may have more than
one value per document.public void setRequireDimCount(String dimName, boolean v)
true
if at search time you require
accurate counts of the dimension, i.e. how many
hits have this dimension.public void setIndexFieldName(String dimName, String indexFieldName)
public Map<String,FacetsConfig.DimConfig> getDimConfigs()
FacetsConfig.DimConfig
.public Document build(Document doc) throws IOException
FacetField
s into normal fields for indexing;
only use this version if you did not add any taxonomy-based fields (
FacetField
or AssociationFacetField
).
NOTE: you should add the returned document to IndexWriter, not the input one!
IOException
public Document build(TaxonomyWriter taxoWriter, Document doc) throws IOException
FacetField
s into normal fields for indexing.
NOTE: you should add the returned document to IndexWriter, not the input one!
IOException
public static String pathToString(String dim, String[] path)
public static String pathToString(String[] path)
public static String pathToString(String[] path, int length)
length
elements of path
into an encoded string.public static String[] stringToPath(String s)
pathToString(java.lang.String, java.lang.String[])
) back into the original String[]
.Copyright © 2010 - 2020 Adobe. All Rights Reserved