AssociationFacetField (Lucene 10.5.0 facet API)
Description: declaration: package: org.apache.lucene.facet.taxonomy, class: AssociationFacetField

Package org.apache.lucene.facet.taxonomy

# Class AssociationFacetField

java.lang.Object
org.apache.lucene.document.Field
org.apache.lucene.facet.taxonomy.AssociationFacetField

All Implemented Interfaces:
  `IndexableField`

Direct Known Subclasses:
  `FloatAssociationFacetField`, `IntAssociationFacetField`

public class AssociationFacetField extends Field
Add an instance of this to your `Document` to add a facet label associated with an arbitrary byte[]. This will require a custom `Facets` implementation at search time; see `IntAssociationFacetField` and `FloatAssociationFacetField` to use existing `Facets` implementations.

WARNING: This API is experimental and might change in incompatible ways in the next release.

- ## Nested Class Summary

  ## Nested classes/interfaces inherited from class org.apache.lucene.document.Field

  `Field.Store`

- ## Field Summary

  Fields
  Modifier and Type
  Field
  Description
  `final BytesRef`
  `assoc`
  Associated value.
  `final String`
  `dim`
  Dimension for this field.
  `final String[]`
  `path`
  Facet path for this field.
  `static final FieldType`
  `TYPE`
  Indexed `FieldType`.

  ### Fields inherited from class org.apache.lucene.document.Field

  `fieldsData, name, type`

- ## Constructor Summary

  Constructors
  Constructor
  Description
  `AssociationFacetField(BytesRef assoc, String dim, String... path)`
  Creates this from `dim` and `path` and an association

- ## Method Summary

  Modifier and Type
  Method
  Description
  `String`
  `toString()`

  ### Methods inherited from class org.apache.lucene.document.Field

  `binaryValue, fieldType, getCharSequenceValue, invertableType, name, numericValue, readerValue, setBytesValue, setBytesValue, setByteValue, setDoubleValue, setFloatValue, setIntValue, setLongValue, setReaderValue, setShortValue, setStringValue, setTokenStream, storedValue, stringValue, tokenStream, tokenStreamValue`

  ### Methods inherited from class java.lang.Object

  `clone, equals, finalize, getClass, hashCode, notify, notifyAll, wait, wait, wait`

- ## Field Details

  - ### TYPE

    public static final FieldType TYPE
    Indexed `FieldType`.

  - ### dim

    public final String dim
    Dimension for this field.

  - ### path

    public final String[] path
    Facet path for this field.

  - ### assoc

    public final BytesRef assoc
    Associated value.

- ## Constructor Details

  - ### AssociationFacetField

    public AssociationFacetField(BytesRef assoc, String dim, String... path)
    Creates this from `dim` and `path` and an association

- ## Method Details

  - ### toString

    public String toString()
    Overrides:
      `toString` in class `Field`