com.google.enterprise.connector.spi

Class SimpleDocumentList

java.lang.Object

com.google.enterprise.connector.spi.SimpleDocumentList

All Implemented Interfaces:

DocumentList

public class SimpleDocumentList
extends java.lang.Object
implements DocumentList

Simple implementation of the DocumentList interface. Implementors may use this directly or for reference.

Since:

1.0

Constructor Summary

Constructors

Constructor and Description
SimpleDocumentList(java.util.List<? extends Document> documents) Constructs a SimpleDocumentList encapsulating the supplied List of Documents.

Method Summary

Modifier and Type	Method and Description
java.lang.String	checkpoint() Provides a checkpoint that can be used to control traversal.
Document	nextDocument() Returns the next Document in this document list, if there is one.

Methods inherited from class java.lang.Object

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

Constructor Detail

SimpleDocumentList

public SimpleDocumentList(java.util.List<? extends Document> documents)

Constructs a SimpleDocumentList encapsulating the supplied List of Documents.

Parameters:

documents - a List of Documents

Method Detail

nextDocument

public Document nextDocument()

Description copied from interface: DocumentList

Returns the next Document in this document list, if there is one.

Specified by:

nextDocument in interface DocumentList

Returns:

the new current document if there is one; null otherwise

checkpoint

public java.lang.String checkpoint()
                            throws RepositoryException

Description copied from interface: DocumentList

Provides a checkpoint that can be used to control traversal. The implementor should provide a string that can be used by the framework to resume traversal starting just after this document. The framework will typically call this method on the last document it has chosen to process (for whatever reason: scheduling, completion of all documents currently available, etc.) It will persist this string, so that it can be recovered after a crash if necessary. When it chooses to restart traversal, it will supply this string in a call to TraversalManager.resumeTraversal(String).

If null is returned, then no new checkpoint will be saved, and the existing checkpoint will be supplied to TraversalManager.startTraversal() or TraversalManager.resumeTraversal(String), in effect, restarting the traversal from the last saved checkpoint.

Specified by:

checkpoint in interface DocumentList

Returns:

a non-null String that can be supplied subsequently to TraversalManager.resumeTraversal(String)

Throws:

RepositoryException - if a repository access error occurs or if there is insufficient information to create a checkpoint string. If checkpoint() throws an exception, a subsequent call to TraversalManager.resumeTraversal(String) will be supplied the last known good checkpoint string.