Package org.opencms.site.xmlsitemap

Class CmsDetailPageDuplicateEliminatingSitemapGenerator

java.lang.Object

org.opencms.site.xmlsitemap.CmsXmlSitemapGenerator

org.opencms.site.xmlsitemap.CmsDetailPageDuplicateEliminatingSitemapGenerator

public class CmsDetailPageDuplicateEliminatingSitemapGenerator
extends CmsXmlSitemapGenerator

Sitemap generator class which tries to eliminate duplicate detail pages for the same content and locale.

In principle, any detail page for a type somewhere in the system could be used to display contents anywhere else in the system. This sitemap generator, instead of generating all detail page URLs that could possibly be generated, instead tries to find only the best candidate URL for each content / locale combination.

Nested Class Summary

Nested classes/interfaces inherited from class org.opencms.site.xmlsitemap.CmsXmlSitemapGenerator

CmsXmlSitemapGenerator.ResultEntry

Field Summary

Fields

Modifier and Type	Field	Description
protected java.util.List<CmsADEConfigData.DetailInfo>	m_detailInfos	The detail page information.

Fields inherited from class org.opencms.site.xmlsitemap.CmsXmlSitemapGenerator

DEFAULT_CHANGE_FREQUENCY, DEFAULT_PRIORITY, m_baseFolderRootPath, m_baseFolderSitePath, m_computeContainerPageDates, m_detailPageInfos, m_detailResources, m_detailTypesByPage, m_guestCms, m_includeExcludeSet, m_pageAliasesBelowBaseFolderByStructureId, m_resultMap, m_siteGuestCms, m_siteRoot, m_siteRootLink

Constructor Summary

Constructors

Constructor	Description
CmsDetailPageDuplicateEliminatingSitemapGenerator(java.lang.String sitemapPath)	Constructor.

Method Summary

Modifier and Type	Method	Description
protected void	addDetailLinks(CmsResource containerPage, java.util.Locale locale)	Adds the detail page links for a given page to the results.
java.util.List<CmsXmlSitemapUrlBean>	generateSitemapBeans()	Generates a list of XML sitemap entry beans for the root folder which has been set in the constructor.

Methods inherited from class org.opencms.site.xmlsitemap.CmsXmlSitemapGenerator

addResult, computeContainerPageModificationDate, getChangeFrequency, getDetailLink, getDetailTypesForPage, getDirectPages, getIncludeExcludeSet, getInnerXmlForEntry, getNavigationPages, getPriority, getUrlSetOpenTag, getXmlForEntry, isAliasBelowBaseFolder, isValidDetailPageCombination, removeInternalFiles, renderSitemap, replaceServerUri, replaceServerUri, setComputeContainerPageDates, setServerUrl

Methods inherited from class java.lang.Object

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

Field Detail

m_detailInfos

protected java.util.List<CmsADEConfigData.DetailInfo> m_detailInfos

The detail page information.

Constructor Detail

CmsDetailPageDuplicateEliminatingSitemapGenerator

public CmsDetailPageDuplicateEliminatingSitemapGenerator(java.lang.String sitemapPath)
                                                  throws CmsException

Constructor.

Parameters:

sitemapPath - the sitemap path

Throws:

CmsException - if something goes wrong

Method Detail

generateSitemapBeans

public java.util.List<CmsXmlSitemapUrlBean> generateSitemapBeans()
                                                          throws CmsException

Description copied from class: CmsXmlSitemapGenerator

Generates a list of XML sitemap entry beans for the root folder which has been set in the constructor.

Overrides:

generateSitemapBeans in class CmsXmlSitemapGenerator

Returns:

the list of XML sitemap entries

Throws:

CmsException - if something goes wrong

See Also:

CmsXmlSitemapGenerator.generateSitemapBeans()

addDetailLinks

protected void addDetailLinks(CmsResource containerPage,
                              java.util.Locale locale)
                       throws CmsException

Description copied from class: CmsXmlSitemapGenerator

Adds the detail page links for a given page to the results.

Overrides:

addDetailLinks in class CmsXmlSitemapGenerator

Parameters:

containerPage - the container page resource

locale - the locale of the container page

Throws:

CmsException - if something goes wrong

See Also:

CmsXmlSitemapGenerator.addDetailLinks(org.opencms.file.CmsResource, java.util.Locale)