Interface IndexDescriptor

All Known Subinterfaces:
All Known Implementing Classes:

public interface IndexDescriptor
A descriptor of an index, exposing in particular the available fields and their characteristics.
  • Method Details

    • hibernateSearchName

      String hibernateSearchName()
      The name that uniquely identifies this index within the backend. This is the Hibernate Search name; the name of the index on the filesystem or in Elasticsearch may be different (lowercased, with a suffix, ...). See the reference documentation of your backend for more information.
    • root

      A descriptor of the root element of this index.
    • field

      Optional<IndexFieldDescriptor> field(String absolutePath)
      Get a field by its path.

      This method can find static fields as well as dynamic fields, unlike staticFields().

      absolutePath - An absolute, dot-separated path.
      The corresponding field, or Optional.empty() if no field exists with this path.
    • staticFields

      Get all statically-defined fields for this index.

      Only statically-defined fields are returned; fields created dynamically through templates are not included in the collection.

      A collection containing all fields.