|
||||||||||
PREV CLASS NEXT CLASS | FRAMES NO FRAMES | |||||||||
SUMMARY: NESTED | FIELD | CONSTR | METHOD | DETAIL: FIELD | CONSTR | METHOD |
java.lang.Object com.endeca.infront.cartridge.NavigationCartridgeHandler<Config,Model> com.endeca.infront.cartridge.ResultsListHandler
public class ResultsListHandler
Handler for the ResultsList
cartridge.
Constructor Summary | |
---|---|
ResultsListHandler()
|
Method Summary | |
---|---|
protected List<String> |
combineFieldNames(NavigationState navigationState,
com.endeca.infront.cartridge.FieldNamesConfig config)
Updates the list of string for retaining representative record properties. |
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 |
retainFields(Map<String,Attribute> attributeMap,
com.endeca.infront.cartridge.FieldNamesConfig config,
boolean aggregationEnabled)
Helper method for retaining properties. |
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, getActionPathProvider, getContentItemInitializer, getMdexRequestBroker, getNavigationState, populateNavigationPathDefaults, setActionPathProvider, setContentItemInitializer, setMdexRequestBroker, setNavigationState |
Methods inherited from class java.lang.Object |
---|
clone, equals, finalize, getClass, hashCode, notify, notifyAll, toString, wait, wait, wait |
Constructor Detail |
---|
public ResultsListHandler()
Method Detail |
---|
public List<SortOptionConfig> getSortOptions()
public void setSortOptions(List<SortOptionConfig> sortOptions)
getSortOptions()
public ResultsListConfig initialize(ContentItem pContentItem) throws CartridgeHandlerException
initialize
in interface CartridgeHandler<ResultsListConfig>
initialize
in class NavigationCartridgeHandler<ResultsListConfig,ResultsList>
pContentItem
- cartridge instance configuration, typically
from Experience Manager.
NavigationCartridgeHandler.preprocess(ConfigType)
or NavigationCartridgeHandler.process(ConfigType)
methods.
CartridgeHandlerException
- if an error occurs that is scoped to
an individual cartridge instance (for instance, the handler is unable to access its
default configuration). This exception will not halt the entire assembly process,
which occurs across multiple cartridges; instead, this exception will be packaged in the
overall response model. If an unchecked exception is thrown, then the entire assembly process
will be halted.NavigationCartridgeHandler.setContentItemInitializer(ContentItemInitializer)
,
NavigationCartridgeHandler.wrapConfig(ContentItem)
protected ResultsListConfig wrapConfig(ContentItem pContentItem)
NavigationCartridgeHandler
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.
wrapConfig
in class NavigationCartridgeHandler<ResultsListConfig,ResultsList>
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.
ConfigType
which wraps the input ContentItem
.NavigationCartridgeHandler.initialize(ContentItem)
,
NavigationCartridgeHandler.setContentItemInitializer(ContentItemInitializer)
public void preprocess(ResultsListConfig cartridgeConfig) throws CartridgeHandlerException
preprocess
in interface CartridgeHandler<ResultsListConfig>
preprocess
in class NavigationCartridgeHandler<ResultsListConfig,ResultsList>
cartridgeConfig
- the cartridge configuration returned by
CartridgeHandler.initialize(ContentItem)
. This cartridge configuration may
be modified by this handler. Note that this cartridge configuration is
also passed to CartridgeHandler.process(ContentItem)
.
CartridgeHandlerException
- if an error occurs that is scoped to
an individual cartridge instance. This exception will not halt
the entire assembly process, which occurs across multiple cartridges;
instead, this exception will be packaged in the overall response model.
If an unchecked exception is thrown, then the entire assembly process
will be halted.public ResultsList process(ResultsListConfig cartridgeConfig) throws CartridgeHandlerException
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.
process
in interface CartridgeHandler<ResultsListConfig>
process
in class NavigationCartridgeHandler<ResultsListConfig,ResultsList>
cartridgeConfig
- the cartridge configuration returned by
CartridgeHandler.initialize(ContentItem)
. Note that this instance may have been modified by
the CartridgeHandler.preprocess(ContentItem)
method.
CartridgeHandlerException
- if an error occurs that is scoped to
an individual cartridge instance. This exception will not halt
the entire assembly process, which occurs across multiple cartridges;
instead, this exception will be packaged in the overall response model.
If an unchecked exception is thrown, then the entire assembly process
will be halted.protected void dispatchNavigationEventInformation(ResultsListConfig cartridgeConfig, ResultsList resultsList)
protected void retainFields(Map<String,Attribute> attributeMap, com.endeca.infront.cartridge.FieldNamesConfig config, boolean aggregationEnabled)
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.RecordBasedNavigationCartridgeHandler.retainFields(java.util.Map, FieldNamesConfig,
boolean)
protected List<String> combineFieldNames(NavigationState navigationState, com.endeca.infront.cartridge.FieldNamesConfig config) throws CartridgeHandlerException
CartridgeHandlerException
protected static long getTotalNumRecs(com.endeca.navigation.ENEQueryResults results)
protected List<Record> createRecords(com.endeca.navigation.ENEQueryResults results, NavigationState navigationState, com.endeca.infront.cartridge.FieldNamesConfig config)
results
- result of MDEX query.navigationState
- base navigation state for record details links. If null, record details links are omitted.
|
||||||||||
PREV CLASS NEXT CLASS | FRAMES NO FRAMES | |||||||||
SUMMARY: NESTED | FIELD | CONSTR | METHOD | DETAIL: FIELD | CONSTR | METHOD |