+ +Sitemaps are an easy way for webmasters to inform search engines about pages on their sites that are available for crawling. In its simplest form, a Sitemap is an XML file that lists URLs for a site along with additional metadata about each URL (when it was last updated, how often it usually changes, and how important it is, relative to other URLs in the site) so that search engines can more intelligently crawl the site.
+ +Web crawlers usually discover pages from links within the site and from other sites. Sitemaps supplement this data to allow crawlers that support Sitemaps to pick up all URLs in the Sitemap and learn about those URLs using the associated metadata. Using the Sitemap protocol does not guarantee that web pages are included in search engines, but provides hints for web crawlers to do a better job of crawling your site.
+ +Sitemap 0.90 is offered under the terms of the Attribution-ShareAlike Creative Commons License and has wide adoption, including support from Google, Yahoo!, and Microsoft.
+
The easiest way to get started is to just use the WebSitemapGenerator class, like this: + +
WebSitemapGenerator wsg = new WebSitemapGenerator("http://www.example.com", myDir);
+wsg.addUrl("http://www.example.com/index.html"); // repeat multiple times
+wsg.write();
+
+WebSitemapGenerator wsg = WebSitemapGenerator.builder("http://www.example.com", myDir)
+ .gzip(true).build(); // enable gzipped output
+wsg.addUrl("http://www.example.com/index.html");
+wsg.write();
+
+To configure the URLs, construct a WebSitemapUrl with WebSitemapUrl.Options.
+
+WebSitemapGenerator wsg = new WebSitemapGenerator("http://www.example.com", myDir);
+WebSitemapUrl url = new WebSitemapUrl.Options("http://www.example.com/index.html")
+ .lastMod(new Date()).priority(1.0).changeFreq(ChangeFreq.HOURLY).build();
+// this will configure the URL with lastmod=now, priority=1.0, changefreq=hourly
+wsg.addUrl(url);
+wsg.write();
+
+
+// Use DAY pattern (2009-02-07), Greenwich Mean Time timezone
+W3CDateFormat dateFormat = new W3CDateFormat(Pattern.DAY);
+dateFormat.setTimeZone(TimeZone.getTimeZone("GMT"));
+WebSitemapGenerator wsg = WebSitemapGenerator.builder("http://www.example.com", myDir)
+ .dateFormat(dateFormat).build(); // actually use the configured dateFormat
+wsg.addUrl("http://www.example.com/index.html");
+wsg.write();
+
+WebSitemapGenerator wsg = new WebSitemapGenerator("http://www.example.com", myDir);
+for (int i = 0; i < 60000; i++) wsg.addUrl("http://www.example.com/doc"+i+".html");
+wsg.write();
+wsg.writeSitemapsWithIndex(); // generate the sitemap_index.xml
+
+
+That will generate two sitemaps for 60K URLs: sitemap1.xml (with 50K urls) and sitemap2.xml (with the remaining 10K), and then generate a sitemap_index.xml file describing the two.
+ +It's also possible to carefully organize your sub-sitemaps. For example, it's recommended to group URLs with the same changeFreq together (have one sitemap for changeFreq "daily" and another for changeFreq "yearly"), so you can modify the lastMod of the daily sitemap without modifying the lastMod of the yearly sitemap. To do that, just construct your sitemaps one at a time using the WebSitemapGenerator, then use the SitemapIndexGenerator to create a single index for all of them.
+ +WebSitemapGenerator wsg;
+// generate foo sitemap
+wsg = WebSitemapGenerator.builder("http://www.example.com", myDir)
+ .fileNamePrefix("foo").build();
+for (int i = 0; i < 5; i++) wsg.addUrl("http://www.example.com/foo"+i+".html");
+wsg.write();
+// generate bar sitemap
+wsg = WebSitemapGenerator.builder("http://www.example.com", myDir)
+ .fileNamePrefix("bar").build();
+for (int i = 0; i < 5; i++) wsg.addUrl("http://www.example.com/bar"+i+".html");
+wsg.write();
+// generate sitemap index for foo + bar
+SitemapIndexGenerator sig = new SitemapIndexGenerator("http://www.example.com", myFile);
+sig.addUrl("http://www.example.com/foo.xml");
+sig.addUrl("http://www.example.com/bar.xml");
+sig.write();
+
+You could also use the SitemapIndexGenerator to incorporate sitemaps generated by other tools. For example, you might use Google's official Python sitemap generator to generate some sitemaps, and use WebSitemapGenerator to generate some sitemaps, and use SitemapIndexGenerator to make an index of all of them.
+ +SitemapGen4j can also validate your sitemaps using the official XML Schema Definition (XSD). If you used SitemapGen4j to make the sitemaps, you shouldn't need to do this unless there's a bug in our code. But you can use it to validate sitemaps generated by other tools, and it provides an extra level of safety.
+ +It's easy to configure the WebSitemapGenerator to automatically validate your sitemaps right after you write them (but this does slow things down, naturally).
+ +WebSitemapGenerator wsg = WebSitemapGenerator.builder("http://www.example.com", myDir)
+ .autoValidate(true).build(); // validate the sitemap after writing
+wsg.addUrl("http://www.example.com/index.html");
+wsg.write();
+
+You can also use the SitemapValidator directly to manage sitemaps. It has two methods: validateWebSitemap(File f) and validateSitemapIndex(File f).
+ +Google can understand a wide variety of custom sitemap formats that they made up, including a Mobile sitemaps, Geo sitemaps, Code sitemaps (for Google Code search), Google News sitemaps, and Video sitemaps. SitemapGen4j can generate any/all of these different types of sitemaps.
+ +To generate a special type of sitemap, just use GoogleMobileSitemapGenerator, GoogleGeoSitemapGenerator, GoogleCodeSitemapGenerator, GoogleCodeSitemapGenerator, GoogleNewsSitemapGenerator, or GoogleVideoSitemapGenerator instead of WebSitemapGenerator.
+ +You can't mix-and-match regular URLs with Google-specific sitemaps, so you'll also have to use a GoogleMobileSitemapUrl, GoogleGeoSitemapUrl, GoogleCodeSitemapUrl, GoogleNewsSitemapUrl, or GoogleVideoSitemapUrl instead of a WebSitemapUrl. Each of them has unique configurable options not available to regular web URLs.
+ + \ No newline at end of file diff --git a/pom.xml b/pom.xml index be73866..01155f6 100644 --- a/pom.xml +++ b/pom.xml @@ -83,7 +83,7 @@cooking. The value
- * should be a string no longer than 256 characters. In general,
- * categories are broad groupings of content by subject. Usually a video
- * will belong to a single category. For example, a site about cooking
- * could have categories for Broiling, Baking, and Grilling
- */
- public Options category(String category) {
- if (category != null) {
- if (category.length() > 256) {
- throw new RuntimeException("Video category is limited to 256 characters: " + title);
- }
- }
- this.category = category;
- return this;
- }
-
- /** Whether the video is suitable for viewing by children */
- public Options familyFriendly(boolean familyFriendly) {
- this.familyFriendly = familyFriendly;
- return this;
- }
-
- /** The duration of the video in seconds; value must be between 0 and 28800 (8 hours). */
- public Options durationInSeconds(int durationInSeconds) {
- if (durationInSeconds < 0 || durationInSeconds > 28800) {
- throw new RuntimeException("Duration must be between 0 and 28800 (8 hours):" + durationInSeconds);
- }
- this.durationInSeconds = durationInSeconds;
- return this;
- }
-
- }
+ private final URL playerUrl;
+ private final URL contentUrl;
+ private final URL thumbnailUrl;
+ private final String title;
+ private final String description;
+ private final Double rating;
+ private final Integer viewCount;
+ private final Date publicationDate;
+ private final ArrayListcooking. The value
+ * should be a string no longer than 256 characters. In general,
+ * categories are broad groupings of content by subject. Usually a video
+ * will belong to a single category. For example, a site about cooking
+ * could have categories for Broiling, Baking, and Grilling
+ */
+ public Options category(String category) {
+ if (category != null) {
+ if (category.length() > 256) {
+ throw new RuntimeException("Video category is limited to 256 characters: " + title);
+ }
+ }
+ this.category = category;
+ return this;
+ }
+
+ /**
+ * Whether the video is suitable for viewing by children
+ */
+ public Options familyFriendly(boolean familyFriendly) {
+ this.familyFriendly = familyFriendly;
+ return this;
+ }
+
+ /**
+ * The duration of the video in seconds; value must be between 0 and 28800 (8 hours).
+ */
+ public Options durationInSeconds(int durationInSeconds) {
+ if (durationInSeconds < 0 || durationInSeconds > 28800) {
+ throw new RuntimeException("Duration must be between 0 and 28800 (8 hours):" + durationInSeconds);
+ }
+ this.durationInSeconds = durationInSeconds;
+ return this;
+ }
+
+ }
+
+ /**
+ * Specifies a landing page URL, together with a "player" (e.g. SWF)
+ *
+ * @param url the landing page URL
+ * @param playerUrl the URL of the "player" (e.g. SWF file)
+ * @param allowEmbed when specifying a player, you must specify whether embedding is allowed
+ */
+ public GoogleVideoSitemapUrl(URL url, URL playerUrl, boolean allowEmbed) {
+ this(new Options(url, playerUrl, allowEmbed));
+ }
+
+ /**
+ * Specifies a landing page URL, together with the URL of the underlying video (e.g. FLV)
+ *
+ * @param url the landing page URL
+ * @param contentUrl the URL of the underlying video (e.g. FLV)
+ */
+ public GoogleVideoSitemapUrl(URL url, URL contentUrl) {
+ this(new Options(url, contentUrl));
+ }
+
+ /**
+ * Configures the url with options
+ */
+ public GoogleVideoSitemapUrl(Options options) {
+ super(options);
+ contentUrl = options.contentUrl;
+ playerUrl = options.playerUrl;
+ if (playerUrl == null && contentUrl == null) {
+ throw new RuntimeException("You must specify either contentUrl or playerUrl or both; neither were specified");
+ }
+ allowEmbed = convertBooleanToYesOrNo(options.allowEmbed);
+ if (playerUrl != null && allowEmbed == null) {
+ throw new RuntimeException("allowEmbed must be specified if playerUrl is specified");
+ }
+ category = options.category;
+
+ description = options.description;
+ durationInSeconds = options.durationInSeconds;
+ familyFriendly = convertBooleanToYesOrNo(options.familyFriendly);
+
+ publicationDate = options.publicationDate;
+ rating = options.rating;
+ tags = options.tags;
+ if (tags != null && tags.size() > 32) {
+ throw new RuntimeException("A maximum of 32 tags is permitted");
+ }
+ thumbnailUrl = options.thumbnailUrl;
+ title = options.title;
+ viewCount = options.viewCount;
+ }
+
+ private static String convertBooleanToYesOrNo(Boolean value) {
+ if (value == null) return null;
+ return value ? "Yes" : "No";
+ }
+ /**
+ * Retrieves the {@link Options#playerUrl}
+ */
+ public URL getPlayerUrl() {
+ return playerUrl;
+ }
+ /**
+ * Retrieves the {@link Options#contentUrl}
+ */
+ public URL getContentUrl() {
+ return contentUrl;
+ }
+
+ /**
+ * Retrieves the {@link Options#thumbnailUrl}
+ */
+ public URL getThumbnailUrl() {
+ return thumbnailUrl;
+ }
+
+ /**
+ * Retrieves the {@link Options#title}
+ */
+ public String getTitle() {
+ return title;
+ }
+
+ /**
+ * Retrieves the {@link Options#description}
+ */
+ public String getDescription() {
+ return description;
+ }
+
+ /**
+ * Retrieves the {@link Options#rating}
+ */
+ public Double getRating() {
+ return rating;
+ }
+
+ /**
+ * Retrieves the {@link Options#viewCount}
+ */
+ public Integer getViewCount() {
+ return viewCount;
+ }
+
+ /**
+ * Retrieves the {@link Options#publicationDate}
+ */
+ public Date getPublicationDate() {
+ return publicationDate;
+ }
+
+ /**
+ * Retrieves the {@link Options#tags}
+ */
+ public ArrayListNote that W3C timezone designators (TZD) are either the letter "Z" (for GMT) or a pattern like "+00:30" or "-08:00". This is unlike * RFC 822 timezones generated by SimpleDateFormat, which omit the ":" like this: "+0030" or "-0800".
* *This class allows you to either specify which format pattern to use, or (by default) to diff --git a/src/main/java/com/redfin/sitemapgenerator/package.html b/src/main/java/com/redfin/sitemapgenerator/package.html deleted file mode 100644 index 195e520..0000000 --- a/src/main/java/com/redfin/sitemapgenerator/package.html +++ /dev/null @@ -1,111 +0,0 @@ -
- -Sitemaps are an easy way for webmasters to inform search engines about pages on their sites that are available for crawling. In its simplest form, a Sitemap is an XML file that lists URLs for a site along with additional metadata about each URL (when it was last updated, how often it usually changes, and how important it is, relative to other URLs in the site) so that search engines can more intelligently crawl the site.
- -Web crawlers usually discover pages from links within the site and from other sites. Sitemaps supplement this data to allow crawlers that support Sitemaps to pick up all URLs in the Sitemap and learn about those URLs using the associated metadata. Using the Sitemap protocol does not guarantee that web pages are included in search engines, but provides hints for web crawlers to do a better job of crawling your site.
- -Sitemap 0.90 is offered under the terms of the Attribution-ShareAlike Creative Commons License and has wide adoption, including support from Google, Yahoo!, and Microsoft.
-
The easiest way to get started is to just use the WebSitemapGenerator class, like this: - -
WebSitemapGenerator wsg = new WebSitemapGenerator("http://www.example.com", myDir);
-wsg.addUrl("http://www.example.com/index.html"); // repeat multiple times
-wsg.write();
-
-WebSitemapGenerator wsg = WebSitemapGenerator.builder("http://www.example.com", myDir)
- .gzip(true).build(); // enable gzipped output
-wsg.addUrl("http://www.example.com/index.html");
-wsg.write();
-
-To configure the URLs, construct a WebSitemapUrl with WebSitemapUrl.Options.
-
-WebSitemapGenerator wsg = new WebSitemapGenerator("http://www.example.com", myDir);
-WebSitemapUrl url = new WebSitemapUrl.Options("http://www.example.com/index.html")
- .lastMod(new Date()).priority(1.0).changeFreq(ChangeFreq.HOURLY).build();
-// this will configure the URL with lastmod=now, priority=1.0, changefreq=hourly
-wsg.addUrl(url);
-wsg.write();
-
-
-// Use DAY pattern (2009-02-07), Greenwich Mean Time timezone
-W3CDateFormat dateFormat = new W3CDateFormat(Pattern.DAY);
-dateFormat.setTimeZone(TimeZone.getTimeZone("GMT"));
-WebSitemapGenerator wsg = WebSitemapGenerator.builder("http://www.example.com", myDir)
- .dateFormat(dateFormat).build(); // actually use the configured dateFormat
-wsg.addUrl("http://www.example.com/index.html");
-wsg.write();
-
-WebSitemapGenerator wsg = new WebSitemapGenerator("http://www.example.com", myDir);
-for (int i = 0; i < 60000; i++) wsg.addUrl("http://www.example.com/doc"+i+".html");
-wsg.write();
-wsg.writeSitemapsWithIndex(); // generate the sitemap_index.xml
-
-
-That will generate two sitemaps for 60K URLs: sitemap1.xml (with 50K urls) and sitemap2.xml (with the remaining 10K), and then generate a sitemap_index.xml file describing the two.
- -It's also possible to carefully organize your sub-sitemaps. For example, it's recommended to group URLs with the same changeFreq together (have one sitemap for changeFreq "daily" and another for changeFreq "yearly"), so you can modify the lastMod of the daily sitemap without modifying the lastMod of the yearly sitemap. To do that, just construct your sitemaps one at a time using the WebSitemapGenerator, then use the SitemapIndexGenerator to create a single index for all of them.
- -WebSitemapGenerator wsg;
-// generate foo sitemap
-wsg = WebSitemapGenerator.builder("http://www.example.com", myDir)
- .fileNamePrefix("foo").build();
-for (int i = 0; i < 5; i++) wsg.addUrl("http://www.example.com/foo"+i+".html");
-wsg.write();
-// generate bar sitemap
-wsg = WebSitemapGenerator.builder("http://www.example.com", myDir)
- .fileNamePrefix("bar").build();
-for (int i = 0; i < 5; i++) wsg.addUrl("http://www.example.com/bar"+i+".html");
-wsg.write();
-// generate sitemap index for foo + bar
-SitemapIndexGenerator sig = new SitemapIndexGenerator("http://www.example.com", myFile);
-sig.addUrl("http://www.example.com/foo.xml");
-sig.addUrl("http://www.example.com/bar.xml");
-sig.write();
-
-You could also use the SitemapIndexGenerator to incorporate sitemaps generated by other tools. For example, you might use Google's official Python sitemap generator to generate some sitemaps, and use WebSitemapGenerator to generate some sitemaps, and use SitemapIndexGenerator to make an index of all of them.
- -SitemapGen4j can also validate your sitemaps using the official XML Schema Definition (XSD). If you used SitemapGen4j to make the sitemaps, you shouldn't need to do this unless there's a bug in our code. But you can use it to validate sitemaps generated by other tools, and it provides an extra level of safety.
- -It's easy to configure the WebSitemapGenerator to automatically validate your sitemaps right after you write them (but this does slow things down, naturally).
- -WebSitemapGenerator wsg = WebSitemapGenerator.builder("http://www.example.com", myDir)
- .autoValidate(true).build(); // validate the sitemap after writing
-wsg.addUrl("http://www.example.com/index.html");
-wsg.write();
-
-You can also use the SitemapValidator directly to manage sitemaps. It has two methods: validateWebSitemap(File f) and validateSitemapIndex(File f).
- -Google can understand a wide variety of custom sitemap formats that they made up, including a Mobile sitemaps, Geo sitemaps, Code sitemaps (for Google Code search), Google News sitemaps, and Video sitemaps. SitemapGen4j can generate any/all of these different types of sitemaps.
- -To generate a special type of sitemap, just use GoogleMobileSitemapGenerator, GoogleGeoSitemapGenerator, GoogleCodeSitemapGenerator, GoogleCodeSitemapGenerator, GoogleNewsSitemapGenerator, or GoogleVideoSitemapGenerator instead of WebSitemapGenerator.
- -You can't mix-and-match regular URLs with Google-specific sitemaps, so you'll also have to use a GoogleMobileSitemapUrl, GoogleGeoSitemapUrl, GoogleCodeSitemapUrl, GoogleNewsSitemapUrl, or GoogleVideoSitemapUrl instead of a WebSitemapUrl. Each of them has unique configurable options not available to regular web URLs.
- - \ No newline at end of file