com.sap.cloud.server.odata

Class SortItem

java.lang.Object

com.sap.cloud.server.odata.SortItem

public class SortItem
extends java.lang.Object

Encapsulates an OData sort item. A sort item indicates a property (or expression) that is used in the $orderby system query option.

See Also:

DataQuery.sortItems, DataQuery.orderBy, DataQuery.thenBy.

Constructor Summary

Constructors

Constructor and Description
SortItem()

Method Summary

Modifier and Type	Method and Description
SortOrder	getOrder() Return sort order, which defaults to SortOrder.ascending.
DataPath	getPath() Return (nullable) Obsolete.
QueryValue	getValue() Return an expression that, when evaluated, will be used for query result ordering.
static SortItem	of(QueryValue value) Return a new sort item for the specified value.
void	setOrder(SortOrder value) Set sort order, which defaults to SortOrder.ascending.
void	setValue(QueryValue value) Set an expression that, when evaluated, will be used for query result ordering.
Property	toProperty() If this sort item directly references a property, then return the property.
Property	toRequiredProperty() If this sort item references a simple property path, then return the property.
java.lang.String	toString() Return a string representation of this sort item.

Methods inherited from class java.lang.Object

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

Constructor Detail

SortItem

public SortItem()

Method Detail

getOrder

public SortOrder getOrder()

Return sort order, which defaults to SortOrder.ascending.

See Also:

DataQuery.orderBy.

Returns:

Sort order, which defaults to SortOrder.ascending.

getPath

public DataPath getPath()

Return (nullable) Obsolete. Use SortItem.value.

Returns:

(nullable) Obsolete. Use SortItem.value.

getValue

public QueryValue getValue()

Return an expression that, when evaluated, will be used for query result ordering.

Returns:

An expression that, when evaluated, will be used for query result ordering.

of

public static SortItem of(QueryValue value)

Return a new sort item for the specified value.

Parameters:

value - Value for result ordering.

Returns:

A new sort item for the specified value.

setOrder

public void setOrder(SortOrder value)

Set sort order, which defaults to SortOrder.ascending.

See Also:

DataQuery.orderBy.

Parameters:

value - Sort order, which defaults to SortOrder.ascending.

setValue

public void setValue(QueryValue value)

Set an expression that, when evaluated, will be used for query result ordering.

Parameters:

value - An expression that, when evaluated, will be used for query result ordering.

toProperty

public Property toProperty()

If this sort item directly references a property, then return the property. Otherwise return null.

Returns:

(nullable) The property to be selected, or null.

toRequiredProperty

public Property toRequiredProperty()

If this sort item references a simple property path, then return the property. Otherwise throw an exception.

Throws:

UndefinedException if this sort item does not reference a simple property path.

Returns:

The property to be selected.

toString

public java.lang.String toString()

Return a string representation of this sort item.

Overrides:

toString in class java.lang.Object

Returns:

A string representation of this sort item.