Examples of com.google.enterprise.connector.spi.DocumentList

Package com.google.enterprise.connector.spi

Examples of com.google.enterprise.connector.spi.DocumentList

com.google.enterprise.connector.spi.DocumentList
Interface that represents a list of documents to be traversed. Documents are accessed through an iterator-like method: {@link #nextDocument()}, which returns the next available {@link Document} or {@code null} if there are no more.
Important: a {@link Document} object obtainedby calling {@link #nextDocument()} is invalidated by the nextcall to {@link #nextDocument()}. Typically, the caller will store the current Document in a loop variable, so that it is clear that this rule is observed; see the example code below.
In addition, a this interface has a special method {@link #checkpoint()}, which produces a String that encapsulates the traversal state. The consumer may call {@link #checkpoint()} at any time. The implementation shouldreturn a non-null String that, if supplied to {@link TraversalManager#resumeTraversal(String)}, would cause traversal to resume from the next unprocessed document.

Boundary cases are important for {@link #checkpoint()}:

If {@link #checkpoint()} is called before any calls to{@link #nextDocument()}, then traversal should resume with the Document that would have been returned by the first call to {@link #nextDocument()}.
If {@link #checkpoint()} is called after a call to{@link #nextDocument()} that returns a valid document, thentraversal should resume with the Document that would have been returned by the next call to {@link #nextDocument()}.
If {@link #checkpoint()} is not called, then traversal shouldresume from the previous checkpoint, as if none of the documents in this {@code DocumentList} had been processed.

The typical pattern for consuming an object that implements this interface is as follows (disregarding exception handling):

 DocumentList docList = ... Document doc; while (doc = docList.nextDocument()) { handleDoc(doc); if (whatever reason) break; } String check = doclist.checkpoint();

Note: because of the restriction that the next call to {@link #nextDocument()} invalidates the previous Document, and thereare similar restrictions in the {@link Document} interface, it is possibleto provide a single stateful object that implements {@link DocumentList}, {@link Document} and {@link Property}, by returning {@code this}(or {@code null}) to all calls to {@link #nextDocument()} and{@link Document#findProperty(String)}. However, if preferred, the implementor may also use separate objects for each of those interfaces. @since 1.0

    RefreshableContentHandler contentHandler =
        createMock(RefreshableContentHandler.class);
    contentHandler.initialize(isA(LivelinkConnector.class), isA(Client.class));
    contentHandler.refresh();
    replay(contentHandler);
    DocumentList list = getObjectUnderTest(contentHandler);
    verify(contentHandler);
  }

View Full Code Here

  /**
   * Tests a successful document, in this case by asking for an empty
   * document and skipping FetchVersion.
   */
  public void testNextDocument_emptyContent() throws RepositoryException {
    DocumentList list =
        getObjectUnderTest(MockConstants.IO_OBJECT_ID, 0, USER_ID);


    Document doc = list.nextDocument();
    assertNotNull(doc);
    assertNotNull(list.checkpoint());
  }

View Full Code Here

   * Tests different sizes of content with different traversal context
   * settings.
   */
  private void testTraversalContext(TraversalContext traversalContext,
      long dataSize, Content contentState) throws RepositoryException {
    DocumentList list = getObjectUnderTest(traversalContext, dataSize);


    Document doc = list.nextDocument();
    Property content = doc.findProperty(SpiConstants.PROPNAME_CONTENT);
    if (contentState == Content.NULL) {
      assertNull("Expected null content", content);
    } else if (contentState == Content.NON_NULL) {
      assertNotNull("Expected non-null content", content);

View Full Code Here

  /**
   * Tests a document where FetchVersion should throw an I/O exception
   * and be retried.
   */
  public void testNextDocument_exception() throws RepositoryException {
    DocumentList list =
        getObjectUnderTest(MockConstants.IO_OBJECT_ID, 1, USER_ID);


    try {
      Document doc = list.nextDocument();
      fail("Expected a LivelinkIOException");
    } catch (RepositoryDocumentException e) {
      fail("Did not expect a RepositoryDocumentException");
    } catch (LivelinkIOException e) {
      assertNull(list.checkpoint());
    }
  }

View Full Code Here

   */
  public void testNextDocument_unsupportedFetchVersionTypes()
      throws RepositoryException {
    LivelinkConnector connector =
        getConnector("unsupportedFetchVersionTypes", "144");
    DocumentList list =
        getObjectUnderTest(connector, MockConstants.IO_OBJECT_ID, 1, USER_ID);


    Document doc = list.nextDocument();
    assertNotNull(doc);
    assertNotNull(list.checkpoint());
  }

View Full Code Here

   * Since we've already processed one document, we just expect
   * nextDocument to return null in this case, unlike the previous
   * case where the LivelinkIOException was rethrown.
   */
  public void testNextDocument_partial() throws RepositoryException {
    DocumentList list = getObjectUnderTest(
        MockConstants.HARMLESS_OBJECT_ID, 0, USER_ID,
        MockConstants.IO_OBJECT_ID, 1, USER_ID);


    Document doc = list.nextDocument();
    assertNotNull(doc);
    String checkpoint = list.checkpoint();
    assertNotNull(checkpoint);


    assertNull(list.nextDocument());
    assertEquals(checkpoint, list.checkpoint());
  }

View Full Code Here

    // This client throws an exception if GetCurrentUserID is called,
    // since that is used to discriminate between document and
    // transient exceptions, and we are expecting a document
    // exception.
    PingErrorClient client = new PingErrorClient();
    DocumentList list = getObjectUnderTest(client,
        MockConstants.DOCUMENT_OBJECT_ID, 1, USER_ID);


    try {
      Document doc = list.nextDocument();
      fail("Expected a RepositoryDocumentException");
    } catch (RepositoryDocumentException e) {
      assertFalse(client.isThrown());
      assertNotNull(list.checkpoint());
    }
  }

View Full Code Here

   * would throw an exception from the batch rather than return null
   * to retry the batch starting with the second document.
   */
  public void testNextDocument_document_fail() throws RepositoryException {
    PingErrorClient client = new PingErrorClient();
    DocumentList list = getObjectUnderTest(client,
        MockConstants.DOCUMENT_OBJECT_ID, 1, USER_ID,
        MockConstants.REPOSITORY_OBJECT_ID, 1, USER_ID);
    testNextDocument_skipped_fail(list, MockConstants.DOCUMENT_OBJECT_ID);
    assertTrue(client.isThrown());
  }

View Full Code Here

   * the second. Previously, this would throw an exception from the
   * batch rather than return null to retry the batch starting with
   * the second document.
   */
  public void testNextDocument_repository_fail() throws RepositoryException {
    DocumentList list = getObjectUnderTest(
        MockConstants.REPOSITORY_OBJECT_ID, 1, USER_ID,
        MockConstants.IO_OBJECT_ID, 1, USER_ID);
    testNextDocument_skipped_fail(list, MockConstants.REPOSITORY_OBJECT_ID);
  }

View Full Code Here

  /** Tests that the client must not be null. */
  public void testNullConstructorArgs_client() throws RepositoryException {
    LivelinkConnector connector = getConnector();


    try {
      DocumentList list = new LivelinkDocumentList(connector,
          null, null, null, null, null, null, null, null);
      fail("Expected a NullPointerException");
    } catch (NullPointerException e) {
    }
  }

View Full Code Here

0 1 2 3 4 5 6 7 8 9

TOP

Related Classes of com.google.enterprise.connector.spi.DocumentList

com.google.enterprise.connector.adgroups.AdGroupsTraversalManagerTest

com.google.enterprise.connector.dctm.DctmMockDocumentListTest

com.google.enterprise.connector.dctm.DctmMockTraversalManagerTest

com.google.enterprise.connector.dctm.DctmTraversalManager

com.google.enterprise.connector.dctm.DctmTraversalManagerTest

com.google.enterprise.connector.dctm.DctmTraversalUtil

com.google.enterprise.connector.filenet4.AclDocumentTest

com.google.enterprise.connector.filenet4.FileDocumentListTest

com.google.enterprise.connector.filenet4.FileDocumentTraverserTest

com.google.enterprise.connector.filenet4.FileTraversalManagerTest

All source code are property of their respective owners. Java is a trademark of Sun Microsystems, Inc and owned by ORACLE Inc. Contact coftware#gmail.com.