com.broadleafcommerce.search.domain

Interface BoostRule

All Superinterfaces:

Serializable

All Known Subinterfaces:

CategoryBoostRule, GlobalBoostRule

All Known Implementing Classes:

CategoryBoostRuleImpl, GlobalBoostRuleImpl

public interface BoostRule
extends Serializable

Author:

Nick Crum (ncrum)

Method Summary

Modifier and Type	Method and Description
Date	getActiveEndDate()
Date	getActiveStartDate()
BigDecimal	getBoost()
Boolean	getDescending() This flag decides whether or not a RELATIVE/ORDINAL BoostRule boosts results by highest or lowest value Only set for BoostRuleType.RELATIVE/ORDINAL
Long	getId()
org.broadleafcommerce.core.search.domain.IndexFieldType	getIndexFieldType()
String	getMatchValue() This value is used by MATCHING_VALUE BoostRule to get the matching value for this SearchFieldType in the boost query.
BigDecimal	getMinimumScore() This returns the minimum possible score for this boost rule.
String	getName() This returns the name that describes this rule.
String	getSearchTermQualifierRegex()
BoostRuleType	getType() This determines how we apply this BoostRule.
boolean	isActive()
void	setActiveEndDate(Date activeEndDate)
void	setActiveStartDate(Date activeStartDate)
void	setBoost(BigDecimal boost)
void	setDescending(Boolean descending)
void	setId(Long id)
void	setIndexFieldType(org.broadleafcommerce.core.search.domain.IndexFieldType indexFieldType)
void	setMatchValue(String matchValue)
void	setMinimumScore(BigDecimal minimumScore)
void	setName(String name)
void	setSearchTermQualifierRegex(String searchTermQualifierRegex)
void	setType(BoostRuleType type)

Method Detail

getId

Long getId()

setId

void setId(Long id)

getBoost

BigDecimal getBoost()

setBoost

void setBoost(BigDecimal boost)

getMinimumScore

BigDecimal getMinimumScore()

This returns the minimum possible score for this boost rule. This ONLY applies to MATCHING, ORDINAL, and RELATIVE boost rule types. This wraps the value expression passed to the boost parameter in the Solr query with a max(). The result is that the value given to the boost parameter will never be less than this value.

Returns:

the minimum value for this rule

setMinimumScore

void setMinimumScore(BigDecimal minimumScore)

getName

String getName()

This returns the name that describes this rule.

Returns:

a String name for this rule

setName

void setName(String name)

getIndexFieldType

org.broadleafcommerce.core.search.domain.IndexFieldType getIndexFieldType()

setIndexFieldType

void setIndexFieldType(org.broadleafcommerce.core.search.domain.IndexFieldType indexFieldType)

getType

BoostRuleType getType()

This determines how we apply this BoostRule. Defaults to SEARCH_QUERY

Returns:

BoostRuleType of SEARCH_QUERY, MATCHING_VALUE, RELATIVE, or ORDINAL

setType

void setType(BoostRuleType type)

getMatchValue

String getMatchValue()

This value is used by MATCHING_VALUE BoostRule to get the matching value for this SearchFieldType in the boost query. Only set for BoostRuleType.MATCHING_VALUE

Returns:

the matchValue for this BoostRule

setMatchValue

void setMatchValue(String matchValue)

getDescending

Boolean getDescending()

This flag decides whether or not a RELATIVE/ORDINAL BoostRule boosts results by highest or lowest value Only set for BoostRuleType.RELATIVE/ORDINAL

Returns:

whether this is descending or not, false by default

setDescending

void setDescending(Boolean descending)

getActiveStartDate

Date getActiveStartDate()

setActiveStartDate

void setActiveStartDate(Date activeStartDate)

getActiveEndDate

Date getActiveEndDate()

setActiveEndDate

void setActiveEndDate(Date activeEndDate)

isActive

boolean isActive()

getSearchTermQualifierRegex

String getSearchTermQualifierRegex()

setSearchTermQualifierRegex

void setSearchTermQualifierRegex(String searchTermQualifierRegex)