Package io.goobi.viewer.model.search

Interface IFacetItem

All Known Implementing Classes:
FacetItem, GeoFacetItem
public interface IFacetItem
Author:
Florian Alpers

  • Method Details

    • getQueryEscapedLink

      String getQueryEscapedLink()

    • getEscapedLink

      String getEscapedLink()

    • getUrlEscapedLink

      String getUrlEscapedLink()

    • getExcludeUrlEscapedLink

      String getExcludeUrlEscapedLink()
      Returns:
      the URL-encoded facet link prefixed with the exclusion marker, for building "exclude this value" links

    • getType

      FacetItem.FacetType getType()

    • getFacetQuery

      String getFacetQuery()
      Returns:
      for FacetItem.FacetType.QUERY items, the pre-built Solr query used as this facet's filter query; null otherwise

    • setFacetQuery

      void setFacetQuery(String facetQuery)
      Parameters:
      facetQuery - the pre-built Solr query to use as this facet's filter query (for FacetItem.FacetType.QUERY items)

    • getField

      String getField()

    • setField

      void setField(String field)

    • getFullValue

      String getFullValue()

    • getValue

      String getValue()

    • setValue

      void setValue(String value)

    • getValue2

      String getValue2()

    • setValue2

      void setValue2(String value2)

    • getLink

      String getLink()

    • setLink

      void setLink(String link)

    • getLabel

      String getLabel()

    • setLabel

      IFacetItem setLabel(String label)

    • getTranslatedLabel

      String getTranslatedLabel()

    • setTranslatedLabel

      void setTranslatedLabel(String translatedLabel)

    • getCount

      long getCount()

    • setCount

      IFacetItem setCount(long count)

    • isGroup

      boolean isGroup()

    • setGroup

      IFacetItem setGroup(boolean group)

    • isHierarchial

      boolean isHierarchial()

    • isBooleanType

      boolean isBooleanType()

    • isExcluded

      boolean isExcluded()
      Returns:
      true if this facet excludes (negates) matching documents instead of including them

    • setExcluded

      void setExcluded(boolean excluded)
      Parameters:
      excluded - true to make this facet exclude (negate) matching documents