atg.endeca.assembler.cartridge.renderer
Interface ReplacementValueProducer

All Known Implementing Classes:

SelectorReplacementValueProducer

public interface ReplacementValueProducer

An interface used with ContentItemToRendererPath implementations. A ReplacementValueProducer helps populate the map of values available for replacement to a MapFormatString.

Created: May 22 2012

See Also:

MapFormatString

Field Summary

static java.lang.String

CLASS_VERSION Class version string

Method Summary

void	addReplacementValues(java.util.Map<java.lang.String,java.lang.String> pMap, ContentItem pContentItem, javax.servlet.http.HttpServletRequest pRequest) Add any replacement values to pMap.

Field Detail

CLASS_VERSION

static final java.lang.String CLASS_VERSION

Class version string

See Also:

Constant Field Values

Method Detail

addReplacementValues

void addReplacementValues(java.util.Map<java.lang.String,java.lang.String> pMap,
                          ContentItem pContentItem,
                          javax.servlet.http.HttpServletRequest pRequest)

Add any replacement values to pMap. Note that a given instance may add a single value, multiple values, or none.

Parameters:

pMap - the map to add parameters to.

pContentItem - the ContentItem (available for reference and calculating replacement values based on the content item). ContentItem should not be modified.

pRequest - the current request. May be null, if invoked outside of a request.