Package com.yahoo.search.query

Class Sorting

java.lang.Object

com.yahoo.search.query.Sorting

All Implemented Interfaces:

Cloneable

public class Sorting
extends Object
implements Cloneable

Specifies how a query is sorted by a list of fields with a sort order

Author:

Arne Bergene Fossaa

Nested Class Summary

Nested Classes

Modifier and Type	Class	Description
static class	Sorting.AttributeSorter
static class	Sorting.FieldOrder	An attribute (field) and how it should be sorted
static class	Sorting.LowerCaseSorter
static enum	Sorting.Order
static class	Sorting.RawSorter
static class	Sorting.UcaSorter

Field Summary

Fields

Modifier and Type	Field	Description
static final String	LOWERCASE
static final String	RAW
static final String	STRENGTH_IDENTICAL
static final String	STRENGTH_PRIMARY
static final String	STRENGTH_QUATERNARY
static final String	STRENGTH_SECONDARY
static final String	STRENGTH_TERTIARY
static final String	UCA

Constructor Summary

Constructors

Constructor	Description
Sorting()	Creates an empty sort spec
Sorting(String sortSpec)	Creates a sort spec from a string
Sorting(String sortSpec, Query query)	Creates a sort spec from a string, for a given query.
Sorting(List<Sorting.FieldOrder> fieldOrders)

Method Summary

Modifier and Type	Method	Description
Sorting	clone()
int	encode(ByteBuffer buffer)
boolean	equals(Object o)
List<Sorting.FieldOrder>	fieldOrders()	Returns the field orders of this sort specification as list.
static Sorting	fromString(String sortSpec)	Creates a new sorting from the given string and returns it, or returns null if the argument does not contain any sorting criteria (e.g it is null or the empty string)
int	hashCode()
String	toString()

Methods inherited from class java.lang.Object

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

Field Details

STRENGTH_IDENTICAL

public static final String STRENGTH_IDENTICAL

See Also:

• Constant Field Values

STRENGTH_QUATERNARY

public static final String STRENGTH_QUATERNARY

See Also:

• Constant Field Values

STRENGTH_TERTIARY

public static final String STRENGTH_TERTIARY

See Also:

• Constant Field Values

STRENGTH_SECONDARY

public static final String STRENGTH_SECONDARY

See Also:

• Constant Field Values

STRENGTH_PRIMARY

public static final String STRENGTH_PRIMARY

See Also:

• Constant Field Values

UCA

public static final String UCA

See Also:

• Constant Field Values

RAW

public static final String RAW

See Also:

• Constant Field Values

LOWERCASE

public static final String LOWERCASE

See Also:

• Constant Field Values

Constructor Details

Sorting

public Sorting()

Creates an empty sort spec

Sorting

public Sorting(List<Sorting.FieldOrder> fieldOrders)

Sorting

public Sorting(String sortSpec)

Creates a sort spec from a string

Sorting

public Sorting(String sortSpec,
 Query query)

Creates a sort spec from a string, for a given query.

Method Details

fromString

public static Sorting fromString(String sortSpec)

Creates a new sorting from the given string and returns it, or returns null if the argument does not contain any sorting criteria (e.g it is null or the empty string)

toString

public String toString()

Overrides:

toString in class Object

fieldOrders

public List<Sorting.FieldOrder> fieldOrders()

Returns the field orders of this sort specification as list. This is never null but can be empty. This list can be modified to change this sort spec.

clone

public Sorting clone()

Overrides:

clone in class Object

hashCode

public int hashCode()

Overrides:

hashCode in class Object

equals

public boolean equals(Object o)

Overrides:

equals in class Object

encode

public int encode(ByteBuffer buffer)