org.springframework.data.mongodb.core.query

Interface Collation.ComparisonLevel

All Known Implementing Classes:

Collation.PrimaryICUComparisonLevel, Collation.SecondaryICUComparisonLevel, Collation.TertiaryICUComparisonLevel

Enclosing class:

Collation

public static interface Collation.ComparisonLevel

Abstraction for the ICU Comparison Levels.

Since:

2.0

Method Summary

Modifier and Type	Method and Description
default Optional<Collation.CaseFirst>	getCaseFirst()
default Optional<Boolean>	getCaseLevel()
int	getLevel()
static Collation.ComparisonLevel	identical() Identical Level.
static Collation.PrimaryICUComparisonLevel	primary() Primary level of comparison.
static Collation.ComparisonLevel	quaternary() Quaternary Level.
static Collation.SecondaryICUComparisonLevel	secondary() Secondary level of comparison.
static Collation.TertiaryICUComparisonLevel	tertiary() Tertiary level of comparison.

Method Detail

primary

static Collation.PrimaryICUComparisonLevel primary()

Primary level of comparison. Collation performs comparisons of the base characters only, ignoring other differences such as diacritics and case.
The caseLevel can be set via Collation.PrimaryICUComparisonLevel.includeCase() and Collation.PrimaryICUComparisonLevel.excludeCase().

Returns:

new Collation.SecondaryICUComparisonLevel.

secondary

static Collation.SecondaryICUComparisonLevel secondary()

Secondary level of comparison. Collation performs comparisons up to secondary differences, such as diacritics.
The caseLevel can be set via Collation.SecondaryICUComparisonLevel.includeCase() and Collation.SecondaryICUComparisonLevel.excludeCase().

Returns:

new Collation.SecondaryICUComparisonLevel.

tertiary

static Collation.TertiaryICUComparisonLevel tertiary()

Tertiary level of comparison. Collation performs comparisons up to tertiary differences, such as case and letter variants.
The caseLevel cannot be set for ICUComparisonLevel above secondary.

Returns:

new ICUComparisonLevel.

quaternary

static Collation.ComparisonLevel quaternary()

Quaternary Level. Limited for specific use case to consider punctuation.
The caseLevel cannot be set for ICUComparisonLevel above secondary.

Returns:

new Collation.ComparisonLevel.

identical

static Collation.ComparisonLevel identical()

Identical Level. Limited for specific use case of tie breaker.
The caseLevel cannot be set for ICUComparisonLevel above secondary.

Returns:

new Collation.ComparisonLevel.

getLevel

int getLevel()

Returns:

collation strength, 1 for primary, 2 for secondary and so on.

getCaseFirst

default Optional<Collation.CaseFirst> getCaseFirst()

getCaseLevel

default Optional<Boolean> getCaseLevel()