Package com.atlassian.confluence.search.v2.sort

Class LowercaseFieldSort

java.lang.Object

com.atlassian.confluence.search.v2.sort.LowercaseFieldSort

All Implemented Interfaces:

Expandable<SearchSort>, SearchSort

@SearchPrimitive
public class LowercaseFieldSort
extends Object
implements SearchSort

Sort based on lower case value of a keyword field.

Since:

7.0

Nested Class Summary

Nested classes/interfaces inherited from interface com.atlassian.confluence.search.v2.SearchSort

SearchSort.Order, SearchSort.Type

Field Summary

Fields

Modifier and Type	Field	Description
static final String	KEY

Constructor Summary

Constructors

Constructor	Description
LowercaseFieldSort(StringFieldMapping fieldMapping, SearchSort.Order order)
LowercaseFieldSort(String fieldName, SearchSort.Order order)	Deprecated, for removal: This API element is subject to removal in a future version. since 8.9.

Method Summary

Modifier and Type	Method	Description
Optional<StringFieldMapping>	getFieldMapping()
String	getFieldName()
String	getKey()	Gets the key that uniquely identifies this sort method.
SearchSort.Order	getOrder()	Returns the order (whether SearchSort.Order.ASCENDING or SearchSort.Order.DESCENDING) of the sort.
SearchSort.Type	getType()

Methods inherited from class java.lang.Object

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

Methods inherited from interface com.atlassian.confluence.search.v2.SearchSort

expand

Field Details

KEY

public static final String KEY

See Also:

• Constant Field Values

Constructor Details

LowercaseFieldSort

@Deprecated(forRemoval=true)
public LowercaseFieldSort(String fieldName,
 SearchSort.Order order)

Deprecated, for removal: This API element is subject to removal in a future version.

since 8.9. Use LowercaseFieldSort(StringFieldMapping, Order) instead. On OpenSearch, this will result in a script-sort, which is inefficient.

LowercaseFieldSort

public LowercaseFieldSort(StringFieldMapping fieldMapping,
 SearchSort.Order order)

Method Details

getKey

public String getKey()

Description copied from interface: SearchSort

Gets the key that uniquely identifies this sort method.

Specified by:

getKey in interface SearchSort

Returns:

the sort key

getOrder

public SearchSort.Order getOrder()

Description copied from interface: SearchSort

Returns the order (whether SearchSort.Order.ASCENDING or SearchSort.Order.DESCENDING) of the sort.

Specified by:

getOrder in interface SearchSort

Returns:

the order (whether SearchSort.Order.ASCENDING or SearchSort.Order.DESCENDING) of the sort.

getType

public SearchSort.Type getType()

getFieldName

public String getFieldName()

getFieldMapping

public Optional<StringFieldMapping> getFieldMapping()