Package com.atlassian.confluence.plugins.index.api.mapping

Interface FieldMapping

All Known Implementing Classes:
AbstractFieldMapping, BinaryFieldMapping, BooleanFieldMapping, ContentPermissionSetFieldMapping, DateFieldMapping, DoubleFieldMapping, FloatFieldMapping, IntFieldMapping, LongFieldMapping, NestedStringFieldMapping, StringFieldMapping, TextFieldMapping
public interface FieldMapping
Defines how an index field is stored and indexed.

  • Method Summary

    Modifier and Type
    Method
    Description
    <R> R
    accept(FieldMappingVisitor<R> visitor)
    Applies the supplied visitor to this field mapping with its respective callback.
    String
    getName()
     
    boolean
    isIndexed()
     
    boolean
    isStored()
     

  • Method Details

    • getName

      String getName()
      Returns:
      name of the field

    • isStored

      boolean isStored()
      Returns:
      true if the original field value is stored, so it can be retrieved.

    • isIndexed

      boolean isIndexed()
      Returns:
      true if the field is indexed, so it can be searched

    • accept

      <R> R accept(FieldMappingVisitor<R> visitor)
      Applies the supplied visitor to this field mapping with its respective callback.
      Parameters:
      visitor - The visitor to dispatch
      Returns:
      The value that is returned by the supplied visitor