FacetFilterController (hybris Commerce Suite 6.3.0.0-SNAPSHOT)

java.lang.Object
- DefaultWidgetController
- - com.hybris.instore.widgets.facetfilter.FacetFilterController

```
public class FacetFilterController
extends DefaultWidgetController
```
Controller for the FacetFilter widget. It handles the pop up with available facet for the current search and also currently applied facet filters (facet breadcrumbs).

Field Summary

Fields
Modifier and Type	Field and Description
`static String`	`BREADCRUMB_LIST_MODEL_KEY`
`static String`	`COMP_ID_APPLY_BTN`
`static String`	`CURRENTFACET_LIST_MODEL_KEY`
`static String`	`CURRENTSMALLSEARCHRESUL_MODEL_KEY`
`protected static String`	`SCLASS_FACETFILTER_BREADCRUMB`
`protected static String`	`SCLASS_FACETFILTER_CLEARALL`
`protected static String`	`SCLASS_FACETFILTER_MAINCONTAINER`
`protected static String`	`SCLASS_FACETFILTER_PANEL`
`protected static String`	`SCLASS_FACETFILTER_PANEL_CAPTION`
`protected static String`	`SCLASS_FACETFILTER_PANEL_CHILDREN`
`protected static String`	`SCLASS_FACETFILTER_PANEL_CHILDREN_CHECKBOX`
`protected static String`	`SCLASS_FACETFILTER_PANEL_CHILDREN_RADIO`
`protected static String`	`SCLASS_FACETFILTER_REMOVEBREADCRUMB`
`protected static String`	`SETTING_VETOED_FACETS`
`static String`	`SOCKET_IN_SMALLSEARCHRESULT`
`static String`	`SOCKET_OUT_SELECTEDFACETS`
`static String`	`SOCKET_OUT_SMALLSEARCHRESULT`

Constructor Summary

Constructors
Constructor and Description

FacetFilterController()

Constructors
Constructor and Description
`FacetFilterController()`

Method Summary

All Methods Instance Methods Concrete Methods
Modifier and Type	Method and Description
`void`	`applyFacetFilter()` `Events#ON_CLICK` event handler for the apply button.
`protected Component`	`createBreadcrumb(BreadcrumbData<SearchStateData> breadcrumb)` Creates a view component for a given breadcrumb.
`protected Component`	`createFacetComponent(FacetData<SearchStateData> facet)` Creates a view component for the given facet.
`protected void`	`displayFacetBreadcrumbs(List<BreadcrumbData<SearchStateData>> breadcrumbData)` Draws facet breadcrumbs
`void`	`initialize(Component comp)` Initializes the facet filter popup title.
`protected void`	`initializeVetoedFacetsCodes()` Creates a set of facet codes that should be filtered out according to a comma-separated string list in widget setting "vetoedFacets".
`protected boolean`	`isFacetVisible(FacetData<SearchStateData> facet)` Checks the facet visibility: if facet priority is positive value and if it is not among vetoedFactes.
`void`	`preInitialize(Component comp)` Initializes the vetoed facets and model values for current facets and search breadcrumbs/
`protected void`	`removeAllBreadCrumbs()` Removes all currently applied breadcrumbs.
`protected void`	`removeBreadcrumb(BreadcrumbData<SearchStateData> breadcrumb)` Removes a breadcrumb from the current selection.
`protected FacetData<SearchStateData>`	`removeValuesFromFacet(FacetData<SearchStateData> facetData, List<FacetValueData<SearchStateData>> values2remove)` Removes given values form the given facet.
`protected void`	`renderBreadcrumbs(List<BreadcrumbData<SearchStateData>> facetBreadcrumbs, Component parent)` Creates view components for the given breadcrumbs and adds it to the parent component.
`protected void`	`renderFacets(List<FacetData<SearchStateData>> facets, Component parent)` Creates view components for the given facets and adds it to the parent component.
`protected Component`	`renderFacetValueComponent(FacetData<SearchStateData> facet, FacetValueData<SearchStateData> facetValue)` Draws a facet value component - a radiobutton or checkbox for multiselect facets.
`protected void`	`renderFacetValues(FacetData<SearchStateData> facet, Component parent)` Creates a view components for facet values of the given facet and adds it to the specified parent view component.
`protected void`	`sendFacetValue(FacetData<SearchStateData> facet, FacetValueData<SearchStateData> facetValue)` On facet selection, this method adds given facet value to the currently selected and send the updated search refinements to the output socket.
`protected void`	`updateFacets(List<FacetData<SearchStateData>> facets)` Renders new set of facets in the facetContainer component.
`void`	`updateSearchState(ProductSearchPageData<SearchStateData,ProductData> searchPageData)` Update Currently displayed facets and facet breadcrumbs according to given products search result.
`protected void`	`updateTotalCount(long totalNumberOfResults)`

Methods inherited from class java.lang.Object
clone, equals, finalize, getClass, hashCode, notify, notifyAll, toString, wait, wait, wait

- Field Detail
  - SCLASS_FACETFILTER_PANEL_CHILDREN_CHECKBOX
```
protected static final String SCLASS_FACETFILTER_PANEL_CHILDREN_CHECKBOX
```
    See Also:
    
    Constant Field Values
  - SCLASS_FACETFILTER_PANEL_CHILDREN_RADIO
```
protected static final String SCLASS_FACETFILTER_PANEL_CHILDREN_RADIO
```
    See Also:
    
    Constant Field Values
  - SCLASS_FACETFILTER_PANEL_CHILDREN
```
protected static final String SCLASS_FACETFILTER_PANEL_CHILDREN
```
    See Also:
    
    Constant Field Values
  - SCLASS_FACETFILTER_PANEL_CAPTION
```
protected static final String SCLASS_FACETFILTER_PANEL_CAPTION
```
    See Also:
    
    Constant Field Values
  - SCLASS_FACETFILTER_PANEL
```
protected static final String SCLASS_FACETFILTER_PANEL
```
    See Also:
    
    Constant Field Values
  - SCLASS_FACETFILTER_MAINCONTAINER
```
protected static final String SCLASS_FACETFILTER_MAINCONTAINER
```
    See Also:
    
    Constant Field Values
  - SCLASS_FACETFILTER_BREADCRUMB
```
protected static final String SCLASS_FACETFILTER_BREADCRUMB
```
    See Also:
    
    Constant Field Values
  - SCLASS_FACETFILTER_REMOVEBREADCRUMB
```
protected static final String SCLASS_FACETFILTER_REMOVEBREADCRUMB
```
    See Also:
    
    Constant Field Values
  - SCLASS_FACETFILTER_CLEARALL
```
protected static final String SCLASS_FACETFILTER_CLEARALL
```
    See Also:
    
    Constant Field Values
  - SETTING_VETOED_FACETS
```
protected static final String SETTING_VETOED_FACETS
```
    See Also:
    
    Constant Field Values
  - CURRENTSMALLSEARCHRESUL_MODEL_KEY
```
public static final String CURRENTSMALLSEARCHRESUL_MODEL_KEY
```
    See Also:
    
    Constant Field Values
  - BREADCRUMB_LIST_MODEL_KEY
```
public static final String BREADCRUMB_LIST_MODEL_KEY
```
    See Also:
    
    Constant Field Values
  - CURRENTFACET_LIST_MODEL_KEY
```
public static final String CURRENTFACET_LIST_MODEL_KEY
```
    See Also:
    
    Constant Field Values
  - SOCKET_IN_SMALLSEARCHRESULT
```
public static final String SOCKET_IN_SMALLSEARCHRESULT
```
    See Also:
    
    Constant Field Values
  - SOCKET_OUT_SELECTEDFACETS
```
public static final String SOCKET_OUT_SELECTEDFACETS
```
    See Also:
    
    Constant Field Values
  - SOCKET_OUT_SMALLSEARCHRESULT
```
public static final String SOCKET_OUT_SMALLSEARCHRESULT
```
    See Also:
    
    Constant Field Values
  - COMP_ID_APPLY_BTN
```
public static final String COMP_ID_APPLY_BTN
```
    See Also:
    
    Constant Field Values
- Constructor Detail
  - FacetFilterController
```
public FacetFilterController()
```
- Method Detail
  - preInitialize
```
public void preInitialize(Component comp)
```
    Initializes the vetoed facets and model values for current facets and search breadcrumbs/
  - initialize
```
public void initialize(Component comp)
```
    Initializes the facet filter popup title.
  - initializeVetoedFacetsCodes
```
protected void initializeVetoedFacetsCodes()
```
    Creates a set of facet codes that should be filtered out according to a comma-separated string list in widget setting "vetoedFacets".
  - updateSearchState
```
public void updateSearchState(ProductSearchPageData<SearchStateData,ProductData> searchPageData)
```
    Update Currently displayed facets and facet breadcrumbs according to given products search result.
    
    Parameters:
    
    searchPageData -
  - displayFacetBreadcrumbs
```
protected void displayFacetBreadcrumbs(List<BreadcrumbData<SearchStateData>> breadcrumbData)
```
    Draws facet breadcrumbs
    
    Parameters:
    
    breadcrumbData -
  - renderBreadcrumbs
```
protected void renderBreadcrumbs(List<BreadcrumbData<SearchStateData>> facetBreadcrumbs,
                                 Component parent)
```
    Creates view components for the given breadcrumbs and adds it to the parent component.
  - createBreadcrumb
```
protected Component createBreadcrumb(BreadcrumbData<SearchStateData> breadcrumb)
```
    Creates a view component for a given breadcrumb.
  - removeBreadcrumb
```
protected void removeBreadcrumb(BreadcrumbData<SearchStateData> breadcrumb)
```
    Removes a breadcrumb from the current selection.
    
    Parameters:
    
    breadcrumb -
  - removeAllBreadCrumbs
```
protected void removeAllBreadCrumbs()
```
    Removes all currently applied breadcrumbs.
  - updateFacets
```
protected void updateFacets(List<FacetData<SearchStateData>> facets)
```
    Renders new set of facets in the facetContainer component.
    
    Parameters:
    
    facets -
  - renderFacets
```
protected void renderFacets(List<FacetData<SearchStateData>> facets,
                            Component parent)
```
    Creates view components for the given facets and adds it to the parent component.
  - isFacetVisible
```
protected boolean isFacetVisible(FacetData<SearchStateData> facet)
```
    Checks the facet visibility: if facet priority is positive value and if it is not among vetoedFactes.
    
    Returns:
    
    true, if the given facet is visible, false otherwise.
  - createFacetComponent
```
protected Component createFacetComponent(FacetData<SearchStateData> facet)
```
    Creates a view component for the given facet.
  - renderFacetValues
```
protected void renderFacetValues(FacetData<SearchStateData> facet,
                                 Component parent)
```
    Creates a view components for facet values of the given facet and adds it to the specified parent view component.
  - renderFacetValueComponent
```
protected Component renderFacetValueComponent(FacetData<SearchStateData> facet,
                                              FacetValueData<SearchStateData> facetValue)
```
    Draws a facet value component - a radiobutton or checkbox for multiselect facets.
    
    Parameters:
    
    facet -
    
    facetValue -
    
    Returns:
    
    Component
  - applyFacetFilter
```
public void applyFacetFilter()
```
    Events#ON_CLICK event handler for the apply button. Sends the search result from the last refinement to the output socket.
  - sendFacetValue
```
protected void sendFacetValue(FacetData<SearchStateData> facet,
                              FacetValueData<SearchStateData> facetValue)
```
    On facet selection, this method adds given facet value to the currently selected and send the updated search refinements to the output socket.
    
    Parameters:
    
    facet -
    
    facetValue -
  - removeValuesFromFacet
```
protected FacetData<SearchStateData> removeValuesFromFacet(FacetData<SearchStateData> facetData,
                                                           List<FacetValueData<SearchStateData>> values2remove)
```
    Removes given values form the given facet.
    
    Parameters:
    
    facetData -
    
    values2remove -
    
    Returns:
    
    updated FacetData
  - updateTotalCount
```
protected void updateTotalCount(long totalNumberOfResults)
```
    Parameters:
    
    totalNumberOfResults -

Class FacetFilterController

Field Summary

Constructor Summary

Method Summary

Methods inherited from class java.lang.Object

Field Detail

SCLASS_FACETFILTER_PANEL_CHILDREN_CHECKBOX

SCLASS_FACETFILTER_PANEL_CHILDREN_RADIO

SCLASS_FACETFILTER_PANEL_CHILDREN

SCLASS_FACETFILTER_PANEL_CAPTION

SCLASS_FACETFILTER_PANEL

SCLASS_FACETFILTER_MAINCONTAINER

SCLASS_FACETFILTER_BREADCRUMB

SCLASS_FACETFILTER_REMOVEBREADCRUMB

SCLASS_FACETFILTER_CLEARALL

SETTING_VETOED_FACETS

CURRENTSMALLSEARCHRESUL_MODEL_KEY

BREADCRUMB_LIST_MODEL_KEY

CURRENTFACET_LIST_MODEL_KEY

SOCKET_IN_SMALLSEARCHRESULT

SOCKET_OUT_SELECTEDFACETS

SOCKET_OUT_SMALLSEARCHRESULT

COMP_ID_APPLY_BTN

Constructor Detail

FacetFilterController

Method Detail

preInitialize

initialize

initializeVetoedFacetsCodes

updateSearchState

displayFacetBreadcrumbs

renderBreadcrumbs

createBreadcrumb

removeBreadcrumb

removeAllBreadCrumbs

updateFacets

renderFacets

isFacetVisible

createFacetComponent

renderFacetValues

renderFacetValueComponent

applyFacetFilter

sendFacetValue

removeValuesFromFacet

updateTotalCount