org.apache.manifoldcf.crawler.interfaces
Interface IDocumentIdentifierStream

public interface IDocumentIdentifierStream

Implement this interface to return a stream of local document identifiers. These will be the result of an initial query, and should be unchanged by subsequent changes to the underlying data store. The semantics of calling this interface are much like using a stream: identifiers are pulled off one-by-one, and the stream will be explicitly closed when no longer needed. The purpose for the existence of this stream is also similar to other I/O streams: to avoid overusing main memory for buffers.

Field Summary

static java.lang.String

_rcsid

Method Summary

void	close() Close the stream.
java.lang.String	getNextIdentifier() Get the next local document identifier.

Field Detail

_rcsid

static final java.lang.String _rcsid

See Also:

Constant Field Values

Method Detail

getNextIdentifier

java.lang.String getNextIdentifier()
                                   throws ManifoldCFException,
                                          ServiceInterruption

Get the next local document identifier.

Returns:

the next document identifier, or null if there are no more.

Throws:

ManifoldCFException

ServiceInterruption

close

void close()
           throws ManifoldCFException

Close the stream.

Throws:

ManifoldCFException