Package com.funnelback.plugin.search.model

Enum Sort

java.lang.Object

java.lang.Enum<Sort>

com.funnelback.plugin.search.model.Sort

All Implemented Interfaces:

Serializable, Comparable<Sort>

public enum Sort
extends Enum<Sort>

Sort options for returned suggestions

Enum Constant Summary

Enum Constants

Enum Constant	Description
AscendingAlphabetic	Sort by ascending alphabetic order
AscendingLength	Sort by ascending length
DescendingWeight	Sort by descending weight
DescendingWeightedComboScore	Sort by weighted combo of weight and length score = alpha * weight + (1 - alpha) * length_score

Field Summary

Fields

Modifier and Type	Field	Description
int	code	Sort code for libqs

Constructor Summary

Constructors

Modifier	Constructor	Description
private	Sort(int code)

Method Summary

Modifier and Type	Method	Description
static Sort	valueOf(String name)	Returns the enum constant of this type with the specified name.
static Sort[]	values()	Returns an array containing the constants of this enum type, in the order they are declared.

Methods inherited from class java.lang.Enum

clone, compareTo, equals, finalize, getDeclaringClass, hashCode, name, ordinal, toString, valueOf

Methods inherited from class java.lang.Object

getClass, notify, notifyAll, wait, wait, wait

Enum Constant Detail

DescendingWeight

public static final Sort DescendingWeight

Sort by descending weight

AscendingLength

public static final Sort AscendingLength

Sort by ascending length

AscendingAlphabetic

public static final Sort AscendingAlphabetic

Sort by ascending alphabetic order

DescendingWeightedComboScore

public static final Sort DescendingWeightedComboScore

Sort by weighted combo of weight and length score = alpha * weight + (1 - alpha) * length_score

Field Detail

code

public final int code

Sort code for libqs

Constructor Detail

Sort

private Sort(int code)

Method Detail

values

public static Sort[] values()

Returns an array containing the constants of this enum type, in the order they are declared. This method may be used to iterate over the constants as follows:

for (Sort c : Sort.values())
    System.out.println(c);

Returns:

an array containing the constants of this enum type, in the order they are declared

valueOf

public static Sort valueOf(String name)

Returns the enum constant of this type with the specified name. The string must match exactly an identifier used to declare an enum constant in this type. (Extraneous whitespace characters are not permitted.)

Parameters:

name - the name of the enum constant to be returned.

Returns:

the enum constant with the specified name

Throws:

IllegalArgumentException - if this enum type has no constant with the specified name

NullPointerException - if the argument is null