com.endeca.navigation
Class ERecRank

java.lang.Object
  com.endeca.navigation.ERecRank

public class ERecRank
extends Object

Class representing a relevance ranking on a navigation record set. A record search is composed of four elements:

• a search key, which is the name of an Endeca property or dimension (if enabled for record search) or an Endeca search interface. The search key indicates which field of the records to search the terms against.
• terms, which are the strings that are being searched, such as "raspberry flavor" (which may be a quoted phrase).
• ranking strategies, which will be used to rank the records
• an optional match mode, which will be used to determine which terms will be required in order to rank a record.

Constructor Summary

ERecRank()
Default constructor that creates an empty ERecSearch object.

ERecRank(String key, String terms, String strategy)
Constructor specifying the key and the terms of the search.

ERecRank(String key, String terms, String strategy, String matchmode)
Constructor specifying the key, terms, and options of the search.

Method Summary

boolean	equals(Object other)
String	getKey() Accessor that returns the key of this ERecRank.
String	getMatchMode() Accessor that returns the match mode of this ERecRank.
String	getStrategy() Accessor that returns the strategy of this ERecRank.
String	getTerms() Accessor that returns the terms of this ERecRank.
int	hashCode()
String	toString()

Methods inherited from class java.lang.Object

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

Constructor Detail

ERecRank

public ERecRank()

Default constructor that creates an empty ERecSearch object.

ERecRank

public ERecRank(String key,
                String terms,
                String strategy)

Constructor specifying the key and the terms of the search. The options are set to null.

Parameters:

key - The key (an Endeca property, dimension, or search interface) of the records with which to search.

terms - The terms of the search.

ERecRank

public ERecRank(String key,
                String terms,
                String strategy,
                String matchmode)

Constructor specifying the key, terms, and options of the search.

Parameters:

key - The key (an Endeca property, dimension, or search interface) of the records with which to search.

terms - The terms of the search.

strategy - The strategies to be used to rank the records

matchmode - The match mode used to select records to rank

Method Detail

getTerms

public String getTerms()

Accessor that returns the terms of this ERecRank.

Returns:

The terms of the record search.

getKey

public String getKey()

Accessor that returns the key of this ERecRank.

Returns:

The key (an Endeca property, dimension, or search interface) of the record search.

getStrategy

public String getStrategy()

Accessor that returns the strategy of this ERecRank.

Returns:

The strategy of the record search.

getMatchMode

public String getMatchMode()

Accessor that returns the match mode of this ERecRank.

Returns:

The match mode of the record search.

hashCode

public int hashCode()

Overrides:

hashCode in class Object

equals

public boolean equals(Object other)

Overrides:

equals in class Object

toString

public String toString()

Overrides:

toString in class Object