com.endeca.portal.data
Class BreadcrumbGenerator

java.lang.Object
  com.endeca.portal.data.BreadcrumbGenerator

public class BreadcrumbGenerator
extends java.lang.Object

Field Summary

static java.lang.String	ACTION_CLEAR_ALL_BREADCRUMBS
static java.lang.String	ACTION_REMOVE_RANGE_FILTER
static java.lang.String	ACTION_REMOVE_SEARCH
static java.lang.String	ACTION_REPLACE_SEARCH
static java.lang.String	ACTION_SAVE_PREFERENCES
static java.lang.String	ACTION_UPDATE_NAV_STATE
static java.lang.String	MAP_KEY_BREADCRUMBS
static java.lang.String	MAP_KEY_DIMENSION_DIMVALS
static java.lang.String	MAP_KEY_DIMENSION_NAME
static java.lang.String	MAP_KEY_DIMENSIONS
static java.lang.String	MAP_KEY_DIMVAL_NAME
static java.lang.String	MAP_KEY_DIMVALS_EXPANDED
static java.lang.String	MAP_KEY_DYM_LINK
static java.lang.String	MAP_KEY_DYM_TERM
static java.lang.String	MAP_KEY_NEGATIVE_REFINEMENTS
static java.lang.String	MAP_KEY_RANGE_FILTER_GEO_LOCATION_NAME
static java.lang.String	MAP_KEY_RANGE_FILTER_OPERATOR
static java.lang.String	MAP_KEY_RANGE_FILTER_PROPERTY
static java.lang.String	MAP_KEY_RANGE_FILTER_TYPE
static java.lang.String	MAP_KEY_RANGE_FILTER_VALUE1
static java.lang.String	MAP_KEY_RANGE_FILTER_VALUE2
static java.lang.String	MAP_KEY_RANGE_FILTER_VALUE3
static java.lang.String	MAP_KEY_RANGE_FILTERS
static java.lang.String	MAP_KEY_REMOVE_LINK
static java.lang.String	MAP_KEY_SEARCH_AUTOSUGGESTION
static java.lang.String	MAP_KEY_SEARCH_DIDYOUMEAN
static java.lang.String	MAP_KEY_SEARCH_TERMS
static java.lang.String	MAP_KEY_SEARCHES
static java.lang.String	MAP_KEY_TOGGLE_LINK
static java.lang.String	PARAM_DIM_VAL_TO_ADD
static java.lang.String	PARAM_DIM_VALS_TO_REMOVE
static java.lang.String	PARAM_MULTISELECT_TOGGLE_DIM_ID
static java.lang.String	PARAM_REMOVE_OPERATOR
static java.lang.String	PARAM_REMOVE_RANGE_FILTER
static java.lang.String	PARAM_REPLACE_OPERATOR
static java.lang.String	PARAM_SEARCH_KEY
static java.lang.String	PARAM_SEARCH_TERM
static java.lang.String	PARAM_SEARCH_TERM_REPLACE
static java.lang.String	PARAM_SELECT_OPERATOR
static java.lang.String	PREFERENCE_PARAM_MS_THRESH
static java.lang.String	PREFERENCE_PARAM_MS_THRESH_DEFAULT
static java.lang.String	RESOURCE_SET_SESSION_STATE
static java.lang.String	SESSION_ATTRIBUTE_EXPANDED_DIMS

Constructor Summary

BreadcrumbGenerator()

Method Summary

static java.util.Map<java.lang.String,java.util.Map<java.lang.String,java.util.List<?>>>	getBreadCrumb(com.endeca.mdex.conversation.Results results, QueryState q, DataSource dataSource) return Map with Breadcrumb value for MDEX7
static java.util.Map<java.lang.String,java.util.Map<java.lang.String,java.util.List<?>>>	getBreadCrumb(com.endeca.mdex.conversation.Results results, QueryState q, javax.portlet.PortletRequest request) This method should be safe to use for getting breadcrumbs when the request object is expected to be associated with the datasource from which you want breadcrumbs.
static java.lang.String	getBreadCrumbString(com.endeca.mdex.conversation.Results results, QueryState q, DataSource dataSource, javax.portlet.PortletRequest request) Returns the breadcrumbs string associated with the given querystate and datasource

Methods inherited from class java.lang.Object

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

Field Detail

ACTION_CLEAR_ALL_BREADCRUMBS

public static final java.lang.String ACTION_CLEAR_ALL_BREADCRUMBS

See Also:

Constant Field Values

ACTION_REMOVE_SEARCH

public static final java.lang.String ACTION_REMOVE_SEARCH

See Also:

Constant Field Values

ACTION_REPLACE_SEARCH

public static final java.lang.String ACTION_REPLACE_SEARCH

See Also:

Constant Field Values

ACTION_UPDATE_NAV_STATE

public static final java.lang.String ACTION_UPDATE_NAV_STATE

See Also:

Constant Field Values

ACTION_REMOVE_RANGE_FILTER

public static final java.lang.String ACTION_REMOVE_RANGE_FILTER

See Also:

Constant Field Values

ACTION_SAVE_PREFERENCES

public static final java.lang.String ACTION_SAVE_PREFERENCES

See Also:

Constant Field Values

PREFERENCE_PARAM_MS_THRESH

public static final java.lang.String PREFERENCE_PARAM_MS_THRESH

See Also:

Constant Field Values

PREFERENCE_PARAM_MS_THRESH_DEFAULT

public static final java.lang.String PREFERENCE_PARAM_MS_THRESH_DEFAULT

See Also:

Constant Field Values

RESOURCE_SET_SESSION_STATE

public static final java.lang.String RESOURCE_SET_SESSION_STATE

See Also:

Constant Field Values

PARAM_MULTISELECT_TOGGLE_DIM_ID

public static final java.lang.String PARAM_MULTISELECT_TOGGLE_DIM_ID

See Also:

Constant Field Values

SESSION_ATTRIBUTE_EXPANDED_DIMS

public static final java.lang.String SESSION_ATTRIBUTE_EXPANDED_DIMS

See Also:

Constant Field Values

PARAM_DIM_VALS_TO_REMOVE

public static final java.lang.String PARAM_DIM_VALS_TO_REMOVE

See Also:

Constant Field Values

PARAM_DIM_VAL_TO_ADD

public static final java.lang.String PARAM_DIM_VAL_TO_ADD

See Also:

Constant Field Values

PARAM_SEARCH_KEY

public static final java.lang.String PARAM_SEARCH_KEY

See Also:

Constant Field Values

PARAM_SEARCH_TERM

public static final java.lang.String PARAM_SEARCH_TERM

See Also:

Constant Field Values

PARAM_SEARCH_TERM_REPLACE

public static final java.lang.String PARAM_SEARCH_TERM_REPLACE

See Also:

Constant Field Values

PARAM_REMOVE_RANGE_FILTER

public static final java.lang.String PARAM_REMOVE_RANGE_FILTER

See Also:

Constant Field Values

PARAM_REMOVE_OPERATOR

public static final java.lang.String PARAM_REMOVE_OPERATOR

See Also:

Constant Field Values

PARAM_SELECT_OPERATOR

public static final java.lang.String PARAM_SELECT_OPERATOR

See Also:

Constant Field Values

PARAM_REPLACE_OPERATOR

public static final java.lang.String PARAM_REPLACE_OPERATOR

See Also:

Constant Field Values

MAP_KEY_BREADCRUMBS

public static final java.lang.String MAP_KEY_BREADCRUMBS

See Also:

Constant Field Values

MAP_KEY_SEARCHES

public static final java.lang.String MAP_KEY_SEARCHES

See Also:

Constant Field Values

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

MAP_KEY_SEARCH_DIDYOUMEAN

public static final java.lang.String MAP_KEY_SEARCH_DIDYOUMEAN

See Also:

Constant Field Values

MAP_KEY_DYM_TERM

public static final java.lang.String MAP_KEY_DYM_TERM

See Also:

Constant Field Values

MAP_KEY_DYM_LINK

public static final java.lang.String MAP_KEY_DYM_LINK

See Also:

Constant Field Values

MAP_KEY_REMOVE_LINK

public static final java.lang.String MAP_KEY_REMOVE_LINK

See Also:

Constant Field Values

MAP_KEY_TOGGLE_LINK

public static final java.lang.String MAP_KEY_TOGGLE_LINK

See Also:

Constant Field Values

MAP_KEY_DIMENSIONS

public static final java.lang.String MAP_KEY_DIMENSIONS

See Also:

Constant Field Values

MAP_KEY_DIMENSION_NAME

public static final java.lang.String MAP_KEY_DIMENSION_NAME

See Also:

Constant Field Values

MAP_KEY_DIMENSION_DIMVALS

public static final java.lang.String MAP_KEY_DIMENSION_DIMVALS

See Also:

Constant Field Values

MAP_KEY_DIMVALS_EXPANDED

public static final java.lang.String MAP_KEY_DIMVALS_EXPANDED

See Also:

Constant Field Values

MAP_KEY_DIMVAL_NAME

public static final java.lang.String MAP_KEY_DIMVAL_NAME

See Also:

Constant Field Values

MAP_KEY_RANGE_FILTERS

public static final java.lang.String MAP_KEY_RANGE_FILTERS

See Also:

Constant Field Values

MAP_KEY_RANGE_FILTER_PROPERTY

public static final java.lang.String MAP_KEY_RANGE_FILTER_PROPERTY

See Also:

Constant Field Values

MAP_KEY_RANGE_FILTER_TYPE

public static final java.lang.String MAP_KEY_RANGE_FILTER_TYPE

See Also:

Constant Field Values

MAP_KEY_RANGE_FILTER_OPERATOR

public static final java.lang.String MAP_KEY_RANGE_FILTER_OPERATOR

See Also:

Constant Field Values

MAP_KEY_RANGE_FILTER_VALUE1

public static final java.lang.String MAP_KEY_RANGE_FILTER_VALUE1

See Also:

Constant Field Values

MAP_KEY_RANGE_FILTER_VALUE2

public static final java.lang.String MAP_KEY_RANGE_FILTER_VALUE2

See Also:

Constant Field Values

MAP_KEY_RANGE_FILTER_VALUE3

public static final java.lang.String MAP_KEY_RANGE_FILTER_VALUE3

See Also:

Constant Field Values

MAP_KEY_NEGATIVE_REFINEMENTS

public static final java.lang.String MAP_KEY_NEGATIVE_REFINEMENTS

See Also:

Constant Field Values

MAP_KEY_RANGE_FILTER_GEO_LOCATION_NAME

public static final java.lang.String MAP_KEY_RANGE_FILTER_GEO_LOCATION_NAME

See Also:

Constant Field Values

Constructor Detail

BreadcrumbGenerator

public BreadcrumbGenerator()

Method Detail

getBreadCrumb

public static java.util.Map<java.lang.String,java.util.Map<java.lang.String,java.util.List<?>>> getBreadCrumb(com.endeca.mdex.conversation.Results results,
                                                                                                              QueryState q,
                                                                                                              javax.portlet.PortletRequest request)

This method should be safe to use for getting breadcrumbs when the request object is expected to be associated with the datasource from which you want breadcrumbs. This is true for almost all portlets. One notable exception is the export portlet, which should use the method below instead of passing in a request object.

Parameters:

results -

q -

request -

Returns:

getBreadCrumb

public static java.util.Map<java.lang.String,java.util.Map<java.lang.String,java.util.List<?>>> getBreadCrumb(com.endeca.mdex.conversation.Results results,
                                                                                                              QueryState q,
                                                                                                              DataSource dataSource)

return Map with Breadcrumb value for MDEX7

Parameters:

request -

Returns:

Map

Throws:

DataSourceException

getBreadCrumbString

public static java.lang.String getBreadCrumbString(com.endeca.mdex.conversation.Results results,
                                                   QueryState q,
                                                   DataSource dataSource,
                                                   javax.portlet.PortletRequest request)

Returns the breadcrumbs string associated with the given querystate and datasource

Parameters:

results -

q -

dataSource -

request -

Returns: