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

Class StringFieldMapping.Builder

java.lang.Object
com.atlassian.confluence.plugins.index.api.mapping.AbstractFieldMapping.Builder
com.atlassian.confluence.plugins.index.api.mapping.StringFieldMapping.Builder
Enclosing class:
StringFieldMapping
public static class StringFieldMapping.Builder extends AbstractFieldMapping.Builder

  • Constructor Details

    • Builder

      public Builder(String name)

  • Method Details

    • store

      public StringFieldMapping.Builder store(boolean stored)
      Overrides:
      store in class AbstractFieldMapping.Builder
      Parameters:
      stored - If true, the field will store the original value so that it can be retrieved. Default = false, i.e. the field can only be searched.
      Returns:
      this builder

    • index

      public StringFieldMapping.Builder index(boolean indexed)
      Overrides:
      index in class AbstractFieldMapping.Builder
      Parameters:
      indexed - If true (default), the field will be indexed so that it can be searched
      Returns:
      this builder

    • asLowercase

      public StringFieldMapping.Builder asLowercase(boolean asLowercase)
      Set whether this field is a lowercase

      This will only be used when search engine is OpenSearch OpenSearch will use the field as it is when perform LowercaseFieldSort

      Parameters:
      asLowercase - whether this field is a lowercase
      Returns:
      Builder
      Since:
      8.8

    • withLowercase

      public StringFieldMapping.Builder withLowercase(boolean withLowercase)
      Set whether to support a lowercase version of the field

      This will only be used when search engine is OpenSearch OpenSearch will create a lowercase sub field for this field if this is true OpenSearch will use the subfield when perform LowercaseFieldSort

      Parameters:
      withLowercase - Whether to support a lowercase version of the field
      Returns:
      Builder
      Since:
      8.8

    • build

      public StringFieldMapping build()
      Specified by:
      build in class AbstractFieldMapping.Builder
      Returns:
      a newly created mapping