com.endeca.infront.cartridge

Class RecordSpotlightHandler

java.lang.Object

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

com.endeca.infront.cartridge.RecordSpotlightHandler

public class RecordSpotlightHandler
extends NavigationCartridgeHandler<Config,Model>

Cartridge handler that creates RecordSpotlight model objects.

Constructor Summary

Constructors

Constructor and Description
RecordSpotlightHandler()

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 NavigationState	createSpotlightNavigationState(NavigationState navigationState, RecordSpotlightConfig config) This method is responsible for merging the global NavigationState passed in with the RecordSpotlightConfig's navigation selection.
protected static long	getTotalNumRecs(com.endeca.navigation.ENEQueryResults results)
void	preprocess(RecordSpotlightConfig cartridgeConfig) This method ensures the configuration's recordSelection is valid (i.e.
RecordSpotlight	process(RecordSpotlightConfig cartridgeConfig) This method processes the global query results in order to obtain information about the current navigation state dimensions, such as whether they are multi-or, and what their ancestors are.
protected RecordSpotlight	processSpotlightMdexResponse(NavigationState spotlightNavigationState, RecordSpotlightConfig config, com.endeca.navigation.ENEQueryResults eneResults) Protected method allows this to be overridden by subclasses of the CartridgeHandler.
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.
protected RecordSpotlightConfig	wrapConfig(ContentItem pContentItem) Creates a RecordSpotlightConfig.

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

createMdexRequest, dispatchNavigationEventInformation, executeMdexRequest, executeMdexRequest, getActionPathProvider, getAuditInfo, getContentItemInitializer, getMdexRequestBroker, getNavigationState, getSiteState, getUserState, initialize, 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

RecordSpotlightHandler

public RecordSpotlightHandler()

Method Detail

wrapConfig

protected RecordSpotlightConfig wrapConfig(ContentItem pContentItem)

Creates a RecordSpotlightConfig.

Specified by:

wrapConfig in class NavigationCartridgeHandler<RecordSpotlightConfig,RecordSpotlight>

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(RecordSpotlightConfig cartridgeConfig)
                throws CartridgeHandlerException

This method ensures the configuration's recordSelection is valid (i.e. not null). It also runs the globally shared query to get access to breadcrumbs metadata

Overrides:

preprocess in class NavigationCartridgeHandler<RecordSpotlightConfig,RecordSpotlight>

Throws:

CartridgeHandlerException - if the recordSelection isn't valid

process

public RecordSpotlight process(RecordSpotlightConfig cartridgeConfig)
                        throws CartridgeHandlerException

This method processes the global query results in order to obtain information about the current navigation state dimensions, such as whether they are multi-or, and what their ancestors are. It passes this information through the NavigationState object to the createSpotlightNavigationState(NavigationState, RecordSpotlightConfig) method, which merges the spotlight's merchandiser configured navigation state with the user's navigation state, and then makes a second MDEX query for the spotlight results, which it then passes to processSpotlightMdexResponse(NavigationState, RecordSpotlightConfig, ENEQueryResults).

Overrides:

process in class NavigationCartridgeHandler<RecordSpotlightConfig,RecordSpotlight>

Throws:

CartridgeHandlerException

createSpotlightNavigationState

protected NavigationState createSpotlightNavigationState(NavigationState navigationState,
                                                         RecordSpotlightConfig config)

This method is responsible for merging the global NavigationState passed in with the RecordSpotlightConfig's navigation selection.

Subclasses can further modify the NavigationState that is used to query for the record spotlight results by overriding this method and returning a modified NavigationState

Parameters:

navigationState - the global navigation state

config -

Returns:

The resulting navigation state

processSpotlightMdexResponse

protected RecordSpotlight processSpotlightMdexResponse(NavigationState spotlightNavigationState,
                                                       RecordSpotlightConfig config,
                                                       com.endeca.navigation.ENEQueryResults eneResults)

Protected method allows this to be overridden by subclasses of the CartridgeHandler. Subclasses should override this method if they need access to the ENEQueryResults used in the creation of the RecordSpotlight model. Overriding the NavigationCartridgeHandler.executeMdexRequest(com.endeca.infront.navigation.request.MdexRequest) method will only provide access to the global ENEQueryResults which would be used for building Breadcrumbs or ResultsList, etc.

Returns:

the output RecordSpotlight model

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.

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.

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.