Class AdvancedSearchFieldConfiguration

java.lang.Object
io.goobi.viewer.model.search.AdvancedSearchFieldConfiguration

public class AdvancedSearchFieldConfiguration extends Object
Configuration element for advanced search fields.
  • Field Details

  • Constructor Details

    • AdvancedSearchFieldConfiguration

      public AdvancedSearchFieldConfiguration(String field)
      Parameters:
      field - Solr field name or separate placeholder
  • Method Details

    • getField

      public String getField()
    • getLabel

      public String getLabel()
      Returns:
      the display label for this search field configuration, or the field name if no label is set
    • setLabel

      public AdvancedSearchFieldConfiguration setLabel(String label)
      Parameters:
      label - the display label for this search field configuration
      Returns:
      this object
    • isHierarchical

      public boolean isHierarchical()
    • setHierarchical

      public AdvancedSearchFieldConfiguration setHierarchical(boolean hierarchical)
      Parameters:
      hierarchical - true if the field should be displayed hierarchically; false otherwise
      Returns:
      this object
    • isRange

      public boolean isRange()
    • setRange

      public AdvancedSearchFieldConfiguration setRange(boolean range)
      Parameters:
      range - true if the field should be displayed as a range input; false otherwise
      Returns:
      this object
    • isDatepicker

      public boolean isDatepicker()
    • setDatepicker

      public AdvancedSearchFieldConfiguration setDatepicker(boolean datepicker)
      Parameters:
      datepicker - true if the field should use a datepicker UI control; false otherwise
      Returns:
      this object
    • isUntokenizeForPhraseSearch

      public boolean isUntokenizeForPhraseSearch()
    • setUntokenizeForPhraseSearch

      public AdvancedSearchFieldConfiguration setUntokenizeForPhraseSearch(boolean untokenizeForPhraseSearch)
      Parameters:
      untokenizeForPhraseSearch - true if the field value should be untokenized when used in phrase search queries; false otherwise
      Returns:
      this object
    • isDisabled

      public boolean isDisabled()
    • setDisabled

      public AdvancedSearchFieldConfiguration setDisabled(boolean disabled)
      Parameters:
      disabled - true if this search field configuration should be disabled; false otherwise
      Returns:
      this object
    • isVisible

      public boolean isVisible()
    • isAllowMultipleItems

      public boolean isAllowMultipleItems()
    • setAllowMultipleItems

      public AdvancedSearchFieldConfiguration setAllowMultipleItems(boolean allowMultipleItems)
      Parameters:
      allowMultipleItems - true if multiple search items may be added for this field; false otherwise
      Returns:
      this
    • setVisible

      public AdvancedSearchFieldConfiguration setVisible(boolean visible)
      Parameters:
      visible - true if this field configuration should be visible to the user; false otherwise
      Returns:
      this
    • getDisplaySelectItemsThreshold

      public int getDisplaySelectItemsThreshold()
    • setDisplaySelectItemsThreshold

      public AdvancedSearchFieldConfiguration setDisplaySelectItemsThreshold(int displaySelectItemsThreshold)
      Parameters:
      displaySelectItemsThreshold - maximum number of available values below which a select widget is displayed instead of a text input
      Returns:
      this
    • getSelectType

      public String getSelectType()
    • setSelectType

      public AdvancedSearchFieldConfiguration setSelectType(String selectType)
      Parameters:
      selectType - the type of select widget to use for this field (e.g. dropdown, checkboxes)
      Returns:
      this
    • getReplaceRegex

      public String getReplaceRegex()
    • setReplaceRegex

      public AdvancedSearchFieldConfiguration setReplaceRegex(String replaceRegex)
      Parameters:
      replaceRegex - the regular expression pattern applied to field values before display
      Returns:
      this
    • getReplaceWith

      public String getReplaceWith()
    • setReplaceWith

      public AdvancedSearchFieldConfiguration setReplaceWith(String replaceWith)
      Parameters:
      replaceWith - the replacement string substituted for matches of the replaceRegex pattern
      Returns:
      this
    • getPreselectValue

      public String getPreselectValue()
    • setPreselectValue

      public AdvancedSearchFieldConfiguration setPreselectValue(String preselectValue)
      Parameters:
      preselectValue - the value that should be pre-selected in the search field by default
      Returns:
      this