com.endeca.infront.cartridge

Class RecordDetailsHandler

java.lang.Object

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

com.endeca.infront.cartridge.RecordDetailsHandler

public class RecordDetailsHandler
extends NavigationCartridgeHandler<Config,Model>

Cartridge handler that creates RecordDetails model objects.

Field Summary

Fields

Modifier and Type	Field and Description
protected Logger	logger
protected RecordState	mRecordState

Constructor Summary

Constructors

Constructor and Description
RecordDetailsHandler()

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 FilterState	getFilterState(NavigationState navigationState) Retrieves the filter state to use when making record detail queries.
protected static long	getTotalNumRecs(com.endeca.navigation.ENEQueryResults results)
void	preprocess(RecordDetailsConfig cartridgeConfig) Creates a record details MDEX query.
RecordDetails	process(RecordDetailsConfig cartridgeConfig) Creates a RecordDetails model object.
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	setRecordState(RecordState pRecordState) Sets the record state representing the current request.
protected RecordDetailsConfig	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, 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

Field Detail

logger

protected Logger logger

mRecordState

protected RecordState mRecordState

Constructor Detail

RecordDetailsHandler

public RecordDetailsHandler()

Method Detail

setRecordState

public void setRecordState(RecordState pRecordState)

Sets the record state representing the current request.

wrapConfig

protected RecordDetailsConfig 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<RecordDetailsConfig,RecordDetails>

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

Creates a record details MDEX query.

Overrides:

preprocess in class NavigationCartridgeHandler<RecordDetailsConfig,RecordDetails>

Throws:

CartridgeHandlerException

process

public RecordDetails process(RecordDetailsConfig cartridgeConfig)
                      throws CartridgeHandlerException

Creates a RecordDetails model object.

Overrides:

process in class NavigationCartridgeHandler<RecordDetailsConfig,RecordDetails>

Throws:

CartridgeHandlerException

getFilterState

protected FilterState getFilterState(NavigationState navigationState)

Retrieves the filter state to use when making record detail queries. This implementation always returns an empty filter state, but can be overridden by subclasses if different behavior is desired.

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.