Package com.funnelback.publicui.search.model.transaction

Class Facet.CategoryValue

  • Enclosing class:
    Facet
    public static class Facet.CategoryValue
extends java.lang.Object

    Value of a facet category, such as "Location = Sydney".

    Is either automatically generated (fill type CategoryDefinition or manually created (item type CategoryDefinition

    • Field Summary

      Fields 
      Modifier and Type Field Description
      private int categoryDepth
      The depth of the category definition, used for sorting.
      private java.lang.String constraint
      Constraint used to get this value.
      private java.lang.Integer count
      Count of occurrences for this value
      private java.lang.String data
      Actual value of the category (Ex: "Sydney").
      private java.lang.String label
      Label of the value, usually the same as the data.
      private java.lang.String queryStringParam
      Query String parameters to use to select this value (Ex: f.Location|X=Sydney).
      private java.lang.String queryStringParamName
      Name of the query string parameter for this value (e.g.
      private java.lang.String queryStringParamValue
      Value of the query string parameter for this value (e.g.
      private boolean selected
      Indicates if this value is currently selected
      private java.lang.String toggleUrl
      URL to use to toggle the select status of the facet value.

    • Constructor Summary

      Constructors 
      Constructor Description
      CategoryValue​(java.lang.String data, java.lang.String label, java.lang.Integer count, java.lang.String queryStringParam, java.lang.String constraint, boolean selected)
      Deprecated.
      CategoryValue​(java.lang.String data, java.lang.String label, java.lang.Integer count, java.lang.String queryStringParam, java.lang.String constraint, boolean selected, java.lang.String queryStringParamName, java.lang.String queryStringParamValue)  
      CategoryValue​(java.lang.String data, java.lang.String label, java.lang.Integer count, java.lang.String queryStringParam, java.lang.String constraint, boolean selected, java.lang.String queryStringParamName, java.lang.String queryStringParamValue, java.lang.String toggleUrl, int categoryDepth)  

    • Field Detail

      • data

        private java.lang.String data
        Actual value of the category (Ex: "Sydney").

      • label

        private java.lang.String label
        Label of the value, usually the same as the data.

      • count

        private java.lang.Integer count
        Count of occurrences for this value

      • queryStringParam

        private java.lang.String queryStringParam
        Query String parameters to use to select this value (Ex: f.Location|X=Sydney).

      • constraint

        private java.lang.String constraint
        Constraint used to get this value. Can be a metadata class or a GScope number, depending of the facet type.
        Since:
        11.2

      • selected

        private boolean selected
        Indicates if this value is currently selected
        Since:
        15.8

      • queryStringParamName

        private java.lang.String queryStringParamName
        Name of the query string parameter for this value (e.g. f.Location|X)

      • queryStringParamValue

        private java.lang.String queryStringParamValue
        Value of the query string parameter for this value (e.g. Syndey)

      • toggleUrl

        private java.lang.String toggleUrl
        URL to use to toggle the select status of the facet value.

      • categoryDepth

        private int categoryDepth
        The depth of the category definition, used for sorting.
        Since:
        15.12

    • Constructor Detail

      • CategoryValue

        @Deprecated
public CategoryValue​(java.lang.String data,
                     java.lang.String label,
                     java.lang.Integer count,
                     java.lang.String queryStringParam,
                     java.lang.String constraint,
                     boolean selected)
        Deprecated.
        Backwards compatible constructor where not all fields are set, may result in problems.
        Parameters:
        data -
        label -
        count -
        queryStringParam -
        constraint -
        selected -

      • CategoryValue

        public CategoryValue​(java.lang.String data,
                     java.lang.String label,
                     java.lang.Integer count,
                     java.lang.String queryStringParam,
                     java.lang.String constraint,
                     boolean selected,
                     java.lang.String queryStringParamName,
                     java.lang.String queryStringParamValue)

      • CategoryValue

        public CategoryValue​(java.lang.String data,
                     java.lang.String label,
                     java.lang.Integer count,
                     java.lang.String queryStringParam,
                     java.lang.String constraint,
                     boolean selected,
                     java.lang.String queryStringParamName,
                     java.lang.String queryStringParamValue,
                     java.lang.String toggleUrl,
                     int categoryDepth)

    • Method Detail

      • toString

        public java.lang.String toString()
        Overrides:
        toString in class java.lang.Object

      • getData

        public java.lang.String getData()

      • setData

        public void setData​(java.lang.String data)

      • getLabel

        public java.lang.String getLabel()

      • setLabel

        public void setLabel​(java.lang.String label)

      • getCount

        public java.lang.Integer getCount()

      • setCount

        public void setCount​(java.lang.Integer count)

      • getQueryStringParam

        public java.lang.String getQueryStringParam()

      • setQueryStringParam

        public void setQueryStringParam​(java.lang.String queryStringParam)

      • getConstraint

        public java.lang.String getConstraint()

      • setConstraint

        public void setConstraint​(java.lang.String constraint)

      • isSelected

        public boolean isSelected()

      • setSelected

        public void setSelected​(boolean selected)

      • getQueryStringParamName

        public java.lang.String getQueryStringParamName()

      • setQueryStringParamName

        public void setQueryStringParamName​(java.lang.String queryStringParamName)

      • getQueryStringParamValue

        public java.lang.String getQueryStringParamValue()

      • setQueryStringParamValue

        public void setQueryStringParamValue​(java.lang.String queryStringParamValue)

      • getToggleUrl

        public java.lang.String getToggleUrl()

      • setToggleUrl

        public void setToggleUrl​(java.lang.String toggleUrl)

      • getCategoryDepth

        public int getCategoryDepth()

      • setCategoryDepth

        public void setCategoryDepth​(int categoryDepth)