com.endeca.portal.data.model

Class SearchUtil

java.lang.Object

com.endeca.portal.data.model.SearchUtil

public class SearchUtil
extends java.lang.Object

Class containing utility methods modeling search-related results.

Field Summary

Fields

Modifier and Type	Field and Description
static java.lang.String	BREADCRUMBS_CONFIG_NAME_PREFIX
static java.lang.String	MAP_KEY_SEARCH_AUTOSUGGESTION
static java.lang.String	MAP_KEY_SEARCH_TERMS
static java.lang.String	SEARCH_ADJUSTMENT_CONFIG_NAME_PREFIX

Method Summary

Methods

Modifier and Type	Method and Description
static void	addSearchKeyQueries(QueryState q, java.util.Collection<CollectionBaseView> baseViews, java.util.Locale locale)
static void	addSearchKeyQueries(QueryState q, SemanticView semanticView, java.util.Locale locale) add search key queries for a semanticView
static java.util.Map<java.lang.String,java.util.List<java.lang.String>>	buildSearchKeyMapForMultiViews(com.endeca.mdex.conversation.types.Results results) Builds a map of search keys and equivalent terms based on search breadcrumbs and search adjustments for multiple base views.
static java.util.ArrayList<java.lang.String>	buildSearchKeys(com.endeca.mdex.conversation.types.Results results) Builds a list of search keys and equivalent terms based on search breadcrumbs and search adjustments for one base view.
static java.util.ArrayList<java.lang.String>	buildSearchKeysForMultiViews(com.endeca.mdex.conversation.types.Results results) Builds a list of search keys and equivalent terms based on search breadcrumbs and search adjustments for multiple base views.
static java.util.ArrayList<java.lang.String>	getSearchKeyList(javax.portlet.PortletRequest request, DataSource dataSource, SemanticView semanticView) Get search key list for a semanticView

Methods inherited from class java.lang.Object

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

Field Detail

MAP_KEY_SEARCH_TERMS

public static final java.lang.String MAP_KEY_SEARCH_TERMS

See Also:

Constant Field Values

MAP_KEY_SEARCH_AUTOSUGGESTION

public static final java.lang.String MAP_KEY_SEARCH_AUTOSUGGESTION

See Also:

Constant Field Values

BREADCRUMBS_CONFIG_NAME_PREFIX

public static final java.lang.String BREADCRUMBS_CONFIG_NAME_PREFIX

See Also:

Constant Field Values

SEARCH_ADJUSTMENT_CONFIG_NAME_PREFIX

public static final java.lang.String SEARCH_ADJUSTMENT_CONFIG_NAME_PREFIX

See Also:

Constant Field Values

Method Detail

buildSearchKeys

public static java.util.ArrayList<java.lang.String> buildSearchKeys(com.endeca.mdex.conversation.types.Results results)
                                                             throws DataSourceException

Builds a list of search keys and equivalent terms based on search breadcrumbs and search adjustments for one base view. Used primarily for search term highlighting.

Parameters:

results - - query results containing breadcrumbs

Returns:

- a list of search terms

Throws:

DataSourceException

getSearchKeyList

public static java.util.ArrayList<java.lang.String> getSearchKeyList(javax.portlet.PortletRequest request,
                                                     DataSource dataSource,
                                                     SemanticView semanticView)
                                                              throws DataSourceException

Get search key list for a semanticView

Parameters:

request -

semanticView -

Returns:

ArrayList searchKeyList

Throws:

DataSourceException

addSearchKeyQueries

public static void addSearchKeyQueries(QueryState q,
                       SemanticView semanticView,
                       java.util.Locale locale)
                                throws DataSourceException

add search key queries for a semanticView

Parameters:

request -

baseViews -

Throws:

DataSourceException

addSearchKeyQueries

public static void addSearchKeyQueries(QueryState q,
                       java.util.Collection<CollectionBaseView> baseViews,
                       java.util.Locale locale)
                                throws DataSourceException

Throws:

DataSourceException

buildSearchKeysForMultiViews

public static java.util.ArrayList<java.lang.String> buildSearchKeysForMultiViews(com.endeca.mdex.conversation.types.Results results)
                                                                          throws DataSourceException

Builds a list of search keys and equivalent terms based on search breadcrumbs and search adjustments for multiple base views. Used primarily for search term highlighting.

Parameters:

results - - query results containing breadcrumbs and search adjustments

Returns:

- a list of search terms

Throws:

DataSourceException

buildSearchKeyMapForMultiViews

public static java.util.Map<java.lang.String,java.util.List<java.lang.String>> buildSearchKeyMapForMultiViews(com.endeca.mdex.conversation.types.Results results)
                                                                                                       throws DataSourceException

Builds a map of search keys and equivalent terms based on search breadcrumbs and search adjustments for multiple base views. Used primarily for search term highlighting.

Parameters:

results - - query results containing breadcrumbs and search adjustments

Returns:

- a map of search terms

Throws:

DataSourceException