com.broadleafcommerce.search.domain

Class BoostRuleType

java.lang.Object

com.broadleafcommerce.search.domain.BoostRuleType

All Implemented Interfaces:

Serializable, Comparable<BoostRuleType>, org.broadleafcommerce.common.BroadleafEnumerationType

public class BoostRuleType
extends Object
implements Serializable, org.broadleafcommerce.common.BroadleafEnumerationType, Comparable<BoostRuleType>

An enumeration used for specifying the type of BoostRule

Author:

Nick Crum (ncrum)

See Also:

Serialized Form

Field Summary

Fields

Modifier and Type	Field and Description
static BoostRuleType	MATCHING_VALUE
static BoostRuleType	ORDINAL
static BoostRuleType	RELATIVE
static BoostRuleType	SEARCH_QUERY SEARCH_QUERY describes a rule that boosts queries on a keyword search MATCHING_VALUE describes a rule that boosts documents that match a value for a certain field RELATIVE describes a rule that boosts a document based on the numeric, relative value of a certain field ORDINAL describes a rule that boosts a document based on the ordinal value of a certain field

Constructor Summary

Constructors

Constructor and Description
BoostRuleType()
BoostRuleType(String type, String friendlyType, int order)

Method Summary

Modifier and Type	Method and Description
int	compareTo(BoostRuleType o)
boolean	equals(Object obj)
String	getFriendlyType()
static BoostRuleType	getInstance(String type)
int	getOrder()
String	getType()
int	hashCode()
void	setOrder(int order)

Methods inherited from class java.lang.Object

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

Field Detail

SEARCH_QUERY

public static final BoostRuleType SEARCH_QUERY

SEARCH_QUERY describes a rule that boosts queries on a keyword search MATCHING_VALUE describes a rule that boosts documents that match a value for a certain field RELATIVE describes a rule that boosts a document based on the numeric, relative value of a certain field ORDINAL describes a rule that boosts a document based on the ordinal value of a certain field

MATCHING_VALUE

public static final BoostRuleType MATCHING_VALUE

RELATIVE

public static final BoostRuleType RELATIVE

ORDINAL

public static final BoostRuleType ORDINAL

Constructor Detail

BoostRuleType

public BoostRuleType()

BoostRuleType

public BoostRuleType(String type,
                     String friendlyType,
                     int order)

Method Detail

getInstance

public static BoostRuleType getInstance(String type)

getType

public String getType()

Specified by:

getType in interface org.broadleafcommerce.common.BroadleafEnumerationType

getFriendlyType

public String getFriendlyType()

Specified by:

getFriendlyType in interface org.broadleafcommerce.common.BroadleafEnumerationType

getOrder

public int getOrder()

setOrder

public void setOrder(int order)

hashCode

public int hashCode()

Overrides:

hashCode in class Object

equals

public boolean equals(Object obj)

Overrides:

equals in class Object

compareTo

public int compareTo(BoostRuleType o)

Specified by:

compareTo in interface Comparable<BoostRuleType>