senselogic.sitevision.api.search

Class SearchSortField

Object

senselogic.sitevision.api.search.SearchSortField

public class SearchSortField
extends Object

SearchSortField describes in what way a 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).

An instance of this class can be obtained via SearchFactory.getSearchSortField(String, boolean). See SearchFactory for how to obtain an instance of the SearchFactory interface.

Example of how to get SearchSortField instances in sever-side Javascript:

   // Get SearchFactory to create instances
   var searchFactory = require('SearchFactory'),
       lastPubDesc = searchFactory.getSearchSortField('lastpublished', false),
       nameAsc = searchFactory.getSearchSortField('name.sortable', true),
       ...

Example of how to get SearchSortField instances in Velocity:

   ## Get the factory and the builder
   #set ($searchFactory = $sitevisionUtils.searchFactory)
   #set ($lastPubDesc = $searchFactory.getSearchSortField('lastpublished', false))
   #set ($nameAsc = $searchFactory.getSearchSortField('name.sortable', true))
   ...

Since:

Sitevision 2.6.1

Author:

Mikael Wikblom

See Also:

SortBuilder

Constructor Summary

Constructors

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

Method Summary

Modifier and Type	Method and Description
String	getField() Name of the index field.
boolean	isAscending() Whether sort order is ascending or not.
boolean	isDescending() Whether sort order is descending or not.

Methods inherited from class Object

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

Constructor Detail

SearchSortField

public SearchSortField(String aField,
                       boolean aIsAscending)

Creates a SearchSortField object.

Throws NullPointerException if aField is null

Parameters:

aField - name of the sortable index field

aIsAscending - the sort order (true == ascending, false == descending)

Method Detail

getField

public String getField()

Name of the index field.

Returns:

the index field name

isAscending

public boolean isAscending()

Whether sort order is ascending or not.

Returns:

true if the sort order is ascending, false otherwise

Since:

Sitevision 5.0.1

isDescending

public boolean isDescending()

Whether sort order is descending or not.

Returns:

true if the sort order is descending, false otherwise