Class AbstractAsFacetConfigurationModel

All Implemented Interfaces:
Serializable
Direct Known Subclasses:
AsExcludedFacetModel, AsFacetModel, AsPromotedFacetModel

public class AbstractAsFacetConfigurationModel extends AbstractAsItemConfigurationModel
Generated model class for type AbstractAsFacetConfiguration first defined at extension adaptivesearch.
See Also:
  • Field Details

    • _TYPECODE

      public static final String _TYPECODE
      Generated model type code constant.
      See Also:
    • INDEXPROPERTY

      public static final String INDEXPROPERTY
      Generated constant - Attribute key of AbstractAsFacetConfiguration.indexProperty attribute defined at extension adaptivesearch.
      See Also:
    • FACETTYPE

      public static final String FACETTYPE
      Generated constant - Attribute key of AbstractAsFacetConfiguration.facetType attribute defined at extension adaptivesearch.
      See Also:
    • NAME

      public static final String NAME
      Generated constant - Attribute key of AbstractAsFacetConfiguration.name attribute defined at extension adaptivesearch.
      See Also:
    • PRIORITY

      public static final String PRIORITY
      Generated constant - Attribute key of AbstractAsFacetConfiguration.priority attribute defined at extension adaptivesearch.
      See Also:
    • VALUESSORTPROVIDER

      public static final String VALUESSORTPROVIDER
      Generated constant - Attribute key of AbstractAsFacetConfiguration.valuesSortProvider attribute defined at extension adaptivesearch.
      See Also:
    • VALUESDISPLAYNAMEPROVIDER

      public static final String VALUESDISPLAYNAMEPROVIDER
      Generated constant - Attribute key of AbstractAsFacetConfiguration.valuesDisplayNameProvider attribute defined at extension adaptivesearch.
      See Also:
    • TOPVALUESPROVIDER

      public static final String TOPVALUESPROVIDER
      Generated constant - Attribute key of AbstractAsFacetConfiguration.topValuesProvider attribute defined at extension adaptivesearch.
      See Also:
    • TOPVALUESSIZE

      public static final String TOPVALUESSIZE
      Generated constant - Attribute key of AbstractAsFacetConfiguration.topValuesSize attribute defined at extension adaptivesearch.
      See Also:
    • SORT

      public static final String SORT
      Generated constant - Attribute key of AbstractAsFacetConfiguration.sort attribute defined at extension adaptivesearch.
      See Also:
    • RANGED

      public static final String RANGED
      Generated constant - Attribute key of AbstractAsFacetConfiguration.ranged attribute defined at extension adaptivesearch.
      See Also:
    • RANGEINCLUDEFROM

      public static final String RANGEINCLUDEFROM
      Generated constant - Attribute key of AbstractAsFacetConfiguration.rangeIncludeFrom attribute defined at extension adaptivesearch.
      See Also:
    • RANGEINCLUDETO

      public static final String RANGEINCLUDETO
      Generated constant - Attribute key of AbstractAsFacetConfiguration.rangeIncludeTo attribute defined at extension adaptivesearch.
      See Also:
    • UNIQUEIDX

      public static final String UNIQUEIDX
      Generated constant - Attribute key of AbstractAsFacetConfiguration.uniqueIdx attribute defined at extension adaptivesearch.
      See Also:
    • PROMOTEDVALUES

      public static final String PROMOTEDVALUES
      Generated constant - Attribute key of AbstractAsFacetConfiguration.promotedValues attribute defined at extension adaptivesearch.
      See Also:
    • RANGES

      public static final String RANGES
      Generated constant - Attribute key of AbstractAsFacetConfiguration.ranges attribute defined at extension adaptivesearch.
      See Also:
    • EXCLUDEDVALUES

      public static final String EXCLUDEDVALUES
      Generated constant - Attribute key of AbstractAsFacetConfiguration.excludedValues attribute defined at extension adaptivesearch.
      See Also:
  • Constructor Details

    • 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(String _indexProperty, String _uid, 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, String _indexProperty, ItemModel _owner, String _uid, 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 Details

    • getExcludedValues

      @Accessor(qualifier="excludedValues", type=GETTER) public 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 String getIndexProperty()
      Generated method - Getter of the AbstractAsFacetConfiguration.indexProperty attribute defined at extension adaptivesearch.
      Returns:
      the indexProperty
    • getName

      @Accessor(qualifier="name", type=GETTER) public String getName()
      Generated method - Getter of the AbstractAsFacetConfiguration.name attribute defined at extension adaptivesearch.
      Returns:
      the name
    • getName

      @Accessor(qualifier="name", type=GETTER) public String getName(Locale loc)
      Generated method - Getter of the AbstractAsFacetConfiguration.name attribute defined at extension adaptivesearch.
      Parameters:
      loc - the value localization key
      Returns:
      the name
      Throws:
      IllegalArgumentException - if localization key cannot be mapped to data language
    • getPriority

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

      @Accessor(qualifier="promotedValues", type=GETTER) public 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 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 String getSort()
      Generated method - Getter of the AbstractAsFacetConfiguration.sort attribute defined at extension adaptivesearch.
      Returns:
      the sort
    • getTopValuesProvider

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

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

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

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

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

      @Accessor(qualifier="corrupted", type=GETTER) public boolean isCorrupted()
      Generated method - Getter of the AbstractAsConfiguration.corrupted dynamic attribute defined at extension adaptivesearch and redeclared at extension adaptivesearch.
      Overrides:
      isCorrupted in class AbstractAsConfigurationModel
      Returns:
      the corrupted
    • 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(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(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
    • setName

      @Accessor(qualifier="name", type=SETTER) public void setName(String value)
      Generated method - Setter of AbstractAsFacetConfiguration.name attribute defined at extension adaptivesearch.
      Parameters:
      value - the name
    • setName

      @Accessor(qualifier="name", type=SETTER) public void setName(String value, Locale loc)
      Generated method - Setter of AbstractAsFacetConfiguration.name attribute defined at extension adaptivesearch.
      Parameters:
      value - the name
      loc - the value localization key
      Throws:
      IllegalArgumentException - if localization key cannot be mapped to data language
    • setPriority

      @Accessor(qualifier="priority", type=SETTER) public void setPriority(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(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(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(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(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(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(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(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(String value)
      Generated method - Setter of AbstractAsFacetConfiguration.valuesSortProvider attribute defined at extension adaptivesearch.
      Parameters:
      value - the valuesSortProvider