Package io.goobi.viewer.model.cms.widgets

Class FacetFieldSidebarWidget

java.lang.Object
io.goobi.viewer.model.cms.widgets.CustomSidebarWidget
io.goobi.viewer.model.cms.widgets.FacetFieldSidebarWidget
All Implemented Interfaces:
IPolyglott, Serializable
@Entity public class FacetFieldSidebarWidget extends CustomSidebarWidget
A subtype of CustomSidebarWidget to display a list of possible values of a given SOLR field and link to a search listing of items with a specific value
Author:
florian
See Also:

  • Constructor Details

    • FacetFieldSidebarWidget

      public FacetFieldSidebarWidget()
      Empty default constructor

    • FacetFieldSidebarWidget

      public FacetFieldSidebarWidget(FacetFieldSidebarWidget o)
      Cloning constructor
      Parameters:
      o -

  • Method Details

    • getFacetField

      public String getFacetField()
      Contains the SOLR field holding the values to list
      Returns:
      the facetField

    • setFacetField

      public void setFacetField(String facetField)
      Set the SOLR field for which to list values
      Parameters:
      facetField - the facetField to set

    • getFilterQuery

      public String getFilterQuery()
      An additional SOLR query. If this is not empty, only values of the getFacetField() are listed that are contained in documents meeting this query. This is also true for the linked result lists
      Returns:
      the filterQuery

    • getCombinedFilterQuery

      public String getCombinedFilterQuery(CMSPage page)

    • setFilterQuery

      public void setFilterQuery(String filterQuery)
      Set the value of getFilterQuery()
      Parameters:
      filterQuery - the filterQuery to set

    • getType

      public CustomWidgetType getType()
      Description copied from class: CustomSidebarWidget
      Return the type of this custom sidebar widget. Must be implemented by subclasses of CustomSidebarWidget
      Overrides:
      getType in class CustomSidebarWidget
      Returns:
      CustomWidgetType

    • getNumEntries

      public int getNumEntries()
      Returns:
      the number of field values displayed in the widget

    • setNumEntries

      public void setNumEntries(int numEntries)
      Set the number of field values displayed in the widget
      Parameters:
      numEntries -

    • getTitle

      public TranslatedText getTitle()
      Override default title to always show the selected facetField
      Overrides:
      getTitle in class CustomSidebarWidget
      Returns:
      the title