package com.redfin.sitemapgenerator;

import java.io.File;
import java.net.MalformedURLException;
import java.net.URL;

/**
 
* Builds a code sitemap for Google Code Search.
  
To configure options, use {@link #builder(URL, File)}
 
* @author Dan Fabulich
 
* @see<a href="http://www.google.com/support/webmasters/bin/answer.py?answer=75224">Creating Code Search Sitemaps</a>
 
*/

public class GoogleCodeSitemapGenerator extends SitemapGenerator<GoogleCodeSitemapUrl,GoogleCodeSitemapGenerator> {
	

	
GoogleCodeSitemapGenerator(AbstractSitemapGeneratorOptions<?> options) {
		
super(options, new Renderer());
	
}

	
/** Configures the generator with a base URL and directory to write the sitemap files.
	 
*
 

	 
* @param baseUrl All URLs in the generated sitemap(s) should appear under this base URL
	 
* @param baseDir Sitemap files will be generated in this directory as either "sitemap.xml" or "sitemap1.xml" "sitemap2.xml" and so on.
	 
* @throws MalformedURLException
	 
*/

	
public GoogleCodeSitemapGenerator(String baseUrl, File baseDir)
			
throws MalformedURLException {
		
this(new SitemapGeneratorOptions(baseUrl, baseDir));
	
}

	
/**Configures the generator with a base URL and directory to write the sitemap files.
	 
*
 

	 
* @param baseUrl All URLs in the generated sitemap(s) should appear under this base URL
	 
* @param baseDir Sitemap files will be generated in this directory as either "sitemap.xml" or "sitemap1.xml" "sitemap2.xml" and so on.
	 
*/

	
public GoogleCodeSitemapGenerator(URL baseUrl, File baseDir) {
		
this(new SitemapGeneratorOptions(baseUrl, baseDir));
	
}
	

	
/**Configures the generator with a base URL and a null directory. The object constructed
	 
* is not intended to be used to write to files. Rather, it is intended to be used to obtain
	 
* XML-formatted strings that represent sitemaps.
	 
*
 

	 
* @param baseUrl All URLs in the generated sitemap(s) should appear under this base URL
	 
*/

	
public GoogleCodeSitemapGenerator(String baseUrl) throws MalformedURLException {
		
this(new SitemapGeneratorOptions(new URL(baseUrl)));
	
}
	

	
/**Configures the generator with a base URL and a null directory. The object constructed
	 
* is not intended to be used to write to files. Rather, it is intended to be used to obtain
	 
* XML-formatted strings that represent sitemaps.
	 
*
 

	 
* @param baseUrl All URLs in the generated sitemap(s) should appear under this base URL
	 
*/

	
public GoogleCodeSitemapGenerator(URL baseUrl) {
		
this(new SitemapGeneratorOptions(baseUrl));
	
}
	

	
/** Configures a builder so you can specify sitemap generator options
	 
*
 

	 
* @param baseUrl All URLs in the generated sitemap(s) should appear under this base URL
	 
* @param baseDir Sitemap files will be generated in this directory as either "sitemap.xml" or "sitemap1.xml" "sitemap2.xml" and so on.
	 
* @return a builder; call .build() on it to make a sitemap generator
	 
*/

	
public static SitemapGeneratorBuilder<GoogleCodeSitemapGenerator> builder(URL baseUrl, File baseDir) {
		
return new SitemapGeneratorBuilder<GoogleCodeSitemapGenerator>(baseUrl, baseDir, GoogleCodeSitemapGenerator.class);
	
}
	

	
/** Configures a builder so you can specify sitemap generator options
	 
*
 

	 
* @param baseUrl All URLs in the generated sitemap(s) should appear under this base URL
	 
* @param baseDir Sitemap files will be generated in this directory as either "sitemap.xml" or "sitemap1.xml" "sitemap2.xml" and so on.
	 
* @return a builder; call .build() on it to make a sitemap generator
	 
* @throws MalformedURLException
	 
*/

	
public static SitemapGeneratorBuilder<GoogleCodeSitemapGenerator> builder(String baseUrl, File baseDir) throws MalformedURLException {
		
return new SitemapGeneratorBuilder<GoogleCodeSitemapGenerator>(baseUrl, baseDir, GoogleCodeSitemapGenerator.class);
	
}

	
private static class Renderer extends AbstractSitemapUrlRenderer<GoogleCodeSitemapUrl> implements ISitemapUrlRenderer<GoogleCodeSitemapUrl> {

		
public Class<GoogleCodeSitemapUrl> getUrlClass() {
			
return GoogleCodeSitemapUrl.class;
		
}
		

		
public String getXmlNamespaces() {
			
return "xmlns:codesearch=\"http://www.google.com/codesearch/schemas/sitemap/1.0\"";
		
}

		
public void render(GoogleCodeSitemapUrl url, StringBuilder sb,
				
W3CDateFormat dateFormat) {
			
StringBuilder tagSb = new StringBuilder();
			
tagSb.append(" <codesearch:codesearch>\n");
			
renderTag(tagSb, "codesearch", "filetype", url.getFileType());
			
renderTag(tagSb, "codesearch", "license", url.getLicense());
			
renderTag(tagSb, "codesearch", "filename", url.getFileName());
			
renderTag(tagSb, "codesearch", "packageurl", url.getPackageUrl());
			
renderTag(tagSb, "codesearch", "packagemap", url.getPackageMap());
			
tagSb.append(" </codesearch:codesearch>\n");
			
super.render(url, sb, dateFormat, tagSb.toString());
		
}
		

	
}

	

}