org.kuali.student.ap.coursesearch

Interface CourseFacetStrategy

All Known Implementing Classes:

CourseFacetStrategyImpl

public interface CourseFacetStrategy

Strategy interface for specifying course search facet behavior.

Method Summary

Methods

Modifier and Type	Method and Description
Map<String,Map<String,FacetState>>	createInitialFacetStateMap(Map<String,List<String>> facetColumns, List<SearchInfo> searchResults) Creates the map of initial facet states values for the course search results.
boolean	facetClick(String fclick, String fcol, Map<String,FacetState> facetStateMap, boolean oneclick) Update checked state on all facets following a click event from the browser.
boolean	facetClickAll(boolean oneClick, Map<String,Map<String,FacetState>> facetStateMap) If a facet has already be clicked reset all facet values to true
Map<String,Integer>	getFacetColumns() Creates a mapping of the facet group names and the index they are in when ordered.
Map<String,Comparator<String>>	getFacetSort() Retrieves a static map of facets to their related sort algorithm.
List<String>	getSortedFacetColumnNames() Returns a list of the facet group names in order
Map<String,Map<String,FacetState>>	processFacetStateMap(Map<String,Map<String,FacetState>> facetStateMap, Map<String,List<String>> facetColumns) Refines and updates the facet states
void	updateFacetCounts(List<SearchInfo> searchResults, Map<String,Map<String,FacetState>> facetState, Map<String,List<String>> facetCols) Updates the number of results shown for each facet value based on the current facet filtering

Method Detail

getFacetColumns

Map<String,Integer> getFacetColumns()

Creates a mapping of the facet group names and the index they are in when ordered.

Returns:

A map relating facet group names and ordering position.

getSortedFacetColumnNames

List<String> getSortedFacetColumnNames()

Returns a list of the facet group names in order

Returns:

A ordered list of facet group names.

getFacetSort

Map<String,Comparator<String>> getFacetSort()

Retrieves a static map of facets to their related sort algorithm.

Returns:

Static map of facet id to comparator

updateFacetCounts

void updateFacetCounts(List<SearchInfo> searchResults,
                     Map<String,Map<String,FacetState>> facetState,
                     Map<String,List<String>> facetCols)

Updates the number of results shown for each facet value based on the current facet filtering

Parameters:

searchResults - - List of the search results

facetState - - Map of the current facet information

facetCols - - Map of the facet available for each search item.

facetClick

boolean facetClick(String fclick,
                 String fcol,
                 Map<String,FacetState> facetStateMap,
                 boolean oneclick)

Update checked state on all facets following a click event from the browser.

Parameters:

fclick - - The facet key clicked. May be 'All'.

fcol - - The facet column the click is related to.

facetStateMap - - The facet state map

oneclick - - Current state if a facet value has been set to false

facetClickAll

boolean facetClickAll(boolean oneClick,
                    Map<String,Map<String,FacetState>> facetStateMap)

If a facet has already be clicked reset all facet values to true

Parameters:

oneClick - - Current state if a facet value has been set to false

facetStateMap - - The facet state map

Returns:

True if no changes were made

createInitialFacetStateMap

Map<String,Map<String,FacetState>> createInitialFacetStateMap(Map<String,List<String>> facetColumns,
                                                            List<SearchInfo> searchResults)

Creates the map of initial facet states values for the course search results.

Parameters:

facetColumns - - Map of the facet available for each search item.

searchResults - - List of results returned in the search

Returns:

A map to each possible facet value and its initial state in the search results

processFacetStateMap

Map<String,Map<String,FacetState>> processFacetStateMap(Map<String,Map<String,FacetState>> facetStateMap,
                                                      Map<String,List<String>> facetColumns)

Refines and updates the facet states

Parameters:

facetStateMap - - Map of the current states of all facet value.

facetColumns - - Map of the facet available for each search item.

Returns:

- Refined map of the facet states of all facet values