org.apache.cocoon.components.crawler
Interface CocoonCrawler

All Superinterfaces:

org.apache.avalon.framework.component.Component

All Known Implementing Classes:

SimpleCocoonCrawlerImpl

public interface CocoonCrawler

extends org.apache.avalon.framework.component.Component

The avalon behavioural component interface of crawling.

Version:

CVS $Id: CocoonCrawler.java,v 1.5 2002/02/22 07:00:06 cziegeler Exp $

Author:

Bernhard Huber

Field Summary

static java.lang.String

ROLE Role name of this avalon component.

Method Summary

void	crawl(java.net.URL url) start crawling the URL.
java.util.Iterator	iterator() Iterate over crawling URLs.

Field Detail

ROLE

public static final java.lang.String ROLE

Role name of this avalon component. Its value is org.apache.cocoon.components.crawler.CocoonCrawler.

Since:

Method Detail

crawl

public void crawl(java.net.URL url)

start crawling the URL.

Calling this method initiates the crawling.

Parameters:

url - Description of Parameter

Since:

iterator

public java.util.Iterator iterator()

Iterate over crawling URLs.

This iterator will returns URL as result of crawling the base URL passed via crawling().

Returns:

Iterator iterates over crawling URLs.

Since: