org.opencms.ade.detailpage

Class CmsSitemapDetailPageFinder

java.lang.Object

org.opencms.ade.detailpage.CmsSitemapDetailPageFinder

All Implemented Interfaces:

I_CmsDetailPageFinder

public class CmsSitemapDetailPageFinder
extends java.lang.Object
implements I_CmsDetailPageFinder

This class uses information from the detail page information stored in the sitemap to find the detail page for a given resource.

Since:

8.0.0

Constructor Summary

Constructors

Constructor and Description
CmsSitemapDetailPageFinder()

Method Summary

Modifier and Type	Method and Description
java.util.Collection<java.lang.String>	getAllDetailPages(CmsObject cms, int resType) Finds all detail pages for a given resource.
java.lang.String	getDetailPage(CmsObject cms, java.lang.String rootPath, java.lang.String linkSource, java.lang.String targetDetailPage) Returns the detail page link for the given resource, or null if there is no detail page for the resource.

Methods inherited from class java.lang.Object

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

Constructor Detail

CmsSitemapDetailPageFinder

public CmsSitemapDetailPageFinder()

Method Detail

getAllDetailPages

public java.util.Collection<java.lang.String> getAllDetailPages(CmsObject cms,
                                                                int resType)
                                                         throws CmsException

Description copied from interface: I_CmsDetailPageFinder

Finds all detail pages for a given resource.

Specified by:

getAllDetailPages in interface I_CmsDetailPageFinder

Parameters:

cms - the current CMS context

resType - the resource type for which the detail pages should be found

Returns:

the list of detail page

Throws:

CmsException - in case reading the resource type fails

See Also:

I_CmsDetailPageFinder.getAllDetailPages(org.opencms.file.CmsObject, int)

getDetailPage

public java.lang.String getDetailPage(CmsObject cms,
                                      java.lang.String rootPath,
                                      java.lang.String linkSource,
                                      java.lang.String targetDetailPage)

Description copied from interface: I_CmsDetailPageFinder

Returns the detail page link for the given resource, or null if there is no detail page for the resource.

Specified by:

getDetailPage in interface I_CmsDetailPageFinder

Parameters:

cms - the CMS context

rootPath - the root path of the resource for which the detail page should be looked up

linkSource - the uri in the context of which the detail page link is being generated (relative to the site)

targetDetailPage - the target detail page to use

Returns:

the detail page link, or null

See Also:

I_CmsDetailPageFinder.getDetailPage(org.opencms.file.CmsObject, java.lang.String, java.lang.String, java.lang.String)