senselogic.sitevision.api.search

Class SearchSortField

Object

senselogic.sitevision.api.search.SearchSortField

public class SearchSortField
extends Object

An immutable object SearchSortField describes in which way the search result will be ordered.

Note! Only single-valued fields can be used for sorting (i.e. you typically can not sort on an analyzed field).

Author:

Mikael Wikblom

Constructor Summary

Constructors

Constructor and Description
SearchSortField(String aField, boolean isDescending) Creates a SearchSortField object.

Method Summary

Modifier and Type	Method and Description
String	getField() Accessor to the search field.
boolean	isDescending() Accessor to the search order.

Methods inherited from class Object

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

Constructor Detail

SearchSortField

public SearchSortField(String aField,
                       boolean isDescending)

Creates a SearchSortField object.

Throws NullPointerException if aField is null

Parameters:

aField - The search field

isDescending - The search order

Method Detail

getField

public String getField()

Accessor to the search field.

Returns:

The search field

isDescending

public boolean isDescending()

Accessor to the search order.

Returns:

The search order