Package org.opencms.site.xmlsitemap

Class CmsXmlSitemapUrlBean

java.lang.Object

org.opencms.site.xmlsitemap.CmsXmlSitemapUrlBean

public class CmsXmlSitemapUrlBean
extends Object

A bean which represents an entry in an XML sitemap for SEO purposes.

Constructor Summary

Constructors

Constructor	Description
CmsXmlSitemapUrlBean(String url, long lastModified, String changeFrequency, double priority)	Creates a new instance.

Method Summary

Modifier and Type	Method	Description
String	getChangeFrequency()	Gets the change frequency string.
Date	getDateLastModified()	Gets the last modification date.
CmsResource	getDetailPageResource()	Gets the detail page resource in case the link is the link to a detail page, else returns null.
String	getFormattedDate()	Gets the last modification date formatted as W3C datetime.
Locale	getLocale()	Returns the locale.
CmsResource	getOriginalResource()	Gets the original resource belonging to the link.
double	getPriority()	Gets the priority for the page.
String	getSubsite()	Returns the subsite.
String	getUrl()	Gets the page URL.
void	setDetailPageResource(CmsResource detailPageResource)	Sets the detail page resource.
void	setLocale(Locale locale)	Sets the locale.
void	setOriginalResource(CmsResource resource)	Sets the original resource.
void	setSubsite(String subsite)	Sets the subsite.
String	toString()
void	writeChangefreq(StringBuffer buffer)	Writes the changefreq node to the buffer.
void	writeElement(StringBuffer buffer, String tag, String content)	Writes a single XML element with text content to a string buffer.
void	writeLastmod(StringBuffer buffer)	Writes the lastmod node to the buffer.
void	writePriority(StringBuffer buffer)	Writes the priority node to the buffer.

Methods inherited from class java.lang.Object

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

Constructor Details

CmsXmlSitemapUrlBean

public CmsXmlSitemapUrlBean(String url,
 long lastModified,
 String changeFrequency,
 double priority)

Creates a new instance.

Parameters:

url - the URL

lastModified - the last modification date

changeFrequency - the change frequency string

priority - the priority

Method Details

getChangeFrequency

public String getChangeFrequency()

Gets the change frequency string.

Returns:

the change frequency string

getDateLastModified

public Date getDateLastModified()

Gets the last modification date.

Returns:

the last modification date

getDetailPageResource

public CmsResource getDetailPageResource()

Gets the detail page resource in case the link is the link to a detail page, else returns null.

Returns:

the container page used as the detail page

getFormattedDate

public String getFormattedDate()

Gets the last modification date formatted as W3C datetime.

Returns:

the formatted last modification date

getLocale

public Locale getLocale()

Returns the locale.

Returns:

the locale

getOriginalResource

public CmsResource getOriginalResource()

Gets the original resource belonging to the link.

In case this is a link to a detail page, the resource will be the resource displayed on the detail page

Returns:

the original resource

getPriority

public double getPriority()

Gets the priority for the page.

Returns:

the priority

getSubsite

public String getSubsite()

Returns the subsite.

Returns:

the subsite

getUrl

public String getUrl()

Gets the page URL.

Returns:

the page URL

setDetailPageResource

public void setDetailPageResource(CmsResource detailPageResource)

Sets the detail page resource.

Parameters:

detailPageResource - the detail page resource

setLocale

public void setLocale(Locale locale)

Sets the locale.

Parameters:

locale - the locale to set

setOriginalResource

public void setOriginalResource(CmsResource resource)

Sets the original resource.

Parameters:

resource - the original resource

setSubsite

public void setSubsite(String subsite)

Sets the subsite.

Parameters:

subsite - the subsite to set

toString

public String toString()

Overrides:

toString in class Object

See Also:

• Object.toString()

writeChangefreq

public void writeChangefreq(StringBuffer buffer)

Writes the changefreq node to the buffer.

Parameters:

buffer - the buffer to write to

writeElement

public void writeElement(StringBuffer buffer,
 String tag,
 String content)

Writes a single XML element with text content to a string buffer.

Parameters:

buffer - the string buffer to write to

tag - the XML tag name

content - the content of the XML element

writeLastmod

public void writeLastmod(StringBuffer buffer)

Writes the lastmod node to the buffer.

Parameters:

buffer - the buffer to write to

writePriority

public void writePriority(StringBuffer buffer)

Writes the priority node to the buffer.

Parameters:

buffer - the buffer to write to