no.sesat.search.sitemap
Class PageProvider

java.lang.Object
  no.sesat.search.sitemap.PageProvider

All Implemented Interfaces:

Iterable<Page>

public abstract class PageProvider
extends Object
implements Iterable<Page>

Base class for sitemap page providers. Extends this class to provide your own URLs that should be a part of the installation-wide sitemap. Your implementation will be instantiated using the default constructor. In order for you provider to be recognized the skin needs have a provider-configuration file containing the fully qualified classname for each of your provider, one on each line. The file must be called no.sesat.commons.sitemaps.PageProvider and be located in META-INF/Services (which translates to src/main/resources/META-INF/services if you're using the default Maven projcet layout)

Constructor Summary

PageProvider()

Method Summary

abstract String	getName() The name of the sitemap.
abstract Iterator<Page>	iterator() Iterator for the pages to be put in sitemap.

Methods inherited from class java.lang.Object

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

Constructor Detail

PageProvider

public PageProvider()

Method Detail

getName

public abstract String getName()

The name of the sitemap. Note that this is not the final filename but a descriptive name like sesam-nyheter or katalog-infopages

Returns:

the name of the sitemap.

iterator

public abstract Iterator<Page> iterator()

Iterator for the pages to be put in sitemap.

Specified by:

iterator in interface Iterable<Page>

Returns:

iterator for site map pages.