com.marklogic.client.document

Interface DocumentPage

All Superinterfaces:

java.lang.AutoCloseable, java.io.Closeable, java.lang.Iterable<DocumentRecord>, Page<DocumentRecord>

public interface DocumentPage
extends Page<DocumentRecord>, java.io.Closeable

Allows iteration over documents in the page as DocumentRecord instances.

long start = 1;
DocumentPage page = documentManager.search(query, start);
try {
    for (DocumentRecord record : page) {
        String uri = record.getUri();
        // ... do something ...
    }
} finally {
    page.close();
}

NOTICE! When you finish with this instance you must call close() to free the underlying resources.

Method Summary

Modifier and Type	Method and Description
void	close() Frees the underlying resources, including the http connection.
<T extends AbstractReadHandle> T	nextContent(T contentHandle) Convenience method combines the functionality of Page.next() and DocumentRecord.getContent().

Methods inherited from interface com.marklogic.client.Page

getPageNumber, getPageSize, getStart, getTotalPages, getTotalSize, hasContent, hasNext, hasNextPage, hasPreviousPage, isFirstPage, isLastPage, iterator, next, size

Methods inherited from interface java.lang.Iterable

forEach, spliterator

Method Detail

nextContent

<T extends AbstractReadHandle> T nextContent(T contentHandle)

Convenience method combines the functionality of Page.next() and DocumentRecord.getContent().

Type Parameters:

T - the type of AbstractReadHandle to return

Parameters:

contentHandle - the handle top populate with the contents from the next document

Returns:

the contents of the next document

close

void close()

Frees the underlying resources, including the http connection.

Specified by:

close in interface java.lang.AutoCloseable

Specified by:

close in interface java.io.Closeable