Package dev.morphia.annotations

Annotation Interface Collation

public @interface Collation
Defines the collation options for an index
Since:
1.3

  • Field Details

  • Element Details

    • backwards

      boolean backwards
      Causes secondary differences to be considered in reverse order, as it is done in the French language
      Returns:
      the backwards value
      Default:
      false

    • caseLevel

      boolean caseLevel
      Turns on case sensitivity
      Returns:
      the case level value
      Default:
      false

    • locale

      String locale
      If this value is empty, no collation will be configured for an index. Any other string passed will be parsed as the name of the localed you wish to use. However, if you want to use the default locale as defined by the JVM, pass the value "<default>" instead.
      Returns:
      the locale
      See Also:
      Default:
      ""

    • normalization

      boolean normalization
      Returns:
      the normalization value. If true, normalizes text into Unicode NFD.
      Default:
      false

    • numericOrdering

      boolean numericOrdering
      Returns:
      the numeric ordering. if true will order numbers based on numerical order and not collation order
      Default:
      false

    • alternate

      CollationAlternate alternate
      Controls whether spaces and punctuation are considered base characters
      Returns:
      the alternate
      Default:
      NON_IGNORABLE

    • caseFirst

      CollationCaseFirst caseFirst
      Determines if Uppercase or lowercase values should come first
      Returns:
      the collation case first value
      Default:
      OFF

    • maxVariable

      CollationMaxVariable maxVariable
      Returns:
      the maxVariable
      Default:
      PUNCT

    • strength

      CollationStrength strength
      Returns:
      the collation strength
      Default:
      TERTIARY