com.endeca.infront.navigation
Class MdexRequestBroker

java.lang.Object
  com.endeca.infront.navigation.MdexRequestBroker

public class MdexRequestBroker
extends Object

Internal class used by Endeca cartridge handlers to query the MDEX engine -- Should not be used directly outside of Endeca navigation cartridge handlers.

Constructor Summary

MdexRequestBroker(MdexResource mdexResource, boolean debugEnabled)
Creates an MDEX request broker.

Method Summary

com.endeca.infront.navigation.request.MdexRequest	createMdexRequest(FilterState filterState, com.endeca.infront.navigation.request.MdexQuery mdexQuery) This method is for internal Oracle use only and should never be called. If the request specified by the given query and filter state has already been constructed, then return a reference to it.
MdexResource	getMdexResource() This method is for internal Oracle use only and should never be called. Gets the MDEX resource that will be used to create requests.

Methods inherited from class java.lang.Object

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

Constructor Detail

MdexRequestBroker

public MdexRequestBroker(MdexResource mdexResource,
                         boolean debugEnabled)

Creates an MDEX request broker.

Parameters:

mdexResource - The MDEX to use for constructing requests

debugEnabled - When set to true, will allow debug parameters to be passed into requests.

See Also:

ResultsListConfig.setWhyMatchEnabled(boolean), ResultsListConfig.setWhyRankEnabled(boolean), RefinementMenuConfig.setWhyPrecedenceRuleFired(boolean), NavigationContainerConfig.setWhyPrecedenceRuleFired(boolean)

Method Detail

getMdexResource

public MdexResource getMdexResource()

This method is for internal Oracle use only and should never be called.
Gets the MDEX resource that will be used to create requests. All calls to this method for the same builder instance return the same MdexResource instance.

Returns:

The MDEX resource

createMdexRequest

public com.endeca.infront.navigation.request.MdexRequest createMdexRequest(FilterState filterState,
                                                                           com.endeca.infront.navigation.request.MdexQuery mdexQuery)
                                                                    throws NavigationException

This method is for internal Oracle use only and should never be called.
If the request specified by the given query and filter state has already been constructed, then return a reference to it. Otherwise, construct a new request.

Parameters:

filterState - The filter state

mdexQuery - The MDEX feature query

Returns:

a suitable request for the given query

Throws:

NavigationException - If the request could not be constructed due to invalid arguments