org.odpi.openmetadata.adapters.repositoryservices.igc.clientlibrary.search

Class IGCSearchSorting

java.lang.Object

org.odpi.openmetadata.adapters.repositoryservices.igc.clientlibrary.search.IGCSearchSorting

public class IGCSearchSorting
extends Object

Manages the criteria to use for sorting search results from IGC.

Constructor Summary

Constructors

Constructor and Description
IGCSearchSorting(String property) Creates a new search sorting criteria directly, sorting by the provided property in ascending order.
IGCSearchSorting(String property, Boolean ascending) Creates a new search sorting criteria directly.

Method Summary

Modifier and Type	Method and Description
Boolean	getAscending()
String	getProperty()
com.fasterxml.jackson.databind.node.ObjectNode	getSortObject() Returns the JSON object representing the condition.
void	setAscending(Boolean ascending)
void	setProperty(String property)
static IGCSearchSorting	sortFromNonPropertySequencingOrder(SequencingOrder sequencingOrder) Returns an IGCSearchSorting equivalent to the provided SequencingOrder, so long as the provided sequencingOrder is not one of [ PROPERTY_ASCENDING, PROPERTY_DESCENDING ] (because these must be explicitly mapped on a type-by-type basis).

Methods inherited from class java.lang.Object

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

Constructor Detail

IGCSearchSorting

public IGCSearchSorting(String property,
                        Boolean ascending)

Creates a new search sorting criteria directly. For example, the following would sort results by "name" in descending order:

• property: "name"
• ascending: false

Parameters:

property - the property of an asset type to search against

ascending - whether to sort results in ascending order (true) or descending order (false)

IGCSearchSorting

public IGCSearchSorting(String property)

Creates a new search sorting criteria directly, sorting by the provided property in ascending order.

Parameters:

property - the property of an asset type to search against

Method Detail

getProperty

public String getProperty()

setProperty

public void setProperty(String property)

getAscending

public Boolean getAscending()

setAscending

public void setAscending(Boolean ascending)

getSortObject

public com.fasterxml.jackson.databind.node.ObjectNode getSortObject()

Returns the JSON object representing the condition.

Returns:

ObjectNode

sortFromNonPropertySequencingOrder

public static IGCSearchSorting sortFromNonPropertySequencingOrder(SequencingOrder sequencingOrder)

Returns an IGCSearchSorting equivalent to the provided SequencingOrder, so long as the provided sequencingOrder is not one of [ PROPERTY_ASCENDING, PROPERTY_DESCENDING ] (because these must be explicitly mapped on a type-by-type basis).

Parameters:

sequencingOrder - the non-property SequencingOrder to create an IGC sort order from

Returns:

IGCSearchSorting