com.endeca.navigation
Class ERecSearch

java.lang.Object
  com.endeca.navigation.ERecSearch

public class ERecSearch
extends Object

Class representing a search on a navigation record set. A record search is composed of three 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).
• options, such as the search mode (e.g., mode matchany) and relevance ranking options.

ERecSearch objects are encapsulated in ERecSearchList objects when sent to or returned from the MDEX Engine.

Constructor Summary

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

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

ERecSearch(String key, String terms, String opts)
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 ERecSearch.
String	getOpts() Accessor that returns the options of this ERecSearch.
String	getTerms() Accessor that returns the terms of this ERecSearch.
int	hashCode()
String	toString()

Methods inherited from class java.lang.Object

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

Constructor Detail

ERecSearch

public ERecSearch()

Default constructor that creates an empty ERecSearch object.

ERecSearch

public ERecSearch(String key,
                  String terms)

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.

ERecSearch

public ERecSearch(String key,
                  String terms,
                  String opts)

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.

opts - Sequence of key value pairs delimited by the '+' character.

Method Detail

getTerms

public String getTerms()

Accessor that returns the terms of this ERecSearch.

Returns:

The terms of the record search.

getKey

public String getKey()

Accessor that returns the key of this ERecSearch.

Returns:

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

getOpts

public String getOpts()

Accessor that returns the options of this ERecSearch.

Returns:

The options 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