org.broadleafcommerce.common.sitemap.service

Interface SiteMapGenerator

All Known Implementing Classes:

CustomUrlSiteMapGenerator

public interface SiteMapGenerator

Responsible for generating site map entries. Each SiteMapGenerator can generate

Author:

bpolster

Method Summary

Methods

Modifier and Type	Method and Description
void	addSiteMapEntries(SiteMapGeneratorConfiguration siteMapGeneratorConfiguration, SiteMapBuilder siteMapBuilder) Typically, the generator will loop through and build a list of URLs to add to the sitemap by calling methods on the SiteMapBuilder.
boolean	canHandleSiteMapConfiguration(SiteMapGeneratorConfiguration siteMapGeneratorConfiguration) Returns true if this SiteMapGenerator is able to process the passed in siteMapGeneratorConfiguration.

Method Detail

canHandleSiteMapConfiguration

boolean canHandleSiteMapConfiguration(SiteMapGeneratorConfiguration siteMapGeneratorConfiguration)

Returns true if this SiteMapGenerator is able to process the passed in siteMapGeneratorConfiguration.

Parameters:

siteMapGeneratorConfiguration -

Returns:

addSiteMapEntries

void addSiteMapEntries(SiteMapGeneratorConfiguration siteMapGeneratorConfiguration,
                     SiteMapBuilder siteMapBuilder)

Typically, the generator will loop through and build a list of URLs to add to the sitemap by calling methods on the SiteMapBuilder.

Parameters:

siteMapGeneratorConfiguration -

siteMapBuilder -