idl.tmt.documentsource.filesystem
Interface FilesystemDocumentProvider

All Superinterfaces:

DocumentProvider

All Known Implementing Classes:

WgetWebCrawlContext, GenericFilesystemDocumentProvider

public interface FilesystemDocumentProvider

extends DocumentProvider

DocumentProvider specifically for a filesystem. NOTE: the root document should probably be specified in the constructor of implementing classes. Created on Jan 23, 2004

Author:

jelsas

Method Summary

int	documentCount() Retrieves an estimate the total number of documents this provider is able to produce.
java.io.File	getRoot() Retrieves the root directory of the filesystem where documents are returned from.

Methods inherited from interface idl.tmt.documentsource.DocumentProvider

getNextDocument, hasMoreDocuments

Method Detail

documentCount

public int documentCount()

Retrieves an estimate the total number of documents this provider is able to produce. It may not be possible to calculate this estimate. In that case, this method should return -1.

Returns:

An estimate of the total number of documents this provider can produce. If it is not possible to come up with an estimage, -1 is returned.

getRoot

public java.io.File getRoot()

Retrieves the root directory of the filesystem where documents are returned from.

Returns:

The root direcory.