+ * If non-default parameters were used during indexing, the same parameters + * must also be passed during faceted search. This requirement is analogous + * to the requirement during search to know which fields were indexed, and which + * Analyzer was used on the text. + * + * @lucene.experimental + */ +public interface FacetIndexingParams extends Serializable { + + /** + * The name of the category-list to put this category in, or null if this + * category should not be aggregatable. + *
+ * By default, all categories are written to the same category list, but + * applications which know in advance that in some situations only parts + * of the category hierarchy needs to be counted can divide the categories + * into two or more different category lists. + *
+ * If null is returned for a category, it means that this category should
+ * not appear in any category list, and thus counts for it cannot be
+ * aggregated. This category can still be used for drill-down, even though
+ * the count for it is not known.
+ */
+ public CategoryListParams getCategoryListParams(CategoryPath category);
+
+ /**
+ * Return info about all category lists in the index.
+ *
+ * @see #getCategoryListParams(CategoryPath)
+ */
+ public Iterable
+ * Note: Make sure buffer is large enough.
+ * @see CategoryPath#charsNeededForFullPath()
+ */
+ public int drillDownTermText(CategoryPath path, char[] buffer);
+
+ /**
+ * Get the partition size.
+ * Same value should be used during the life time of an index.
+ * At search time this value is compared with actual taxonomy size and their minimum is used.
+ */
+ public int getPartitionSize();
+
+ /**
+ * Get the policy for indexing category paths,
+ * used for deciding how "high" to climb in taxonomy
+ * from a category when ingesting its category paths.
+ */
+ public PathPolicy getPathPolicy();
+
+ /**
+ * Get the policy for indexing category ordinals,
+ * used for deciding how "high" to climb in taxonomy
+ * from a category when ingesting its ordinals
+ */
+ public OrdinalPolicy getOrdinalPolicy();
+
+ /**
+ * Get the delimiter character used internally for drill-down terms
+ */
+ public char getFacetDelimChar();
+}