com.endeca.infront.navigation.model
Class SortSpec

java.lang.Object
  com.endeca.infront.navigation.model.SortSpec

Direct Known Subclasses:

GeoSortSpec, StratifySortSpec

public class SortSpec
extends Object

A way of sorting a list of search/navigation results.

Constructor Summary

SortSpec()

Method Summary

boolean	equals(Object obj)
String	getKey() The name of the sort attribute or interface.
String	getSortOptionValue() retrieved key is followed by a suffix of "|1", indicating descending order, or "|0", indicating ascending order (the default)
int	hashCode()
boolean	isDescending() The sort direction.
void	setDescending(boolean descending)
void	setKey(String key)

Methods inherited from class java.lang.Object

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

Constructor Detail

SortSpec

public SortSpec()

Method Detail

getKey

public String getKey()

The name of the sort attribute or interface.

setKey

public void setKey(String key)

Parameters:

key - the name of the sort attribute or interface, cannot be null

isDescending

public boolean isDescending()

The sort direction. Default is false (ascending order).

setDescending

public void setDescending(boolean descending)

equals

public boolean equals(Object obj)

Overrides:

equals in class Object

hashCode

public int hashCode()

Overrides:

hashCode in class Object

getSortOptionValue

public String getSortOptionValue()

retrieved key is followed by a suffix of "|1", indicating descending order, or "|0", indicating ascending order (the default)

Returns:

sort value