Package ubic.gemma.persistence.util

Class Sort

java.lang.Object

ubic.gemma.persistence.util.Sort

All Implemented Interfaces:

PropertyMapping

public final class Sort
extends Object
implements PropertyMapping

Represents a directed sort by a property.

Nested Class Summary

Nested Classes

Modifier and Type	Class	Description
static enum	Sort.Direction	Direction of the sort.
static enum	Sort.NullMode

Method Summary

Modifier and Type	Method	Description
Sort	andThen(Sort andThen)	Add a next sort.
static Sort	by(String alias, String propertyName, Sort.Direction direction, Sort.NullMode nullMode)	Create a sort without an original property.
static Sort	by(String alias, String propertyName, Sort.Direction direction, Sort.NullMode nullMode, String originalProperty)	Create a Sort for a given alias, property and direction.
boolean	equals(Object o)
Sort	getAndThen()
Sort.Direction	getDirection()
Sort.NullMode	getNullMode()	Indicate if null values should appear last when sorting.
String	getObjectAlias()	Alias in the query/criteria space, if applicable.
String	getOriginalProperty()	Indicate the original property from which this sort originates.
String	getPropertyName()	Property name in the query/criteria space.
int	hashCode()
String	toOriginalString()	Render this with its original property.
String	toString()	Render this with its PropertyMapping.getObjectAlias() and PropertyMapping.getPropertyName().

Methods inherited from class java.lang.Object

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

Method Details

by

public static Sort by(@Nullable
 String alias,
 String propertyName,
 @Nullable
 Sort.Direction direction,
 Sort.NullMode nullMode,
 String originalProperty)

Create a Sort for a given alias, property and direction.

Parameters:

alias - an alias in the query, or null to refer to the root entity (not recommended though, since this could result in an ambiguous query)

propertyName - a property of objectAlias to order by

direction - a direction, or null for default

originalProperty - an original property name for rendering via toOriginalString()

by

public static Sort by(@Nullable
 String alias,
 String propertyName,
 @Nullable
 Sort.Direction direction,
 Sort.NullMode nullMode)

Create a sort without an original property.

See Also:

• by(String, String, Direction, NullMode)

andThen

public Sort andThen(Sort andThen)

Add a next sort.

toString

public String toString()

Description copied from interface: PropertyMapping

Render this with its PropertyMapping.getObjectAlias() and PropertyMapping.getPropertyName().

Specified by:

toString in interface PropertyMapping

Overrides:

toString in class Object

toOriginalString

public String toOriginalString()

Description copied from interface: PropertyMapping

Render this with its original property.

If no original property are attached to this mapping, this method should return the same as PropertyMapping.toString().

Specified by:

toOriginalString in interface PropertyMapping

getObjectAlias

@Nullable
public String getObjectAlias()

Description copied from interface: PropertyMapping

Alias in the query/criteria space, if applicable.

Null implies a reference to the root alias.

Specified by:

getObjectAlias in interface PropertyMapping

getPropertyName

public String getPropertyName()

Description copied from interface: PropertyMapping

Property name in the query/criteria space.

Specified by:

getPropertyName in interface PropertyMapping

getDirection

@Nullable
public Sort.Direction getDirection()

getNullMode

public Sort.NullMode getNullMode()

Indicate if null values should appear last when sorting.

getOriginalProperty

@Nullable
public String getOriginalProperty()

Indicate the original property from which this sort originates.

Specified by:

getOriginalProperty in interface PropertyMapping

getAndThen

@Nullable
public Sort getAndThen()

equals

public boolean equals(Object o)

Overrides:

equals in class Object

hashCode

public int hashCode()

Overrides:

hashCode in class Object