org.hibernate.search.engine.metadata.impl

## Class FacetMetadata

- java.lang.Object
- - org.hibernate.search.engine.metadata.impl.FacetMetadata

-     public class FacetMetadata
      extends Object

  Encapsulating the metadata for a facet on a given document field.
  Author:
    Hardy Ferentschik

- - ### Nested Class Summary

    Nested Classes
    Modifier and Type | Class and Description
    --- | ---
    `static class` | `FacetMetadata.Builder`

  - ### Method Summary

    All Methods Instance Methods Concrete Methods
    Modifier and Type | Method and Description
    --- | ---
    `String` | `getAbsoluteName()`
    `FacetEncodingType` | `getEncoding()`
    `DocumentFieldPath` | `getPath()`
    `DocumentFieldMetadata` | `getSourceField()`
    `boolean` | `isEncodingAuto()`
    `String` | `toString()`

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

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

- - ### Method Detail

    - #### getSourceField

          public DocumentFieldMetadata getSourceField()

      Returns:
        The `DocumentFieldMetadata` to which the facet applies.

    - #### getAbsoluteName

          public String getAbsoluteName()

      Returns:
        The full name of the facet field, including any indexed-embedded prefix. Equivalent to `#getPath().getAbsoluteName()`.

    - #### getPath

          public DocumentFieldPath getPath()

      Returns:
        The path from the document root to this field.

    - #### isEncodingAuto

          public boolean isEncodingAuto()

    - #### getEncoding

          public FacetEncodingType getEncoding()

    - #### toString

          public String toString()

      Overrides:
        `toString` in class `Object`

Copyright © 2006-2017 Red Hat, Inc. All Rights Reserved