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

    qtm = (DctmTraversalManager) session.getTraversalManager();
  }


  public void testStartTraversal() throws RepositoryException {
    qtm.setBatchHint(DmInitialize.DM_RETURN_TOP_UNBOUNDED);
    DocumentList documentList = qtm.startTraversal();


    int counter = 0;
    while (documentList.nextDocument() != null) {
      counter++;
    }
    assertEquals(DmInitialize.DM_RETURN_TOP_UNBOUNDED, counter);
  }

View Full Code Here


  public void testResumeTraversal() throws RepositoryException {
    String checkPoint =
        "{\"uuid\":\"doc2\",\"lastModified\":\"1969-01-01 01:00:00.010\"}";
    qtm.setBatchHint(DmInitialize.DM_RETURN_TOP_BOUNDED);
    DocumentList documentList = qtm.resumeTraversal(checkPoint);


    assertNotNull(documentList);
    int counter = 0;
    while (documentList.nextDocument() != null) {
      counter++;
    }
    assertEquals(DmInitialize.DM_RETURN_TOP_BOUNDED, counter);
  }

View Full Code Here

  }


  public void testGetDocumentList_start() throws RepositoryException {
    MockTraversalManager mtm = new MockTraversalManager();


    DocumentList documentList = mtm.startTraversal();
    assertNotNull(documentList);
    assertEquals(1, mtm.count);
  }

View Full Code Here

    // The nulls in the checkpoint simulate new content with our execQuery stub.
    MockTraversalManager mtm = new MockTraversalManager();
    String checkpoint =
        "{index:0,uuid:[null,'one'],lastModified=[null,'2010-04-01 00:01:00']}";


    DocumentList documentList = mtm.resumeTraversal(checkpoint);
    assertNotNull(documentList);
    assertEquals(1, mtm.count);
  }

View Full Code Here

  public void testGetDocumentList_resumeSecond() throws RepositoryException {
    MockTraversalManager mtm = new MockTraversalManager();
    String checkpoint =
        "{index:1, uuid:['one'],lastModified=['2010-04-01 00:01:00']}";


    DocumentList documentList = mtm.resumeTraversal(checkpoint);
    assertNotNull(documentList);
    assertEquals(1, mtm.count);
  }

View Full Code Here

    // The nulls in the checkpoint simulate new content with our execQuery stub.
    MockTraversalManager mtm = new MockTraversalManager();
    String checkpoint =
        "{index:0,uuid:['one',null],lastModified=['2010-04-01 00:01:00',null]}";


    DocumentList documentList = mtm.resumeTraversal(checkpoint);
    assertNotNull(documentList);
    assertEquals(2, mtm.count);
  }

View Full Code Here

    // The nulls in the checkpoint simulate new content with our execQuery stub.
    MockTraversalManager mtm = new MockTraversalManager();
    String checkpoint =
        "{index:1,uuid:[null,'one'],lastModified=[null,'2010-04-01 00:01:00']}";


    DocumentList documentList = mtm.resumeTraversal(checkpoint);
    assertNotNull(documentList);
    assertEquals(2, mtm.count);
  }

View Full Code Here

  public void testGetDocumentList_resumeAcls() throws RepositoryException {
    MockTraversalManager mtm = new MockTraversalManager();
    String checkpoint = "{index:0,uuid:['one','another'],"
        + "lastModified=['2010-04-01 00:01:00','2010-10-27 22:55:03']}";


    DocumentList documentList = mtm.resumeTraversal(checkpoint);
    assertNotNull(documentList);
    assertEquals(3, mtm.count);
  }

View Full Code Here

  public void testGetDocumentList_end() throws RepositoryException {
    MockTraversalManager mtm = new MockTraversalManager();
    String checkpoint = "{index:0,aclid:'id1',uuid:['one','another'],"
        + "lastModified=['2010-04-01 00:01:00','2010-10-27 22:55:03']}";


    DocumentList documentList = mtm.resumeTraversal(checkpoint);
    assertNull(documentList);
    assertEquals(3, mtm.count);
  }

View Full Code Here

  public void testGetDocumentList_newAcls()
      throws RepositoryException {
    MockTraversalManager mtm = new MockTraversalManager();
    String checkpoint =
        "{uuid:['one'],lastModified:['2010-04-01 00:01:00'], index:0}";
    DocumentList documentList = mtm.resumeTraversal(checkpoint);
    assertNotNull(documentList);
    assertEquals(2, mtm.count);
  }

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.