Package io.goobi.viewer.model.termbrowsing

Class BrowsingMenuFieldConfig

java.lang.Object
io.goobi.viewer.model.termbrowsing.BrowsingMenuFieldConfig
All Implemented Interfaces:
Serializable
public class BrowsingMenuFieldConfig extends Object implements Serializable
Configuration for a single field entry in the alphabetical browsing menu, specifying the Solr field and display options.
See Also:

  • Constructor Details

    • BrowsingMenuFieldConfig

      public BrowsingMenuFieldConfig(String field, String sortField, String filterQuery)
      Constructor.
      Parameters:
      field - Solr field name to browse.
      sortField - Solr field used for sorting the terms.
      filterQuery - optional Solr filter query to restrict results.

  • Method Details

    • getField

      public String getField()
      Getter for the field field.
      Returns:
      the Solr field name used for term browsing

    • getFieldForLanguage

      public String getFieldForLanguage(String language)
      Parameters:
      language - the language code to substitute into the field name
      Returns:
      Language specific variant of field if it contains a placeholder; otherwise unaltered field

    • getSortField

      public String getSortField()
      Getter for the field sortField.
      Returns:
      the Solr field used for sorting browse terms

    • getFilterQueries

      public List<String> getFilterQueries()
      Getter for the field filterQueries.
      Returns:
      the list of Solr filter queries applied when browsing this field

    • isTranslate

      public boolean isTranslate()

    • setTranslate

      public BrowsingMenuFieldConfig setTranslate(boolean translate)
      Parameters:
      translate - true if browse term values should be translated via message keys
      Returns:
      this

    • isAlwaysApplyFilter

      public boolean isAlwaysApplyFilter()

    • setAlwaysApplyFilter

      public BrowsingMenuFieldConfig setAlwaysApplyFilter(boolean alwaysApplyFilter)
      Parameters:
      alwaysApplyFilter - true if a filter query should always be applied when browsing this field
      Returns:
      this

    • isSkipInWidget

      public boolean isSkipInWidget()

    • setSkipInWidget

      public BrowsingMenuFieldConfig setSkipInWidget(boolean skipInWidget)
      Parameters:
      skipInWidget - true if this field should be excluded from the browse widget display
      Returns:
      this;

    • isRecordsAndAnchorsOnly

      public boolean isRecordsAndAnchorsOnly()
      Returns:
      true if filterQueries contains SearchHelper.ALL_RECORDS_QUERY; false otherwise

    • setRecordsAndAnchorsOnly

      public BrowsingMenuFieldConfig setRecordsAndAnchorsOnly(boolean recordsAndAnchorsOnly)
      Parameters:
      recordsAndAnchorsOnly - if true, adds a filter query restricting results to records and anchors only
      Returns:
      this