Package de.hybris.platform.adaptivesearch.model

Class AbstractAsFacetConfigurationModel

    • Field Summary

      Fields 
      Modifier and Type Field Description
      static java.lang.String _TYPECODE
      Generated model type code constant.
      static java.lang.String EXCLUDEDVALUES
      Generated constant - Attribute key of AbstractAsFacetConfiguration.excludedValues attribute defined at extension adaptivesearch.
      static java.lang.String FACETTYPE
      Generated constant - Attribute key of AbstractAsFacetConfiguration.facetType attribute defined at extension adaptivesearch.
      static java.lang.String INDEXPROPERTY
      Generated constant - Attribute key of AbstractAsFacetConfiguration.indexProperty attribute defined at extension adaptivesearch.
      static java.lang.String PRIORITY
      Generated constant - Attribute key of AbstractAsFacetConfiguration.priority attribute defined at extension adaptivesearch.
      static java.lang.String PROMOTEDVALUES
      Generated constant - Attribute key of AbstractAsFacetConfiguration.promotedValues attribute defined at extension adaptivesearch.
      static java.lang.String RANGED
      Generated constant - Attribute key of AbstractAsFacetConfiguration.ranged attribute defined at extension adaptivesearch.
      static java.lang.String RANGEINCLUDEFROM
      Generated constant - Attribute key of AbstractAsFacetConfiguration.rangeIncludeFrom attribute defined at extension adaptivesearch.
      static java.lang.String RANGEINCLUDETO
      Generated constant - Attribute key of AbstractAsFacetConfiguration.rangeIncludeTo attribute defined at extension adaptivesearch.
      static java.lang.String RANGES
      Generated constant - Attribute key of AbstractAsFacetConfiguration.ranges attribute defined at extension adaptivesearch.
      static java.lang.String SORT
      Generated constant - Attribute key of AbstractAsFacetConfiguration.sort attribute defined at extension adaptivesearch.
      static java.lang.String TOPVALUESPROVIDER
      Generated constant - Attribute key of AbstractAsFacetConfiguration.topValuesProvider attribute defined at extension adaptivesearch.
      static java.lang.String TOPVALUESSIZE
      Generated constant - Attribute key of AbstractAsFacetConfiguration.topValuesSize attribute defined at extension adaptivesearch.
      static java.lang.String UNIQUEIDX
      Generated constant - Attribute key of AbstractAsFacetConfiguration.uniqueIdx attribute defined at extension adaptivesearch.
      static java.lang.String VALUESDISPLAYNAMEPROVIDER
      Generated constant - Attribute key of AbstractAsFacetConfiguration.valuesDisplayNameProvider attribute defined at extension adaptivesearch.
      static java.lang.String VALUESSORTPROVIDER
      Generated constant - Attribute key of AbstractAsFacetConfiguration.valuesSortProvider attribute defined at extension adaptivesearch.

    • Constructor Summary

      Constructors 
      Constructor Description
      AbstractAsFacetConfigurationModel()
      Generated constructor - Default constructor for generic creation.
      AbstractAsFacetConfigurationModel​(CatalogVersionModel _catalogVersion, java.lang.String _indexProperty, ItemModel _owner, java.lang.String _uid, java.lang.String _uniqueIdx)
      Deprecated, for removal: This API element is subject to removal in a future version.
      since 4.1.1 Please use the default constructor without parameters
      AbstractAsFacetConfigurationModel​(ItemModelContext ctx)
      Generated constructor - Default constructor for creation with existing context
      AbstractAsFacetConfigurationModel​(java.lang.String _indexProperty, java.lang.String _uid, java.lang.String _uniqueIdx)
      Deprecated, for removal: This API element is subject to removal in a future version.
      since 4.1.1 Please use the default constructor without parameters

    • Method Summary

      All Methods Instance Methods Concrete Methods 
      Modifier and Type Method Description
      java.util.List<AsExcludedFacetValueModel> getExcludedValues()
      Generated method - Getter of the AbstractAsFacetConfiguration.excludedValues attribute defined at extension adaptivesearch.
      AsFacetType getFacetType()
      Generated method - Getter of the AbstractAsFacetConfiguration.facetType attribute defined at extension adaptivesearch.
      java.lang.String getIndexProperty()
      Generated method - Getter of the AbstractAsFacetConfiguration.indexProperty attribute defined at extension adaptivesearch.
      java.lang.Integer getPriority()
      Generated method - Getter of the AbstractAsFacetConfiguration.priority attribute defined at extension adaptivesearch.
      java.util.List<AsPromotedFacetValueModel> getPromotedValues()
      Generated method - Getter of the AbstractAsFacetConfiguration.promotedValues attribute defined at extension adaptivesearch.
      java.util.List<AsFacetRangeModel> getRanges()
      Generated method - Getter of the AbstractAsFacetConfiguration.ranges attribute defined at extension adaptivesearch.
      java.lang.String getSort()
      Generated method - Getter of the AbstractAsFacetConfiguration.sort attribute defined at extension adaptivesearch.
      java.lang.String getTopValuesProvider()
      Generated method - Getter of the AbstractAsFacetConfiguration.topValuesProvider attribute defined at extension adaptivesearch.
      java.lang.Integer getTopValuesSize()
      Generated method - Getter of the AbstractAsFacetConfiguration.topValuesSize attribute defined at extension adaptivesearch.
      java.lang.String getUniqueIdx()
      Generated method - Getter of the AbstractAsFacetConfiguration.uniqueIdx attribute defined at extension adaptivesearch.
      java.lang.String getValuesDisplayNameProvider()
      Generated method - Getter of the AbstractAsFacetConfiguration.valuesDisplayNameProvider attribute defined at extension adaptivesearch.
      java.lang.String getValuesSortProvider()
      Generated method - Getter of the AbstractAsFacetConfiguration.valuesSortProvider attribute defined at extension adaptivesearch.
      boolean isRanged()
      Generated method - Getter of the AbstractAsFacetConfiguration.ranged attribute defined at extension adaptivesearch.
      boolean isRangeIncludeFrom()
      Generated method - Getter of the AbstractAsFacetConfiguration.rangeIncludeFrom attribute defined at extension adaptivesearch.
      boolean isRangeIncludeTo()
      Generated method - Getter of the AbstractAsFacetConfiguration.rangeIncludeTo attribute defined at extension adaptivesearch.
      void setExcludedValues​(java.util.List<AsExcludedFacetValueModel> value)
      Generated method - Setter of AbstractAsFacetConfiguration.excludedValues attribute defined at extension adaptivesearch.
      void setFacetType​(AsFacetType value)
      Generated method - Setter of AbstractAsFacetConfiguration.facetType attribute defined at extension adaptivesearch.
      void setIndexProperty​(java.lang.String value)
      Generated method - Initial setter of AbstractAsFacetConfiguration.indexProperty attribute defined at extension adaptivesearch.
      void setPriority​(java.lang.Integer value)
      Generated method - Setter of AbstractAsFacetConfiguration.priority attribute defined at extension adaptivesearch.
      void setPromotedValues​(java.util.List<AsPromotedFacetValueModel> value)
      Generated method - Setter of AbstractAsFacetConfiguration.promotedValues attribute defined at extension adaptivesearch.
      void setRanged​(boolean value)
      Generated method - Setter of AbstractAsFacetConfiguration.ranged attribute defined at extension adaptivesearch.
      void setRangeIncludeFrom​(boolean value)
      Generated method - Setter of AbstractAsFacetConfiguration.rangeIncludeFrom attribute defined at extension adaptivesearch.
      void setRangeIncludeTo​(boolean value)
      Generated method - Setter of AbstractAsFacetConfiguration.rangeIncludeTo attribute defined at extension adaptivesearch.
      void setRanges​(java.util.List<AsFacetRangeModel> value)
      Generated method - Setter of AbstractAsFacetConfiguration.ranges attribute defined at extension adaptivesearch.
      void setSort​(java.lang.String value)
      Generated method - Setter of AbstractAsFacetConfiguration.sort attribute defined at extension adaptivesearch.
      void setTopValuesProvider​(java.lang.String value)
      Generated method - Setter of AbstractAsFacetConfiguration.topValuesProvider attribute defined at extension adaptivesearch.
      void setTopValuesSize​(java.lang.Integer value)
      Generated method - Setter of AbstractAsFacetConfiguration.topValuesSize attribute defined at extension adaptivesearch.
      void setUniqueIdx​(java.lang.String value)
      Generated method - Setter of AbstractAsFacetConfiguration.uniqueIdx attribute defined at extension adaptivesearch.
      void setValuesDisplayNameProvider​(java.lang.String value)
      Generated method - Setter of AbstractAsFacetConfiguration.valuesDisplayNameProvider attribute defined at extension adaptivesearch.
      void setValuesSortProvider​(java.lang.String value)
      Generated method - Setter of AbstractAsFacetConfiguration.valuesSortProvider attribute defined at extension adaptivesearch.

      • Methods inherited from class java.lang.Object

        clone, finalize, getClass, notify, notifyAll, wait, wait, wait

    • Field Detail

      • _TYPECODE

        public static final java.lang.String _TYPECODE
        Generated model type code constant.
        See Also:
        Constant Field Values

      • INDEXPROPERTY

        public static final java.lang.String INDEXPROPERTY
        Generated constant - Attribute key of AbstractAsFacetConfiguration.indexProperty attribute defined at extension adaptivesearch.
        See Also:
        Constant Field Values

      • FACETTYPE

        public static final java.lang.String FACETTYPE
        Generated constant - Attribute key of AbstractAsFacetConfiguration.facetType attribute defined at extension adaptivesearch.
        See Also:
        Constant Field Values

      • PRIORITY

        public static final java.lang.String PRIORITY
        Generated constant - Attribute key of AbstractAsFacetConfiguration.priority attribute defined at extension adaptivesearch.
        See Also:
        Constant Field Values

      • VALUESSORTPROVIDER

        public static final java.lang.String VALUESSORTPROVIDER
        Generated constant - Attribute key of AbstractAsFacetConfiguration.valuesSortProvider attribute defined at extension adaptivesearch.
        See Also:
        Constant Field Values

      • VALUESDISPLAYNAMEPROVIDER

        public static final java.lang.String VALUESDISPLAYNAMEPROVIDER
        Generated constant - Attribute key of AbstractAsFacetConfiguration.valuesDisplayNameProvider attribute defined at extension adaptivesearch.
        See Also:
        Constant Field Values

      • TOPVALUESPROVIDER

        public static final java.lang.String TOPVALUESPROVIDER
        Generated constant - Attribute key of AbstractAsFacetConfiguration.topValuesProvider attribute defined at extension adaptivesearch.
        See Also:
        Constant Field Values

      • TOPVALUESSIZE

        public static final java.lang.String TOPVALUESSIZE
        Generated constant - Attribute key of AbstractAsFacetConfiguration.topValuesSize attribute defined at extension adaptivesearch.
        See Also:
        Constant Field Values

      • SORT

        public static final java.lang.String SORT
        Generated constant - Attribute key of AbstractAsFacetConfiguration.sort attribute defined at extension adaptivesearch.
        See Also:
        Constant Field Values

      • RANGED

        public static final java.lang.String RANGED
        Generated constant - Attribute key of AbstractAsFacetConfiguration.ranged attribute defined at extension adaptivesearch.
        See Also:
        Constant Field Values

      • RANGEINCLUDEFROM

        public static final java.lang.String RANGEINCLUDEFROM
        Generated constant - Attribute key of AbstractAsFacetConfiguration.rangeIncludeFrom attribute defined at extension adaptivesearch.
        See Also:
        Constant Field Values

      • RANGEINCLUDETO

        public static final java.lang.String RANGEINCLUDETO
        Generated constant - Attribute key of AbstractAsFacetConfiguration.rangeIncludeTo attribute defined at extension adaptivesearch.
        See Also:
        Constant Field Values

      • UNIQUEIDX

        public static final java.lang.String UNIQUEIDX
        Generated constant - Attribute key of AbstractAsFacetConfiguration.uniqueIdx attribute defined at extension adaptivesearch.
        See Also:
        Constant Field Values

      • PROMOTEDVALUES

        public static final java.lang.String PROMOTEDVALUES
        Generated constant - Attribute key of AbstractAsFacetConfiguration.promotedValues attribute defined at extension adaptivesearch.
        See Also:
        Constant Field Values

      • RANGES

        public static final java.lang.String RANGES
        Generated constant - Attribute key of AbstractAsFacetConfiguration.ranges attribute defined at extension adaptivesearch.
        See Also:
        Constant Field Values

      • EXCLUDEDVALUES

        public static final java.lang.String EXCLUDEDVALUES
        Generated constant - Attribute key of AbstractAsFacetConfiguration.excludedValues attribute defined at extension adaptivesearch.
        See Also:
        Constant Field Values

    • Constructor Detail

      • AbstractAsFacetConfigurationModel

        public AbstractAsFacetConfigurationModel()
        Generated constructor - Default constructor for generic creation.

      • AbstractAsFacetConfigurationModel

        public AbstractAsFacetConfigurationModel​(ItemModelContext ctx)
        Generated constructor - Default constructor for creation with existing context
        Parameters:
        ctx - the model context to be injected, must not be null

      • AbstractAsFacetConfigurationModel

        @Deprecated(since="4.1.1",
            forRemoval=true)
public AbstractAsFacetConfigurationModel​(java.lang.String _indexProperty,
                                         java.lang.String _uid,
                                         java.lang.String _uniqueIdx)
        Deprecated, for removal: This API element is subject to removal in a future version.
        since 4.1.1 Please use the default constructor without parameters
        Generated constructor - Constructor with all mandatory attributes.
        Parameters:
        _indexProperty - initial attribute declared by type AbstractAsFacetConfiguration at extension adaptivesearch
        _uid - initial attribute declared by type AbstractAsConfiguration at extension adaptivesearch
        _uniqueIdx - initial attribute declared by type AbstractAsFacetConfiguration at extension adaptivesearch

      • AbstractAsFacetConfigurationModel

        @Deprecated(since="4.1.1",
            forRemoval=true)
public AbstractAsFacetConfigurationModel​(CatalogVersionModel _catalogVersion,
                                         java.lang.String _indexProperty,
                                         ItemModel _owner,
                                         java.lang.String _uid,
                                         java.lang.String _uniqueIdx)
        Deprecated, for removal: This API element is subject to removal in a future version.
        since 4.1.1 Please use the default constructor without parameters
        Generated constructor - for all mandatory and initial attributes.
        Parameters:
        _catalogVersion - initial attribute declared by type AbstractAsConfiguration at extension adaptivesearch
        _indexProperty - initial attribute declared by type AbstractAsFacetConfiguration at extension adaptivesearch
        _owner - initial attribute declared by type Item at extension core
        _uid - initial attribute declared by type AbstractAsConfiguration at extension adaptivesearch
        _uniqueIdx - initial attribute declared by type AbstractAsFacetConfiguration at extension adaptivesearch

    • Method Detail

      • getExcludedValues

        @Accessor(qualifier="excludedValues",
          type=GETTER)
public java.util.List<AsExcludedFacetValueModel> getExcludedValues()
        Generated method - Getter of the AbstractAsFacetConfiguration.excludedValues attribute defined at extension adaptivesearch. Consider using FlexibleSearchService::searchRelation for pagination support of large result sets.
        Returns:
        the excludedValues

      • getFacetType

        @Accessor(qualifier="facetType",
          type=GETTER)
public AsFacetType getFacetType()
        Generated method - Getter of the AbstractAsFacetConfiguration.facetType attribute defined at extension adaptivesearch.
        Returns:
        the facetType

      • getIndexProperty

        @Accessor(qualifier="indexProperty",
          type=GETTER)
public java.lang.String getIndexProperty()
        Generated method - Getter of the AbstractAsFacetConfiguration.indexProperty attribute defined at extension adaptivesearch.
        Returns:
        the indexProperty

      • getPriority

        @Accessor(qualifier="priority",
          type=GETTER)
public java.lang.Integer getPriority()
        Generated method - Getter of the AbstractAsFacetConfiguration.priority attribute defined at extension adaptivesearch.
        Returns:
        the priority

      • getPromotedValues

        @Accessor(qualifier="promotedValues",
          type=GETTER)
public java.util.List<AsPromotedFacetValueModel> getPromotedValues()
        Generated method - Getter of the AbstractAsFacetConfiguration.promotedValues attribute defined at extension adaptivesearch. Consider using FlexibleSearchService::searchRelation for pagination support of large result sets.
        Returns:
        the promotedValues

      • getRanges

        @Accessor(qualifier="ranges",
          type=GETTER)
public java.util.List<AsFacetRangeModel> getRanges()
        Generated method - Getter of the AbstractAsFacetConfiguration.ranges attribute defined at extension adaptivesearch. Consider using FlexibleSearchService::searchRelation for pagination support of large result sets.
        Returns:
        the ranges

      • getSort

        @Accessor(qualifier="sort",
          type=GETTER)
public java.lang.String getSort()
        Generated method - Getter of the AbstractAsFacetConfiguration.sort attribute defined at extension adaptivesearch.
        Returns:
        the sort

      • getTopValuesProvider

        @Accessor(qualifier="topValuesProvider",
          type=GETTER)
public java.lang.String getTopValuesProvider()
        Generated method - Getter of the AbstractAsFacetConfiguration.topValuesProvider attribute defined at extension adaptivesearch.
        Returns:
        the topValuesProvider

      • getTopValuesSize

        @Accessor(qualifier="topValuesSize",
          type=GETTER)
public java.lang.Integer getTopValuesSize()
        Generated method - Getter of the AbstractAsFacetConfiguration.topValuesSize attribute defined at extension adaptivesearch.
        Returns:
        the topValuesSize

      • getUniqueIdx

        @Accessor(qualifier="uniqueIdx",
          type=GETTER)
public java.lang.String getUniqueIdx()
        Generated method - Getter of the AbstractAsFacetConfiguration.uniqueIdx attribute defined at extension adaptivesearch.
        Returns:
        the uniqueIdx

      • getValuesDisplayNameProvider

        @Accessor(qualifier="valuesDisplayNameProvider",
          type=GETTER)
public java.lang.String getValuesDisplayNameProvider()
        Generated method - Getter of the AbstractAsFacetConfiguration.valuesDisplayNameProvider attribute defined at extension adaptivesearch.
        Returns:
        the valuesDisplayNameProvider

      • getValuesSortProvider

        @Accessor(qualifier="valuesSortProvider",
          type=GETTER)
public java.lang.String getValuesSortProvider()
        Generated method - Getter of the AbstractAsFacetConfiguration.valuesSortProvider attribute defined at extension adaptivesearch.
        Returns:
        the valuesSortProvider

      • isRanged

        @Accessor(qualifier="ranged",
          type=GETTER)
public boolean isRanged()
        Generated method - Getter of the AbstractAsFacetConfiguration.ranged attribute defined at extension adaptivesearch.
        Returns:
        the ranged

      • isRangeIncludeFrom

        @Accessor(qualifier="rangeIncludeFrom",
          type=GETTER)
public boolean isRangeIncludeFrom()
        Generated method - Getter of the AbstractAsFacetConfiguration.rangeIncludeFrom attribute defined at extension adaptivesearch.
        Returns:
        the rangeIncludeFrom

      • isRangeIncludeTo

        @Accessor(qualifier="rangeIncludeTo",
          type=GETTER)
public boolean isRangeIncludeTo()
        Generated method - Getter of the AbstractAsFacetConfiguration.rangeIncludeTo attribute defined at extension adaptivesearch.
        Returns:
        the rangeIncludeTo

      • setExcludedValues

        @Accessor(qualifier="excludedValues",
          type=SETTER)
public void setExcludedValues​(java.util.List<AsExcludedFacetValueModel> value)
        Generated method - Setter of AbstractAsFacetConfiguration.excludedValues attribute defined at extension adaptivesearch.
        Parameters:
        value - the excludedValues

      • setFacetType

        @Accessor(qualifier="facetType",
          type=SETTER)
public void setFacetType​(AsFacetType value)
        Generated method - Setter of AbstractAsFacetConfiguration.facetType attribute defined at extension adaptivesearch.
        Parameters:
        value - the facetType

      • setIndexProperty

        @Accessor(qualifier="indexProperty",
          type=SETTER)
public void setIndexProperty​(java.lang.String value)
        Generated method - Initial setter of AbstractAsFacetConfiguration.indexProperty attribute defined at extension adaptivesearch. Can only be used at creation of model - before first save.
        Parameters:
        value - the indexProperty

      • setPriority

        @Accessor(qualifier="priority",
          type=SETTER)
public void setPriority​(java.lang.Integer value)
        Generated method - Setter of AbstractAsFacetConfiguration.priority attribute defined at extension adaptivesearch.
        Parameters:
        value - the priority

      • setPromotedValues

        @Accessor(qualifier="promotedValues",
          type=SETTER)
public void setPromotedValues​(java.util.List<AsPromotedFacetValueModel> value)
        Generated method - Setter of AbstractAsFacetConfiguration.promotedValues attribute defined at extension adaptivesearch.
        Parameters:
        value - the promotedValues

      • setRanged

        @Accessor(qualifier="ranged",
          type=SETTER)
public void setRanged​(boolean value)
        Generated method - Setter of AbstractAsFacetConfiguration.ranged attribute defined at extension adaptivesearch.
        Parameters:
        value - the ranged

      • setRangeIncludeFrom

        @Accessor(qualifier="rangeIncludeFrom",
          type=SETTER)
public void setRangeIncludeFrom​(boolean value)
        Generated method - Setter of AbstractAsFacetConfiguration.rangeIncludeFrom attribute defined at extension adaptivesearch.
        Parameters:
        value - the rangeIncludeFrom

      • setRangeIncludeTo

        @Accessor(qualifier="rangeIncludeTo",
          type=SETTER)
public void setRangeIncludeTo​(boolean value)
        Generated method - Setter of AbstractAsFacetConfiguration.rangeIncludeTo attribute defined at extension adaptivesearch.
        Parameters:
        value - the rangeIncludeTo

      • setRanges

        @Accessor(qualifier="ranges",
          type=SETTER)
public void setRanges​(java.util.List<AsFacetRangeModel> value)
        Generated method - Setter of AbstractAsFacetConfiguration.ranges attribute defined at extension adaptivesearch.
        Parameters:
        value - the ranges

      • setSort

        @Accessor(qualifier="sort",
          type=SETTER)
public void setSort​(java.lang.String value)
        Generated method - Setter of AbstractAsFacetConfiguration.sort attribute defined at extension adaptivesearch.
        Parameters:
        value - the sort

      • setTopValuesProvider

        @Accessor(qualifier="topValuesProvider",
          type=SETTER)
public void setTopValuesProvider​(java.lang.String value)
        Generated method - Setter of AbstractAsFacetConfiguration.topValuesProvider attribute defined at extension adaptivesearch.
        Parameters:
        value - the topValuesProvider

      • setTopValuesSize

        @Accessor(qualifier="topValuesSize",
          type=SETTER)
public void setTopValuesSize​(java.lang.Integer value)
        Generated method - Setter of AbstractAsFacetConfiguration.topValuesSize attribute defined at extension adaptivesearch.
        Parameters:
        value - the topValuesSize

      • setUniqueIdx

        @Accessor(qualifier="uniqueIdx",
          type=SETTER)
public void setUniqueIdx​(java.lang.String value)
        Generated method - Setter of AbstractAsFacetConfiguration.uniqueIdx attribute defined at extension adaptivesearch.
        Parameters:
        value - the uniqueIdx

      • setValuesDisplayNameProvider

        @Accessor(qualifier="valuesDisplayNameProvider",
          type=SETTER)
public void setValuesDisplayNameProvider​(java.lang.String value)
        Generated method - Setter of AbstractAsFacetConfiguration.valuesDisplayNameProvider attribute defined at extension adaptivesearch.
        Parameters:
        value - the valuesDisplayNameProvider

      • setValuesSortProvider

        @Accessor(qualifier="valuesSortProvider",
          type=SETTER)
public void setValuesSortProvider​(java.lang.String value)
        Generated method - Setter of AbstractAsFacetConfiguration.valuesSortProvider attribute defined at extension adaptivesearch.
        Parameters:
        value - the valuesSortProvider