Package com.broadleafcommerce.search.api.type

Enum Class DefaultRelevancyRuleTypes

java.lang.Object

java.lang.Enum<DefaultRelevancyRuleTypes>

com.broadleafcommerce.search.api.type.DefaultRelevancyRuleTypes

All Implemented Interfaces:

Serializable, Comparable<DefaultRelevancyRuleTypes>, Constable

public enum DefaultRelevancyRuleTypes
extends Enum<DefaultRelevancyRuleTypes>

Defines the default relevancy rule types for RelevancyRule.

Since:

Search Service 2.2.0, Release Train 2.2.0

Nested Class Summary

Nested classes/interfaces inherited from class java.lang.Enum

Enum.EnumDesc<E extends Enum<E>>

Enum Constant Summary

Enum Constants

Enum Constant	Description
MATCHING_QUERY	If the specified field should be boosted when matching the inputted query.
MATCHING_VALUE	If the given value for the specified field should boost the document.
ORDINAL	If the document should be boosted by the lexographical ordering of the field values.
RELATIVE	If the document should be boosted by the relative ordering of the field values.

Method Summary

Modifier and Type	Method	Description
static boolean	isMatchingQuery(String ruleType)
static boolean	isMatchingValue(String ruleType)
static boolean	isOrdinal(String ruleType)
static boolean	isRelative(String ruleType)
static DefaultRelevancyRuleTypes	valueOf(String name)	Returns the enum constant of this class with the specified name.
static DefaultRelevancyRuleTypes[]	values()	Returns an array containing the constants of this enum class, in the order they are declared.

Methods inherited from class java.lang.Enum

clone, compareTo, describeConstable, equals, finalize, getDeclaringClass, hashCode, name, ordinal, toString, valueOf

Methods inherited from class java.lang.Object

getClass, notify, notifyAll, wait, wait, wait

Enum Constant Details

MATCHING_QUERY

public static final DefaultRelevancyRuleTypes MATCHING_QUERY

If the specified field should be boosted when matching the inputted query.

MATCHING_VALUE

public static final DefaultRelevancyRuleTypes MATCHING_VALUE

If the given value for the specified field should boost the document.

RELATIVE

public static final DefaultRelevancyRuleTypes RELATIVE

If the document should be boosted by the relative ordering of the field values.

ORDINAL

public static final DefaultRelevancyRuleTypes ORDINAL

If the document should be boosted by the lexographical ordering of the field values.

Method Details

values

public static DefaultRelevancyRuleTypes[] values()

Returns an array containing the constants of this enum class, in the order they are declared.

Returns:

an array containing the constants of this enum class, in the order they are declared

valueOf

public static DefaultRelevancyRuleTypes valueOf(String name)

Returns the enum constant of this class with the specified name. The string must match exactly an identifier used to declare an enum constant in this class. (Extraneous whitespace characters are not permitted.)

Parameters:

name - the name of the enum constant to be returned.

Returns:

the enum constant with the specified name

Throws:

IllegalArgumentException - if this enum class has no constant with the specified name

NullPointerException - if the argument is null

isMatchingQuery

public static boolean isMatchingQuery(String ruleType)

isMatchingValue

public static boolean isMatchingValue(String ruleType)

isRelative

public static boolean isRelative(String ruleType)

isOrdinal

public static boolean isOrdinal(String ruleType)