com.endeca.infront.cartridge

Class BreadcrumbsHandler

java.lang.Object

com.endeca.infront.cartridge.NavigationCartridgeHandler<BreadcrumbsConfig,Breadcrumbs>

com.endeca.infront.cartridge.BreadcrumbsHandler

public class BreadcrumbsHandler
extends NavigationCartridgeHandler<BreadcrumbsConfig,Breadcrumbs>

Cartridge handler that creates Breadcrumbs model objects.

Constructor Summary

Constructors

Constructor and Description
BreadcrumbsHandler()

Method Summary

Methods

Modifier and Type	Method and Description
void	preprocess(BreadcrumbsConfig cartridgeConfig) Creates a breadcrumbs MDEX query.
Breadcrumbs	process(BreadcrumbsConfig cartridgeConfig) Creates a simple Breadcrumbs model.
protected BreadcrumbsConfig	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, getContentItemInitializer, getMdexRequestBroker, getNavigationState, getSiteState, initialize, populateNavigationPathDefaults, setActionPathProvider, setContentItemInitializer, setMdexRequestBroker, setNavigationState, setSiteState

Methods inherited from class java.lang.Object

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

Constructor Detail

BreadcrumbsHandler

public BreadcrumbsHandler()

Method Detail

wrapConfig

protected BreadcrumbsConfig 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<BreadcrumbsConfig,Breadcrumbs>

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

Creates a breadcrumbs MDEX query.

Overrides:

preprocess in class NavigationCartridgeHandler<BreadcrumbsConfig,Breadcrumbs>

Throws:

CartridgeHandlerException

process

public Breadcrumbs process(BreadcrumbsConfig cartridgeConfig)
                    throws CartridgeHandlerException

Creates a simple Breadcrumbs model. Subclasses can override the method to create more complex models.

Overrides:

process in class NavigationCartridgeHandler<BreadcrumbsConfig,Breadcrumbs>

Throws:

CartridgeHandlerException