Package de.digitalcollections.model.paging

Class Order

java.lang.Object

de.digitalcollections.model.paging.Order

public class Order
extends Object

PropertyPath implements the pairing of an Direction and a property. It is used to provide input for Sorting. See Spring Data Commons, but more flat design and independent of Spring libraries.

Constructor Summary

Constructors

Constructor	Description
Order()
Order(Direction direction, boolean ignoreCase, NullHandling nullHandling, String property)
Order(Direction direction, String property)	Creates a new Order instance. if order is null then order defaults to Sorting.DEFAULT_DIRECTION
Order(Direction direction, String property, NullHandling nullHandlingHint)	Creates a new Order instance. if order is null then order defaults to Sorting.DEFAULT_DIRECTION
Order(String property)	Creates a new Order instance.

Method Summary

Modifier and Type	Method	Description
static OrderBuilder	defaultBuilder()
boolean	equals(Object obj)
Direction	getDirection()	Returns the order the property shall be sorted for.
NullHandling	getNullHandling()	Returns the used NullHandling hint, which can but may not be respected by the used datastore.
String	getProperty()	Returns the property to order for.
Optional<String>	getSubProperty()	Returns the optional sub property to order for.
int	hashCode()
Order	ignoreCase()	Returns a new Order with case insensitive sorting enabled.
boolean	isAscending()	Returns whether sorting for this property shall be ascending.
boolean	isDescending()	Returns whether sorting for this property shall be descending.
boolean	isIgnoreCase()	Returns whether or not the sort will be case sensitive.
Order	nullsFirst()	Returns a Order with NullHandling.NULLS_FIRST as null handling hint.
Order	nullsLast()	Returns a Order with NullHandling.NULLS_LAST as null handling hint.
Order	nullsNative()	Returns a Order with NullHandling.NATIVE as null handling hint.
void	setDirection(Direction direction)
void	setIgnoreCase(boolean ignoreCase)
void	setNullHandling(NullHandling nullHandling)
void	setProperty(String property)
void	setSubProperty(String property)
String	toString()
Order	with(Direction direction)	Returns a new Order with the given Direction.
Order	with(NullHandling nullHandling)	Returns a Order with the given NullHandling.
Sorting	withProperties(String... properties)	Returns a new Sorting instance for the given properties.
Order	withProperty(String property)	Returns a new Order

Methods inherited from class java.lang.Object

clone, finalize, getClass, notify, notifyAll, wait, wait, wait

Constructor Detail

Order

public Order()

Order

public Order(Direction direction,
             boolean ignoreCase,
             NullHandling nullHandling,
             String property)

Order

public Order(Direction direction,
             String property)

Creates a new Order instance. if order is null then order defaults to Sorting.DEFAULT_DIRECTION

Parameters:

direction - can be null, will default to Sorting.DEFAULT_DIRECTION

property - must not be null or empty.

Order

public Order(Direction direction,
             String property,
             NullHandling nullHandlingHint)

Creates a new Order instance. if order is null then order defaults to Sorting.DEFAULT_DIRECTION

Parameters:

direction - can be null, will default to Sorting.DEFAULT_DIRECTION

property - must not be null or empty.

nullHandlingHint - can be null, will default to NullHandling.NATIVE.

Order

public Order(String property)

Creates a new Order instance. Takes a single property. Direction defaults to Sorting.DEFAULT_DIRECTION.

Parameters:

property - must not be null or empty.

Method Detail

defaultBuilder

public static OrderBuilder defaultBuilder()

equals

public boolean equals(Object obj)

Overrides:

equals in class Object

getDirection

public Direction getDirection()

Returns the order the property shall be sorted for.

Returns:

the order the property shall be sorted for

getNullHandling

public NullHandling getNullHandling()

Returns the used NullHandling hint, which can but may not be respected by the used datastore.

Returns:

the used NullHandling hint, which can but may not be respected by the used datastore.

getProperty

public String getProperty()

Returns the property to order for.

Returns:

the property to order for

getSubProperty

public Optional<String> getSubProperty()

Returns the optional sub property to order for.

A sub property is always related to the main property.

Returns:

the optional sub property to order for

hashCode

public int hashCode()

Overrides:

hashCode in class Object

ignoreCase

public Order ignoreCase()

Returns a new Order with case insensitive sorting enabled.

Returns:

a new Order with case insensitive sorting enabled

isAscending

public boolean isAscending()

Returns whether sorting for this property shall be ascending.

Returns:

whether sorting for this property shall be ascending

isDescending

public boolean isDescending()

Returns whether sorting for this property shall be descending.

Returns:

whether sorting for this property shall be descending

isIgnoreCase

public boolean isIgnoreCase()

Returns whether or not the sort will be case sensitive.

Returns:

whether or not the sort will be case sensitive

nullsFirst

public Order nullsFirst()

Returns a Order with NullHandling.NULLS_FIRST as null handling hint.

Returns:

an Order with NullHandling#NULLS_FIRST as null handling hint

nullsLast

public Order nullsLast()

Returns a Order with NullHandling.NULLS_LAST as null handling hint.

Returns:

an Order with NullHandling#NULLS_LAST as null handling hint.

nullsNative

public Order nullsNative()

Returns a Order with NullHandling.NATIVE as null handling hint.

Returns:

an Order with NullHandling#NATIVE as null handling hint.

setDirection

public void setDirection(Direction direction)

setIgnoreCase

public void setIgnoreCase(boolean ignoreCase)

setNullHandling

public void setNullHandling(NullHandling nullHandling)

setProperty

public void setProperty(String property)

setSubProperty

public void setSubProperty(String property)

toString

public String toString()

Overrides:

toString in class Object

with

public Order with(Direction direction)

Returns a new Order with the given Direction.

Parameters:

direction - given direction

Returns:

a new Order with the given Direction

with

public Order with(NullHandling nullHandling)

Returns a Order with the given NullHandling.

Parameters:

nullHandling - can be null.

Returns:

an Order with the given NullHandling

withProperties

public Sorting withProperties(String... properties)

Returns a new Sorting instance for the given properties.

Parameters:

properties - given properties

Returns:

a new Sorting for the given properties

withProperty

public Order withProperty(String property)

Returns a new Order

Parameters:

property - must not be null or empty.

Returns:

a new Order