atg.projects.store.assembler.cartridge.handler

Class LocationSearchRadiusHandler

java.lang.Object

com.endeca.infront.cartridge.NavigationCartridgeHandler<com.endeca.infront.assembler.ContentItem,LocationSearchRadiusContentItem>

atg.projects.store.assembler.cartridge.handler.LocationSearchRadiusHandler

All Implemented Interfaces:

com.endeca.infront.assembler.CartridgeHandler<com.endeca.infront.assembler.ContentItem>

public class LocationSearchRadiusHandler
extends com.endeca.infront.cartridge.NavigationCartridgeHandler<com.endeca.infront.assembler.ContentItem,LocationSearchRadiusContentItem>

Handler for the location search radius cartridge. This class is responsible for creating and initializing the LocationSearchRadiusContentItem. It extends the NavigationCartridgeHandler.

Version:

$Id: //hosting-blueprint/B2CBlueprint/version/11.3/Endeca/Assembler/src/atg/projects/store/assembler/cartridge/handler/LocationSearchRadiusHandler.java#1 $$Change: 1385662 $

Author:

Oracle

Field Summary

Fields

Modifier and Type	Field and Description
static java.lang.String	CLASS_VERSION Class version string.

Constructor Summary

Constructors

Constructor and Description
LocationSearchRadiusHandler()

Method Summary

Modifier and Type	Method and Description
java.util.List<java.lang.String>	getSearchRadius()
java.util.List<java.lang.String>	getSortedSearchRadius() Returns sorted list of search radius
void	preprocess(com.endeca.infront.assembler.ContentItem pCartridgeConfig) Currently only used to create an MdexRequest.
LocationSearchRadiusContentItem	process(com.endeca.infront.assembler.ContentItem pCartridgeConfig) Create a new LocationSearchRadiusContentItem.
void	setSearchRadius(java.util.List<java.lang.String> pSearchRadius)
protected com.endeca.infront.assembler.ContentItem	wrapConfig(com.endeca.infront.assembler.ContentItem pContentItem) Create a new BasicContentItem using the passed in ContentItem.

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

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

CLASS_VERSION

public static final java.lang.String CLASS_VERSION

Class version string.

See Also:

Constant Field Values

Constructor Detail

LocationSearchRadiusHandler

public LocationSearchRadiusHandler()

Method Detail

setSearchRadius

public void setSearchRadius(java.util.List<java.lang.String> pSearchRadius)

Parameters:

pSearchRadius - The Search Radius list to be displayed on screen.

getSearchRadius

public java.util.List<java.lang.String> getSearchRadius()

Returns:

The Search Radius to be used.

getSortedSearchRadius

public java.util.List<java.lang.String> getSortedSearchRadius()

Returns sorted list of search radius

Returns:

Sorted list of search radius.

wrapConfig

protected com.endeca.infront.assembler.ContentItem wrapConfig(com.endeca.infront.assembler.ContentItem pContentItem)

Create a new BasicContentItem using the passed in ContentItem.

Specified by:

wrapConfig in class com.endeca.infront.cartridge.NavigationCartridgeHandler<com.endeca.infront.assembler.ContentItem,LocationSearchRadiusContentItem>

Parameters:

pContentItem - The configuration content item 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 BasicContentItem which wraps the input ContentItem.

preprocess

public void preprocess(com.endeca.infront.assembler.ContentItem pCartridgeConfig)
                throws com.endeca.infront.assembler.CartridgeHandlerException

Currently only used to create an MdexRequest. Does not execute it.

Specified by:

preprocess in interface com.endeca.infront.assembler.CartridgeHandler<com.endeca.infront.assembler.ContentItem>

Overrides:

preprocess in class com.endeca.infront.cartridge.NavigationCartridgeHandler<com.endeca.infront.assembler.ContentItem,LocationSearchRadiusContentItem>

Parameters:

pCartridgeConfig - The LocationSearchRadius refinement cartridge configuration.

Throws:

com.endeca.infront.assembler.CartridgeHandlerException - if the operation fails.

process

public LocationSearchRadiusContentItem process(com.endeca.infront.assembler.ContentItem pCartridgeConfig)
                                        throws com.endeca.infront.assembler.CartridgeHandlerException

Create a new LocationSearchRadiusContentItem.

Specified by:

process in interface com.endeca.infront.assembler.CartridgeHandler<com.endeca.infront.assembler.ContentItem>

Overrides:

process in class com.endeca.infront.cartridge.NavigationCartridgeHandler<com.endeca.infront.assembler.ContentItem,LocationSearchRadiusContentItem>

Parameters:

pCartridgeConfig - The Geo Filter cartridge configuration.

Returns:

A LocationSearchRadiusContentItem with search radius configured.

Throws:

com.endeca.infront.assembler.CartridgeHandlerException - if a NavigationException is caught.