atg.commerce.endeca.index.producer

Class PriceListPairVariantProducer

java.lang.Object

atg.nucleus.logging.VariableArgumentApplicationLoggingImpl

atg.nucleus.GenericService

atg.commerce.endeca.index.producer.PriceListPairVariantProducer

All Implemented Interfaces:

atg.core.logging.Logging, atg.core.logging.TraceLogging, atg.naming.AbsoluteNameable, NameContextBindingListener, NameContextElement, atg.naming.NameContextParentable, NameResolver, AdminableService, atg.nucleus.Configured, ApplicationLogging, atg.nucleus.logging.ApplicationLoggingSender, atg.nucleus.logging.TraceApplicationLogging, VariableArgumentApplicationLogging, ComponentNameResolver, Service, ServiceListener, VariantProducer, java.util.EventListener

public class PriceListPairVariantProducer
extends GenericService
implements VariantProducer

This class creates sets of pricelists for given sites. One variant is produced for each distinct set of pricelists. This default implementation determines avaiable pricelist pairs (or singletons, if no sale price exists) by iterating over sites and collecting those sites list and sale price lists. Depending on how pricelists are determined for a given commerce implementation, this class may need subclassed or replaced.

Nested Class Summary

Nested Classes

Modifier and Type	Class and Description
class	PriceListPairVariantProducer.PriceListsData The data about available PriceLists.

Field Summary

Fields

Modifier and Type	Field and Description
static java.lang.String	CLASS_VERSION Class version string
protected java.lang.String	mLanguagesPropertyName
static java.lang.String	PRICE_LIST_IDS_KEY The context attribute for the pricelistIds ("price list pair", even though it may only contain a list price list ID if there is no sale price) for the current product.
static java.lang.String	PRICE_LISTS_DATA_KEY The global context attribute for the PriceListData for the current indexing run.
static java.lang.String	PRICE_LISTS_IDS_INDEX_KEY The context attribute for the current price list pair's index into the PriceListData's priceListIdArray().

Fields inherited from class atg.nucleus.GenericService

SERVICE_INFO_KEY

Fields inherited from interface atg.nucleus.logging.TraceApplicationLogging

DEFAULT_LOG_TRACE_STATUS

Fields inherited from interface atg.nucleus.logging.ApplicationLogging

DEFAULT_LOG_DEBUG_STATUS, DEFAULT_LOG_ERROR_STATUS, DEFAULT_LOG_INFO_STATUS, DEFAULT_LOG_WARNING_STATUS

Constructor Summary

Constructors

Constructor and Description
PriceListPairVariantProducer()

Method Summary

Modifier and Type	Method and Description
protected void	addAdditionalPriceListsForSite(Context pContext, Site pSite, java.util.List<java.lang.String> pSiteLanguages, java.util.Set<java.util.List<java.lang.String>> pPriceListIdLists, java.util.Map<java.lang.String,java.util.List<java.lang.String>> pPriceListLanguages) Add any additional price lists for the specified site.
protected void	addPriceListLanguages(java.lang.String pPriceListId, java.util.List<java.lang.String> pLanguages, java.util.Map<java.lang.String,java.util.List<java.lang.String>> pPriceListLanguages) Add a list of languages to the price list to languages map for a price list.
protected PriceListPairVariantProducer.PriceListsData	createPriceListsData() Create a new instance of PriceListsData, which will be store as a global attribute on the Context object.
void	determinePriceLists(Context pContext, java.lang.String pPropertyName, RepositoryItem pItem, int pIndex, java.util.Map pUniqueParams) Determine price lists based on the context, specifically on the set of sites.
protected java.util.List<java.lang.String>	getLanguagesForSite(Site pSite) This method returns a list of language codes for a site.
java.lang.String	getLanguagesPropertyName()
PriceListManager	getPriceListManager()
java.lang.String	getPriceListPairUniqueParamName() Get the site unique parameter name.
char	getSeparator() Returns property mSeparator.
SiteContextManager	getSiteContextManager()
protected java.util.Set<java.lang.String>	getSiteIdsForPriceListPairs(Context pContext) Return the set of SiteIDs from which to calculate PriceListPairs.
protected boolean	isPricelistRelevant(Context pContext, PriceListPairVariantProducer.PriceListsData pPriceListsData, RepositoryItem pItem, java.lang.String pLanguage, java.util.List<java.lang.String> pPriceListIds) Return whether the current pricelist pair represented by pPriceListId is relevant to the current indexing context.
protected void	populatePriceListsData(Context pContext, PriceListPairVariantProducer.PriceListsData pPriceListData) Populate the PriceListData object pPriceListData by calculating current approriate pricelists and associated languages and setting the relevant properties of PriceListData.
boolean	prepareNextVariant(Context pContext, java.lang.String pPropertyName, RepositoryItem pItem, int pIndex, java.util.Map pUniqueParams) Get the next (perhaps only) variant.
void	setLanguagesPropertyName(java.lang.String pLanguagesPropertyName)
void	setPriceListManager(PriceListManager pPriceListManager)
void	setPriceListPairUniqueParamName(java.lang.String pPriceListPairUniqueParamName) Set the site unique parameter name.
void	setSeparator(char pSeparator) Sets property mSeparator.
void	setSiteContextManager(SiteContextManager pSiteContextManager)
protected boolean	shouldAddDefaultSitePriceLists() Whether to add the default site pricelists, obtained by invoked PriceListManager.getPriceListForSite.

Methods inherited from class atg.nucleus.GenericService

addLogListener, createAdminServlet, doStartService, doStopService, getAbsoluteName, getAdminServlet, getAdminServletOutputStreamEncoding, getLoggingForVlogging, getLogListenerCount, getLogListeners, getName, getNameContext, getNucleus, getRoot, getServiceConfiguration, getServiceInfo, isAdminServletUseServletOutputStream, isLoggingDebug, isLoggingError, isLoggingInfo, isLoggingTrace, isLoggingWarning, isRunning, logDebug, logDebug, logDebug, logError, logError, logError, logInfo, logInfo, logInfo, logTrace, logTrace, logTrace, logWarning, logWarning, logWarning, nameContextElementBound, nameContextElementUnbound, removeLogListener, reResolveThis, resolveName, resolveName, resolveName, resolveName, sendLogEvent, setAdminServletOutputStreamEncoding, setAdminServletUseServletOutputStream, setLoggingDebug, setLoggingError, setLoggingInfo, setLoggingTrace, setLoggingWarning, setNucleus, setServiceInfo, startService, stopService, toString

Methods inherited from class atg.nucleus.logging.VariableArgumentApplicationLoggingImpl

vlogDebug, vlogDebug, vlogDebug, vlogDebug, vlogDebugTrace, vlogError, vlogError, vlogError, vlogError, vlogInfo, vlogInfo, vlogInfo, vlogInfo, vlogTrace, vlogTrace, vlogTrace, vlogTrace, vlogWarning, vlogWarning, vlogWarning, vlogWarning

Methods inherited from class java.lang.Object

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

Field Detail

CLASS_VERSION

public static java.lang.String CLASS_VERSION

Class version string

PRICE_LIST_IDS_KEY

public static final java.lang.String PRICE_LIST_IDS_KEY

The context attribute for the pricelistIds ("price list pair", even though it may only contain a list price list ID if there is no sale price) for the current product.

See Also:

Constant Field Values

PRICE_LISTS_DATA_KEY

public static final java.lang.String PRICE_LISTS_DATA_KEY

The global context attribute for the PriceListData for the current indexing run.

See Also:

Constant Field Values

PRICE_LISTS_IDS_INDEX_KEY

public static final java.lang.String PRICE_LISTS_IDS_INDEX_KEY

The context attribute for the current price list pair's index into the PriceListData's priceListIdArray().

See Also:

Constant Field Values

mLanguagesPropertyName

protected java.lang.String mLanguagesPropertyName

Constructor Detail

PriceListPairVariantProducer

public PriceListPairVariantProducer()

Method Detail

getPriceListManager

public PriceListManager getPriceListManager()

Returns:

PriceListManager Get the PriceListManager component.

setPriceListManager

public void setPriceListManager(PriceListManager pPriceListManager)

Parameters:

pPriceListManager - Sets a new PriceListManager component.

getSiteContextManager

public SiteContextManager getSiteContextManager()

Returns:

the mSiteContextManager

setSiteContextManager

public void setSiteContextManager(SiteContextManager pSiteContextManager)

Parameters:

mSiteContextManager - the mSiteContextManager to set

setPriceListPairUniqueParamName

public void setPriceListPairUniqueParamName(java.lang.String pPriceListPairUniqueParamName)

Set the site unique parameter name.

getPriceListPairUniqueParamName

public java.lang.String getPriceListPairUniqueParamName()

Get the site unique parameter name.

setSeparator

public void setSeparator(char pSeparator)

Sets property mSeparator.

getSeparator

public char getSeparator()

Returns property mSeparator.

getLanguagesPropertyName

public java.lang.String getLanguagesPropertyName()

Returns:

the String

setLanguagesPropertyName

public void setLanguagesPropertyName(java.lang.String pLanguagesPropertyName)

Parameters:

pLanguagesPropertyName - the String to set

prepareNextVariant

public boolean prepareNextVariant(Context pContext,
                                  java.lang.String pPropertyName,
                                  RepositoryItem pItem,
                                  int pIndex,
                                  java.util.Map pUniqueParams)

Get the next (perhaps only) variant. This method is invoked before values for a given document are obtained. A minimal implementation would return true once per item.

Specified by:

prepareNextVariant in interface VariantProducer

Parameters:

pContext - The current context. Contains the current URL, the stack of parent items, etc.

pPropertyName - the name of the property that corresponds to pItem. For a top-level item, will be null.

pItem - the document-level (is-document) repository item.

pIndex - the index/count for the variant. This index only applies to the current set of parents.

pUniqueParams - the parameters that will be added to the item's URI to differentiate it from other documents representing the same repository item. Keys and values should all be strings.

Returns:

True if the next variant was prepared and a document should be generated. False if no document should be generated.

createPriceListsData

protected PriceListPairVariantProducer.PriceListsData createPriceListsData()

Create a new instance of PriceListsData, which will be store as a global attribute on the Context object.

determinePriceLists

public void determinePriceLists(Context pContext,
                                java.lang.String pPropertyName,
                                RepositoryItem pItem,
                                int pIndex,
                                java.util.Map pUniqueParams)

Determine price lists based on the context, specifically on the set of sites. Pricelists are stored in priceListIdArray property of the PriceListData attribute of the PriceListData. . If pricelists are not in use, mPriceListIdArray is empty This method should be overridden when price lists are determined otherwise This method has the same parameters as method prepareNextVariant

populatePriceListsData

protected void populatePriceListsData(Context pContext,
                                      PriceListPairVariantProducer.PriceListsData pPriceListData)
                               throws RepositoryException,
                                      SiteContextException

Populate the PriceListData object pPriceListData by calculating current approriate pricelists and associated languages and setting the relevant properties of PriceListData.

Parameters:

pContext - the current indexing context.

pPriceListData - the price list data object to populate.

Throws:

RepositoryException

SiteContextException

addPriceListLanguages

protected void addPriceListLanguages(java.lang.String pPriceListId,
                                     java.util.List<java.lang.String> pLanguages,
                                     java.util.Map<java.lang.String,java.util.List<java.lang.String>> pPriceListLanguages)

Add a list of languages to the price list to languages map for a price list. Will only add languages that are not already in the map for this price list id.

Parameters:

pPriceListId - price list id

pLanguages - languages to add to map of price list to languages

pPriceListLanguages - map of price list to languages

getSiteIdsForPriceListPairs

protected java.util.Set<java.lang.String> getSiteIdsForPriceListPairs(Context pContext)

Return the set of SiteIDs from which to calculate PriceListPairs. Returns, by default, pContext.getIndexInfo().getSiteIndexInfo().getSiteIds().

Returns:

the set of sites to iterate looking for associate price list pairs.

isPricelistRelevant

protected boolean isPricelistRelevant(Context pContext,
                                      PriceListPairVariantProducer.PriceListsData pPriceListsData,
                                      RepositoryItem pItem,
                                      java.lang.String pLanguage,
                                      java.util.List<java.lang.String> pPriceListIds)

Return whether the current pricelist pair represented by pPriceListId is relevant to the current indexing context. By default, returns true if the pricelist pair's languages match the current language, or if there is no language associated with the pricelist price (languages obtained from pPriceListData.getPriceListLanguages().

Parameters:

pContext - the current indexing context.

pLanguage - the current language being indexed (as calculated from the currentDocumentLocale of pContext).

pPriceListData - the PriceListData representing available pricelist pairs and associated language information.

pPriceListIds - the pair of pricelist IDs in question

pItem - the current repository item on whose behalf a variant is being produced.

Returns:

true if the pricelist pair is relevant, false otherwise. Returning false will skip generating a variant for this price list pair.

getLanguagesForSite

protected java.util.List<java.lang.String> getLanguagesForSite(Site pSite)

This method returns a list of language codes for a site. It is repository dependent and used if property languagesPropertyName is undefined (null), and is invoked from determinePriceLists. If used, this method should be overwritten in a subclass

shouldAddDefaultSitePriceLists

protected boolean shouldAddDefaultSitePriceLists()

Whether to add the default site pricelists, obtained by invoked PriceListManager.getPriceListForSite. Returns true by default. This method is provided in case sub-classes wish to avoid adding the default price lists (but will presumably still add price lists in addAdditionalPriceListsForSite()).

Returns:

true if

addAdditionalPriceListsForSite

protected void addAdditionalPriceListsForSite(Context pContext,
                                              Site pSite,
                                              java.util.List<java.lang.String> pSiteLanguages,
                                              java.util.Set<java.util.List<java.lang.String>> pPriceListIdLists,
                                              java.util.Map<java.lang.String,java.util.List<java.lang.String>> pPriceListLanguages)
                                       throws RepositoryException,
                                              SiteContextException

Add any additional price lists for the specified site. The base implementation does nothing.

Parameters:

pContext - the current indexing context.

pSite - the site in question

pSiteLanguages - the languages associate with pSite. May be null.

pPriceListIdLists -

pPriceListsData - a set of pricelist ID lists. Each list should have one (list price list ID) or two (list price list ID and sale price list ID) items.

Throws:

RepositoryException

SiteContextException