com.attivio.sdk.search

Class Sort

java.lang.Object

com.attivio.sdk.search.Sort

All Implemented Interfaces:

Serializable, Cloneable

public class Sort
extends Object
implements Cloneable, Serializable

Sort specifier

See Also:

Serialized Form

Nested Class Summary

Nested Classes

Modifier and Type	Class and Description
static class	Sort.NullSortOrder Sort order for NULL values.
static class	Sort.SortOrder Contains the possible sort order values

Field Summary

Fields

Modifier and Type	Field and Description
static Sort.SortOrder	ASC Ascending Sort Order.
static Sort.SortOrder	DEFAULT_ORDER Default Sort Order.
static Sort.SortOrder	DESC Descending Sort Order.
protected FieldExpression	field The field being sorted on.
protected Sort.NullSortOrder	nullOrder The null sort order
static Sort.NullSortOrder	NULLS_FIRST Null sort order for ording nulls prior to all other values.
static Sort.NullSortOrder	NULLS_LAST Null sort order for ording nulls after all other values.
protected Sort.SortOrder	order The sort order

Constructor Summary

Constructors

Constructor and Description
Sort(FieldExpression field)
Sort(FieldExpression field, Sort.SortOrder order)
Sort(FieldExpression field, Sort.SortOrder order, Sort.NullSortOrder nullOrder)
Sort(String name) Sort descending by field name.
Sort(String field, Sort.SortOrder order) Sort by field name according to order.
Sort(String field, Sort.SortOrder order, Sort.NullSortOrder nullOrder) Sort by field according to order.

Method Summary

Modifier and Type	Method and Description
Sort	clone()
boolean	equals(Object other)
FieldExpression	getField() Get the field to sort by.
String	getFieldName()
Sort.NullSortOrder	getNullOrder() Get the order for sorting null values.
Sort.SortOrder	getOrder() Get the order to sort by.
int	hashCode()
boolean	isAscending() true if sort order is Sort.SortOrder.ASCENDING.
boolean	isDescending() true if sort order is Sort.SortOrder.DESCENDING.
boolean	isRelevancySort() true if this Sort by document score (sorting by field FieldNames.SCORE)
static Sort	parseSort(StringParser reader) Parse a Sort.
static Sort	relevancySort() Factory method for creating a sort according to score, descending.
void	setField(FieldExpression value) Set the field to sort by.
void	setField(String value) Set the field to sort by.
void	setNullOrder(Sort.NullSortOrder value) Set the order for sorting null values.
void	setOrder(Sort.SortOrder order) Set the order to sort by.
String	toString()
static Sort	valueOf(String value) Parse a Sort.

Methods inherited from class java.lang.Object

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

Field Detail

DEFAULT_ORDER

public static final Sort.SortOrder DEFAULT_ORDER

Default Sort Order.

ASC

public static final Sort.SortOrder ASC

Ascending Sort Order.

DESC

public static final Sort.SortOrder DESC

Descending Sort Order.

NULLS_FIRST

public static final Sort.NullSortOrder NULLS_FIRST

Null sort order for ording nulls prior to all other values.

NULLS_LAST

public static final Sort.NullSortOrder NULLS_LAST

Null sort order for ording nulls after all other values.

field

protected FieldExpression field

The field being sorted on.

order

protected Sort.SortOrder order

The sort order

nullOrder

protected Sort.NullSortOrder nullOrder

The null sort order

Constructor Detail

Sort

public Sort(String name)

Sort descending by field name.

Sort

public Sort(String field,
            Sort.SortOrder order)

Sort by field name according to order.

Sort

public Sort(FieldExpression field)

Sort

public Sort(FieldExpression field,
            Sort.SortOrder order)

Sort

public Sort(String field,
            Sort.SortOrder order,
            Sort.NullSortOrder nullOrder)

Sort by field according to order.

Sort

public Sort(FieldExpression field,
            Sort.SortOrder order,
            Sort.NullSortOrder nullOrder)

Method Detail

getFieldName

public String getFieldName()

getField

public FieldExpression getField()

Get the field to sort by.

setField

public void setField(String value)

Set the field to sort by.

setField

public void setField(FieldExpression value)

Set the field to sort by.

isRelevancySort

public boolean isRelevancySort()

true if this Sort by document score (sorting by field FieldNames.SCORE)

getOrder

public Sort.SortOrder getOrder()

Get the order to sort by.

setOrder

public void setOrder(Sort.SortOrder order)

Set the order to sort by.

getNullOrder

public Sort.NullSortOrder getNullOrder()

Get the order for sorting null values.

setNullOrder

public void setNullOrder(Sort.NullSortOrder value)

Set the order for sorting null values.

isAscending

public boolean isAscending()

true if sort order is Sort.SortOrder.ASCENDING.

isDescending

public boolean isDescending()

true if sort order is Sort.SortOrder.DESCENDING.

equals

public boolean equals(Object other)

Overrides:

equals in class Object

hashCode

public int hashCode()

Overrides:

hashCode in class Object

clone

public Sort clone()

Overrides:

clone in class Object

toString

public String toString()

Overrides:

toString in class Object

relevancySort

public static Sort relevancySort()

Factory method for creating a sort according to score, descending.

valueOf

public static Sort valueOf(String value)

Parse a Sort.

parseSort

public static Sort parseSort(StringParser reader)

Parse a Sort.