com.endeca.b2creference.services.query.impl
Class UICLContentQueryService

java.lang.Object
  com.endeca.b2creference.services.query.impl.UICLContentQueryService

All Implemented Interfaces:

ContentQueryService

Direct Known Subclasses:

NavStateRecordListProcessor, UICLMobileQueryService

public class UICLContentQueryService
extends java.lang.Object
implements ContentQueryService

Creates and submits content queries to the MDEX engine and processes query results.

Constructor Summary

UICLContentQueryService()

Method Summary

ApplicationConfig	getApplicationConfig()
com.endeca.content.ContentManager	getContentManager()
int	getMaxRequeryCount()
java.lang.String	getMdexHost() Getter for mdexHost property.
int	getMdexPort() Getter for mdexPort property.
com.endeca.soleng.urlformatter.QueryBuilder	getQueryBuilder()
java.util.List<QueryProcessor>	getQueryProcessors()
com.endeca.soleng.uiComponentLibrary.web.urlFormatter.config.UrlConfig	getUrlConfig()
PageResult	parseResults(javax.servlet.http.HttpServletRequest request, com.endeca.content.ene.ENEContentQuery query, com.endeca.content.ene.ENEContentResults contentResults, com.endeca.soleng.urlformatter.UrlState urlState) Parses the content results, and sets the following request attributes: Submitted ENEQuery object (REQUEST_ATTR_ENE_QUERY) Returned ENEContentResults object (REQUEST_ATTR_CONTENT_RESULTS) Current UrlState object (REQUEST_ATTR_URL_STATE) The UrlFormatter object that should be used for generating links (REQUEST_ATTR_URL_FORMATTER) Redirect URL string (REQUEST_ATTR_REDIRECT_URL), if one was specified by a merch rule Response type (REQUEST_ATTR_RESPONSE_TYPE) - e.g.
PageResult	processRequest(javax.servlet.http.HttpServletRequest request, javax.servlet.http.HttpServletResponse response, com.endeca.soleng.urlformatter.UrlState urlState) Called by the Controller to process the request.
void	setApplicationConfig(ApplicationConfig applicationConfig)
void	setContentManager(com.endeca.content.ContentManager contentManager)
void	setLocalizedUrlFormatter(LocalizedUrlFormatter localizedUrlFormatter)
void	setMaxRequeryCount(int maxRequeryCount)
void	setQueryBuilder(com.endeca.soleng.urlformatter.QueryBuilder queryBuilder)
void	setQueryProcessors(java.util.List<QueryProcessor> queryProcessors)
void	setUrlConfig(com.endeca.soleng.uiComponentLibrary.web.urlFormatter.config.UrlConfig urlConfig)
com.endeca.content.ene.ENEContentResults	submitContentQuery(com.endeca.content.ene.ENEContentQuery contentQuery, com.endeca.content.ContentManager contentManager) Creates and submits a content query based on the passed ENEQuery to the MDEX engine, and returns the ENEContentResults.

Methods inherited from class java.lang.Object

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

Constructor Detail

UICLContentQueryService

public UICLContentQueryService()

Method Detail

processRequest

public PageResult processRequest(javax.servlet.http.HttpServletRequest request,
                                 javax.servlet.http.HttpServletResponse response,
                                 com.endeca.soleng.urlformatter.UrlState urlState)
                          throws java.net.MalformedURLException,
                                 com.endeca.soleng.urlformatter.UrlFormatException,
                                 com.endeca.soleng.urlformatter.QueryBuildException,
                                 com.endeca.content.ContentException,
                                 DataRetrievalException

Description copied from interface: ContentQueryService

Called by the Controller to process the request. This method creates the ENEContentQuery, submits it, and processes the results.

Specified by:

processRequest in interface ContentQueryService

Parameters:

request - HttpServletRequest

response - HttpServletResponse

urlState - UrlState

Throws:

java.net.MalformedURLException - On error during a redirect.

com.endeca.soleng.urlformatter.UrlFormatException - On error when parsing a request into an UrlState.

com.endeca.soleng.urlformatter.QueryBuildException - On error when marshaling an UrlState into an ENEQuery object.

com.endeca.content.ContentException - On exception when interacting with the Content Assembler API.

DataRetrievalException

parseResults

public PageResult parseResults(javax.servlet.http.HttpServletRequest request,
                               com.endeca.content.ene.ENEContentQuery query,
                               com.endeca.content.ene.ENEContentResults contentResults,
                               com.endeca.soleng.urlformatter.UrlState urlState)

Parses the content results, and sets the following request attributes:

• Submitted ENEQuery object (REQUEST_ATTR_ENE_QUERY)
• Returned ENEContentResults object (REQUEST_ATTR_CONTENT_RESULTS)
• Current UrlState object (REQUEST_ATTR_URL_STATE)
• The UrlFormatter object that should be used for generating links (REQUEST_ATTR_URL_FORMATTER)
• Redirect URL string (REQUEST_ATTR_REDIRECT_URL), if one was specified by a merch rule
• Response type (REQUEST_ATTR_RESPONSE_TYPE) - e.g. search / navigation or record detail.

Parameters:

request - HttpServletRequest

query - ENEQuery

contentResults - ENEContentResults

urlFormatter - UrlFormatter

urlState - base UrlState for this request

submitContentQuery

public com.endeca.content.ene.ENEContentResults submitContentQuery(com.endeca.content.ene.ENEContentQuery contentQuery,
                                                                   com.endeca.content.ContentManager contentManager)
                                                            throws com.endeca.content.ContentException

Creates and submits a content query based on the passed ENEQuery to the MDEX engine, and returns the ENEContentResults.

Parameters:

query - ENEQuery

contentManager - ContentManager

Returns:

ENEContentResults

Throws:

com.endeca.content.ContentException - On exceptions when interacting with the Content Assembler API

getMdexHost

public java.lang.String getMdexHost()
                             throws com.endeca.content.ContentException

Getter for mdexHost property.

Returns:

MDEX host.

Throws:

com.endeca.content.ContentException

getMdexPort

public int getMdexPort()

Getter for mdexPort property.

Returns:

MDEX port.

getApplicationConfig

public ApplicationConfig getApplicationConfig()

setApplicationConfig

public void setApplicationConfig(ApplicationConfig applicationConfig)

getContentManager

public com.endeca.content.ContentManager getContentManager()

setContentManager

public void setContentManager(com.endeca.content.ContentManager contentManager)

getQueryBuilder

public com.endeca.soleng.urlformatter.QueryBuilder getQueryBuilder()

setQueryBuilder

public void setQueryBuilder(com.endeca.soleng.urlformatter.QueryBuilder queryBuilder)

setLocalizedUrlFormatter

public void setLocalizedUrlFormatter(LocalizedUrlFormatter localizedUrlFormatter)

getUrlConfig

public com.endeca.soleng.uiComponentLibrary.web.urlFormatter.config.UrlConfig getUrlConfig()

setUrlConfig

public void setUrlConfig(com.endeca.soleng.uiComponentLibrary.web.urlFormatter.config.UrlConfig urlConfig)

setQueryProcessors

public void setQueryProcessors(java.util.List<QueryProcessor> queryProcessors)

getQueryProcessors

public java.util.List<QueryProcessor> getQueryProcessors()

getMaxRequeryCount

public int getMaxRequeryCount()

setMaxRequeryCount

public void setMaxRequeryCount(int maxRequeryCount)