Package gov.niem.tools.api.search

Enum Class SearchService.SortOrder

java.lang.Object

java.lang.Enum<SearchService.SortOrder>

gov.niem.tools.api.search.SearchService.SortOrder

All Implemented Interfaces:

Serializable, Comparable<SearchService.SortOrder>, Constable

Enclosing class:

SearchService

public static enum SearchService.SortOrder
extends Enum<SearchService.SortOrder>

Defines options for sorting search results.

Nested Class Summary

Nested classes/interfaces inherited from class java.lang.Enum

Enum.EnumDesc<E extends Enum<E>>

Enum Constant Summary

Enum Constants

Enum Constant	Description
name	Sort by name, then prefix.
qname	Sort by qname.
rank_name	Sort by namespace rank (Core first, then domains, etc.), then name, then prefix.
rank_qname	Sort by namespace rank (Core first, then domains, etc.), then qname.
score_name	Sort by weighted score, then name, then prefix.
score_qname	Sort by weighted score, then qname.

Method Summary

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

Methods inherited from class java.lang.Enum

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

Methods inherited from class java.lang.Object

getClass, notify, notifyAll, wait, wait, wait

Enum Constant Details

score_name

public static final SearchService.SortOrder score_name

Sort by weighted score, then name, then prefix.

score_qname

public static final SearchService.SortOrder score_qname

Sort by weighted score, then qname.

rank_qname

public static final SearchService.SortOrder rank_qname

Sort by namespace rank (Core first, then domains, etc.), then qname.

rank_name

public static final SearchService.SortOrder rank_name

Sort by namespace rank (Core first, then domains, etc.), then name, then prefix.

name

public static final SearchService.SortOrder name

Sort by name, then prefix.

qname

public static final SearchService.SortOrder qname

Sort by qname.

Method Details

values

public static SearchService.SortOrder[] values()

Returns an array containing the constants of this enum class, in the order they are declared.

Returns:

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

valueOf

public static SearchService.SortOrder valueOf(String name)

Returns the enum constant of this class with the specified name. The string must match exactly an identifier used to declare an enum constant in this class. (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 class has no constant with the specified name

NullPointerException - if the argument is null