Package cz.jiripinkas.jsitemapgenerator

Class AbstractSitemapGenerator

java.lang.Object

cz.jiripinkas.jsitemapgenerator.AbstractGenerator

cz.jiripinkas.jsitemapgenerator.AbstractSitemapGenerator

Direct Known Subclasses:

SitemapGenerator, SitemapIndexGenerator

public abstract class AbstractSitemapGenerator
extends AbstractGenerator

Field Summary

Fields

Modifier and Type	Field	Description
protected W3CDateFormat	dateFormat

Fields inherited from class cz.jiripinkas.jsitemapgenerator.AbstractGenerator

baseUrl, urls

Constructor Summary

Constructors

Constructor	Description
AbstractSitemapGenerator(String baseUrl)

Method Summary

Modifier and Type	Method	Description
void	constructAndSaveSitemap(File file)	Construct and save sitemap to output file
abstract String[]	constructSitemap()
byte[]	constructSitemapGzip()	Construct sitemap into gzipped file
String	constructSitemapString()	Construct sitemap into single String
protected String	escapeXmlSpecialCharacters(String url)	Escape special characters in XML
void	pingBing()	Ping Google that sitemap has changed.
void	pingBing(String sitemapUrl)	Ping Bing that sitemap has changed.
void	pingGoogle()	Ping Google that sitemap has changed.
void	pingGoogle(String sitemapUrl)	Ping Google that sitemap has changed.
void	saveSitemap(File file, String[] sitemap)	Save sitemap to output file

Methods inherited from class cz.jiripinkas.jsitemapgenerator.AbstractGenerator

addPage, addPages, addPages

Methods inherited from class java.lang.Object

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

Field Detail

dateFormat

protected W3CDateFormat dateFormat

Constructor Detail

AbstractSitemapGenerator

public AbstractSitemapGenerator(String baseUrl)

Method Detail

constructSitemap

public abstract String[] constructSitemap()

constructSitemapString

public String constructSitemapString()

Construct sitemap into single String

Returns:

sitemap

constructSitemapGzip

public byte[] constructSitemapGzip()

Construct sitemap into gzipped file

Returns:

byte array

saveSitemap

public void saveSitemap(File file,
                        String[] sitemap)
                 throws IOException

Save sitemap to output file

Parameters:

file - Output file

sitemap - Sitemap as array of Strings (created by constructSitemap() method)

Throws:

IOException - when error

constructAndSaveSitemap

public void constructAndSaveSitemap(File file)
                             throws IOException

Construct and save sitemap to output file

Parameters:

file - Output file

Throws:

IOException - when error

pingGoogle

public void pingGoogle(String sitemapUrl)

Ping Google that sitemap has changed. Will call this URL: http://www.google .com/webmasters/tools/ping?sitemap=URL_Encoded_sitemapUrl

Parameters:

sitemapUrl - sitemap url

pingBing

public void pingBing(String sitemapUrl)

Ping Bing that sitemap has changed. Will call this URL: http://www.bing.com/ping?sitemap=URL_Encoded_sitemapUrl

Parameters:

sitemapUrl - sitemap url

pingGoogle

public void pingGoogle()

Ping Google that sitemap has changed. Sitemap must be on this location: baseUrl/sitemap.xml (for example http://www.javavids.com/sitemap.xml)

pingBing

public void pingBing()

Ping Google that sitemap has changed. Sitemap must be on this location: baseUrl/sitemap.xml (for example http://www.javavids.com/sitemap.xml)

escapeXmlSpecialCharacters

protected String escapeXmlSpecialCharacters(String url)

Escape special characters in XML

Parameters:

url - Url to be escaped

Returns:

Escaped url