senselogic.sitevision.api.search.searcher.builder

Interface SortBuilder

All Superinterfaces:

Builder<Sort>

@Requireable(value="SortBuilder")
public interface SortBuilder
extends Builder<Sort>

Builder for creating a Sort component with specific behaviour.

SortBuilder has one mandatory attribute:

• sort fields - The sort field(s) that should be used to sort a search result. Must be non-null.

Using the SortBuilder is pretty straightforward, if you remember that it is stateful. Conceptually you would typically use it like this:

1. Get the SortBuilder
2. Create a SearchSortField
3. Add the SearchSortField to the SortBuilder
4. Possibly create another SearchSortField and add it to the SortBuilder
5. Do build

When you have built a Sort instance, you can re-use the SortBuilder to build more instances. Typically like:

1. Clear the sort fields
2. Create a SearchSortField and add it to the SortBuilder
3. Possibly create another SearchSortField and add it to the SortBuilder
4. Do build

Example of how this strategy could be implemented in sever-side Javascript:

   // Get the factory and the builder
   var searchFactory = require('SearchFactory'),
       sortBuilder = searchFactory.getSortBuilder(),
       searchSortField,
       updatedDescSort,
       nameAscSort;

   // Create a Sort
   searchSortField = searchFactory.getSearchSortField('lastpublished', false);
   updatedDescSort = sortBuilder.addSortField(searchSortField).build();

   // Re-use the builder to create another Sort
   searchSortField = searchFactory.getSearchSortField('name.sortable', true);
   nameAscSort = sortBuilder.clearSortFields().addSortField(searchSortField).build();
 

Example of how this strategy could be implemented in Velocity:

   ## Get the factory and the builder
   #set ($searchFactory = $sitevisionUtils.searchFactory)
   #set ($sortBuilder = $searchFactory.sortBuilder)

   ## Create a Sort
   #set ($searchSortField = $searchFactory.getSearchSortField('lastpublished', false))
   #set ($updatedDescSort = $sortBuilder.addSortField($searchSortField).build())

   ## Re-use the builder to create another Sort
   #set ($searchSortField = $searchFactory.getSearchSortField('name.sortable', true))
   #set ($nameAscSort = $sortBuilder.clearSortFields().addSortField($searchSortField).build())
 

Tip! The Builder interface documentation contains more information about Builders and how to work with them!

An instance of the Sitevision class implementing this interface can be obtained via SearchFactory.getSortBuilder(). See SearchFactory for how to obtain an instance of the SearchFactory interface.

Since:

Sitevision 3.6

Author:

Magnus Lövgren

Method Summary

Modifier and Type	Method and Description
SortBuilder	addSortField(SearchSortField aSearchSortField) Adds a sort field.
Sort	build() Creates a Sort component instance using currently specified state/behaviour.
SortBuilder	clearSortFields() Removes all previously added sort fields.

Method Detail

addSortField

SortBuilder addSortField(SearchSortField aSearchSortField)

Adds a sort field.

Parameters:

aSearchSortField - a sort field, a null value is ignored

Returns:

this builder

clearSortFields

SortBuilder clearSortFields()

Removes all previously added sort fields.

Returns:

this builder

build

Sort build()
    throws IllegalStateException

Creates a Sort component instance using currently specified state/behaviour.

Specified by:

build in interface Builder<Sort>

Returns:

a Sort component

Throws:

IllegalStateException - if no sort fields are added