com.endeca.infront.cartridge

Class ResultsListHandler

java.lang.Object

com.endeca.infront.cartridge.NavigationCartridgeHandler<Config,Model>

com.endeca.infront.cartridge.ResultsListHandler

public class ResultsListHandler
extends NavigationCartridgeHandler<Config,Model>

Handler for the ResultsList cartridge.

Constructor Summary

Constructors

Constructor and Description
ResultsListHandler()

Method Summary

Modifier and Type	Method and Description
protected List<String>	combineFieldNames(NavigationState navigationState, com.endeca.infront.cartridge.FieldNamesConfig config) Updates the list of string for retaining representative record properties.
protected Record	createRecordFromAggrERec(com.endeca.navigation.AggrERec aggrERec, NavigationState navigationState, com.endeca.infront.cartridge.FieldNamesConfig config) Create a Record object from an AggrERec.
protected Record	createRecordFromERec(com.endeca.navigation.ERec eRec, NavigationState navigationState, boolean isSubRecord, com.endeca.infront.cartridge.FieldNamesConfig config) Create a Record object from an ERec.
protected List<Record>	createRecords(com.endeca.navigation.ENEQueryResults results, NavigationState navigationState, com.endeca.infront.cartridge.FieldNamesConfig config) Convert the records found in the given query to Record form.
protected void	dispatchNavigationEventInformation(ResultsListConfig cartridgeConfig, ResultsList resultsList) Tracks all Navigation State related information.
List<SortOptionConfig>	getSortOptions() A list of sort options to display to the end user.
protected static long	getTotalNumRecs(com.endeca.navigation.ENEQueryResults results)
ResultsListConfig	initialize(ContentItem pContentItem) Creates a ResultsListConfig representing the full configuration for this cartridge.
void	preprocess(ResultsListConfig cartridgeConfig) Creates a record list MDEX query.
ResultsList	process(ResultsListConfig cartridgeConfig) Creates a basic RecordList model.
protected void	retainFieldNames(Map<String,Attribute> attributeMap, List<String> fieldNames) Helper method that can be overridden by sub-classes to modify the fields retention logic.
protected void	retainFields(Map<String,Attribute> attributeMap, com.endeca.infront.cartridge.FieldNamesConfig config, boolean aggregationEnabled) Helper method for retaining properties.
void	setContentBroker(ContentBroker pContentBroker) Provider of essential services to dynamic content handlers.
void	setContentSource(ContentSource pContentSource) Specify the source to retrieve content for the handler.
void	setRecommendationService(RecommendationService recommendationService)
void	setSortOptions(List<SortOptionConfig> sortOptions) Returns the list of sort options to display to the end user.
protected ResultsListConfig	wrapConfig(ContentItem pContentItem) Wraps the input ContentItem as a typed config object.

Methods inherited from class com.endeca.infront.cartridge.NavigationCartridgeHandler

createMdexRequest, dispatchNavigationEventInformation, executeMdexRequest, executeMdexRequest, getActionPathProvider, getAuditInfo, getContentItemInitializer, getMdexRequestBroker, getNavigationState, getSiteState, getUserState, populateNavigationPathDefaults, setActionPathProvider, setAuditInfo, setContentItemInitializer, setMdexRequestBroker, setNavigationState, setSiteState, setUserState

Methods inherited from class java.lang.Object

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

Constructor Detail

ResultsListHandler

public ResultsListHandler()

Method Detail

getSortOptions

public List<SortOptionConfig> getSortOptions()

A list of sort options to display to the end user.

setSortOptions

public void setSortOptions(List<SortOptionConfig> sortOptions)

Returns the list of sort options to display to the end user.

See Also:

getSortOptions()

setContentSource

public void setContentSource(ContentSource pContentSource)

Specify the source to retrieve content for the handler.

Parameters:

pContentSource - the source to retrieve content for the handler.

setContentBroker

public void setContentBroker(ContentBroker pContentBroker)

Provider of essential services to dynamic content handlers. Through this broker, a dynamic content slot handler may query the content source associated with the request.

Parameters:

pContentBroker - the broker used to retrieve dynamic content.

setRecommendationService

public void setRecommendationService(RecommendationService recommendationService)

initialize

public ResultsListConfig initialize(ContentItem pContentItem)
                             throws CartridgeHandlerException

Creates a ResultsListConfig representing the full configuration for this cartridge.

Overrides:

initialize in class NavigationCartridgeHandler<ResultsListConfig,ResultsList>

Parameters:

pContentItem - cartridge instance configuration, typically from Experience Manager.

Returns:

Full configuration for this cartridge. It is not expected that this configuration will be further modified by the NavigationCartridgeHandler.preprocess(ConfigType) or NavigationCartridgeHandler.process(ConfigType) methods.

Throws:

CartridgeHandlerException

See Also:

NavigationCartridgeHandler.setContentItemInitializer(ContentItemInitializer), NavigationCartridgeHandler.wrapConfig(ContentItem)

wrapConfig

protected ResultsListConfig wrapConfig(ContentItem pContentItem)

Description copied from class: NavigationCartridgeHandler

Wraps the input ContentItem as a typed config object. It is not expected that subclasses will mutate the input ContentItem, beyond passing it into their typed configuration class as a constructor argument.

Specified by:

wrapConfig in class NavigationCartridgeHandler<ResultsListConfig,ResultsList>

Parameters:

pContentItem - the configuration for this cartridge handler. This will either be the fully initialized configuration object, if a ContentItemInitializer has been set, or it will simply be the instance configuration.

Returns:

an instance of ConfigType which wraps the input ContentItem.

See Also:

NavigationCartridgeHandler.initialize(ContentItem), NavigationCartridgeHandler.setContentItemInitializer(ContentItemInitializer)

preprocess

public void preprocess(ResultsListConfig cartridgeConfig)
                throws CartridgeHandlerException

Creates a record list MDEX query.

Overrides:

preprocess in class NavigationCartridgeHandler<ResultsListConfig,ResultsList>

Throws:

CartridgeHandlerException

process

public ResultsList process(ResultsListConfig cartridgeConfig)
                    throws CartridgeHandlerException

Creates a basic RecordList model. Subclasses can override this method to create more complex models (for instance, if access to Dimension information from the record is needed).

Subclasses could also override the createRecordFromERec(com.endeca.navigation.ERec, com.endeca.infront.navigation.NavigationState, boolean, com.endeca.infront.cartridge.FieldNamesConfig) or createRecords(com.endeca.navigation.ENEQueryResults, com.endeca.infront.navigation.NavigationState, com.endeca.infront.cartridge.FieldNamesConfig) methods if they are only making a customization to the Record model.

Overrides:

process in class NavigationCartridgeHandler<ResultsListConfig,ResultsList>

Throws:

CartridgeHandlerException

dispatchNavigationEventInformation

protected void dispatchNavigationEventInformation(ResultsListConfig cartridgeConfig,
                                                  ResultsList resultsList)

Tracks all Navigation State related information.

retainFields

protected void retainFields(Map<String,Attribute> attributeMap,
                            com.endeca.infront.cartridge.FieldNamesConfig config,
                            boolean aggregationEnabled)

Helper method for retaining properties. Assumes getFieldNames() does not return null

Parameters:

attributeMap - A list of attributes to maintain on the records.

config - Cartridge Configuration used to determine which attributes to include.

aggregationEnabled - TRUE if aggregation is enabled on the request.

See Also:

RecordBasedNavigationCartridgeHandler.retainFields(java.util.Map, FieldNamesConfig, boolean)

retainFieldNames

protected void retainFieldNames(Map<String,Attribute> attributeMap,
                                List<String> fieldNames)

Helper method that can be overridden by sub-classes to modify the fields retention logic.

Parameters:

attributeMap - the attributes of a given record.

fieldNames - the list of fields that are to be retained.

combineFieldNames

protected List<String> combineFieldNames(NavigationState navigationState,
                                         com.endeca.infront.cartridge.FieldNamesConfig config)
                                  throws CartridgeHandlerException

Updates the list of string for retaining representative record properties.

Returns:

the combined field names from representative record field names, sub-record field names and potentially DGraph.WhyRank and DGraph.WhyMatch if whymatch and whyrank are turned on respectively.

Throws:

CartridgeHandlerException

getTotalNumRecs

protected static long getTotalNumRecs(com.endeca.navigation.ENEQueryResults results)

createRecords

protected List<Record> createRecords(com.endeca.navigation.ENEQueryResults results,
                                     NavigationState navigationState,
                                     com.endeca.infront.cartridge.FieldNamesConfig config)

Convert the records found in the given query to Record form. If you override this method, it is strongly recommended that you call this super method before you modify the resulting record in order to retain the default marshaling logic.

Parameters:

results - Result of MDEX query

navigationState - Base navigation state for record details links. If null, record details links are omitted

config - The configuration specifying which field names should be included in the resulting records

Returns:

The list of records

createRecordFromAggrERec

protected Record createRecordFromAggrERec(com.endeca.navigation.AggrERec aggrERec,
                                          NavigationState navigationState,
                                          com.endeca.infront.cartridge.FieldNamesConfig config)

Create a Record object from an AggrERec. This method gets called from within createRecords(ENEQueryResults,NavigationState,FieldNamesConfig) for each AggrERec object in the results. If you override this method, it is strongly recommended that you call this super method before you modify the resulting record in order to retain the default marshaling logic.

Parameters:

aggrERec - The AggrERec to build the Record from

navigationState - The base navigation state for details actions

config - The configuration specifying which field names should be included in the resulting records

Returns:

The resulting Record object

createRecordFromERec

protected Record createRecordFromERec(com.endeca.navigation.ERec eRec,
                                      NavigationState navigationState,
                                      boolean isSubRecord,
                                      com.endeca.infront.cartridge.FieldNamesConfig config)

Create a Record object from an ERec. When requesting non-aggregated records (i.e. there is no rollup key specified), this method gets called from within createRecords(ENEQueryResults,NavigationState,FieldNamesConfig) for each ERec object in the results. In this case, isSubRecord will be false. When requesting aggregate records, this method gets called from createRecordFromAggrERec(AggrERec,NavigationState,FieldNamesConfig) for each child ERec object on the aggregate record. In this case, isSubRecord will be true. If you override this method, it is strongly recommended that you call this super method before you modify the resulting record in order to retain the default marshaling logic.

Parameters:

eRec - The ERec to build a Record from

navigationState - The base navigation state for details actions

isSubRecord - 'true' if this ERec is the sub-record of an AggrERec

config - The configuration specifying which field names should be included in the resulting records

Returns:

The resulting Record object.