Package lumis.portal.page.webresource

Class AbstractPageWebResourceDataProvider

java.lang.Object

lumis.portal.page.webresource.AbstractPageWebResourceDataProvider

All Implemented Interfaces:

IPageWebResourceDataProvider

Direct Known Subclasses:

DefaultPageWebResourceDataProvider

@StableMinor(version="16.0",
             sinceVersion="5.0")
public abstract class AbstractPageWebResourceDataProvider
extends java.lang.Object
implements IPageWebResourceDataProvider

An abstract implementation of IPageWebResourceDataProvider.

Since:

5.0.0

Version:

$Revision: 25808 $ $Date: 2023-07-04 15:20:55 -0300 (Tue, 04 Jul 2023) $

Field Summary

Fields

Modifier and Type	Field	Description
protected PageWebResource	pageWebResource	The page web resource this provider is generating data for.

Constructor Summary

Constructors

Constructor	Description
AbstractPageWebResourceDataProvider()

Method Summary

Modifier and Type	Method	Description
protected java.net.URL	getCanonicalUrl()	Returns the URL used for the canonical URL link element for the pageWebResource.
protected abstract java.lang.String	getDescription()	Returns the description for the page web resource.
protected abstract java.util.List<java.lang.String>	getKeywords()	Returns the keywords for the page web resource.
protected java.util.Map<java.lang.String,java.lang.String>	getMetaTags()	Returns the meta tags map for the page web resource.
PageWebResourceData	getPageWebResourceData()	Template method for filling up a page web resource data properties.
protected abstract java.lang.String	getSimpleTitle()	Returns the simple title for the page web resource.
protected abstract java.lang.String	getTitle()	Returns the title for the page web resource.
protected java.lang.String	getUrlPath()	Returns the URL path.
protected java.lang.String	getUrlTitle()	Returns the title to be used when generating the URL of the page web resource.
void	init(PageWebResource pageWebResource)	Sets pageWebResource attribute with the given pageWebResource object.

Methods inherited from class java.lang.Object

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

Field Detail

pageWebResource

protected PageWebResource pageWebResource

The page web resource this provider is generating data for.

Since:

5.0.0

Constructor Detail

AbstractPageWebResourceDataProvider

public AbstractPageWebResourceDataProvider()

Method Detail

init

public void init(PageWebResource pageWebResource)
          throws PortalException

Sets pageWebResource attribute with the given pageWebResource object.

Specified by:

init in interface IPageWebResourceDataProvider

Parameters:

pageWebResource - the page web resource this provider will provide data for.

Throws:

PortalException

Since:

5.0.0

getPageWebResourceData

public PageWebResourceData getPageWebResourceData()
                                           throws PortalException

Template method for filling up a page web resource data properties. Calls getTitle(), getDescription() and getKeywords().

Specified by:

getPageWebResourceData in interface IPageWebResourceDataProvider

Returns:

the page web resource data.

Throws:

PortalException

Since:

5.0.0

getTitle

protected abstract java.lang.String getTitle()
                                      throws PortalException

Returns the title for the page web resource.

Returns:

the title. Must not be null.

Throws:

PortalException

Since:

5.0.0

getSimpleTitle

protected abstract java.lang.String getSimpleTitle()
                                            throws PortalException

Returns the simple title for the page web resource.

Returns:

the simple title. Must not be null.

Throws:

PortalException

Since:

10.2.0

getUrlTitle

protected java.lang.String getUrlTitle()
                                throws PortalException

Returns the title to be used when generating the URL of the page web resource.

Returns:

the title, or null if there is no specific title for URL generation.

Throws:

PortalException

Since:

10.0.0

getDescription

protected abstract java.lang.String getDescription()
                                            throws PortalException

Returns the description for the page web resource.

Returns:

the description.

Throws:

PortalException

Since:

5.0.0

getCanonicalUrl

protected java.net.URL getCanonicalUrl()
                                throws PortalException

Returns the URL used for the canonical URL link element for the pageWebResource.

Returns:

the canonical URL, or null if the web resource does not have a canonical URL.

Throws:

PortalException

Since:

10.1.0

getKeywords

protected abstract java.util.List<java.lang.String> getKeywords()
                                                         throws PortalException

Returns the keywords for the page web resource.

Returns:

the keywords. Must not be null, but may be an empty list to indicate there are no keywords.

Throws:

PortalException

Since:

5.0.0

getMetaTags

protected java.util.Map<java.lang.String,java.lang.String> getMetaTags()
                                                                      throws PortalException

Returns the meta tags map for the page web resource.

Returns:

the meta tags map.

Throws:

PortalException

Since:

6.0.0

getUrlPath

protected java.lang.String getUrlPath()

Returns the URL path.

Returns:

the URL path.

Since:

12.5.0