com.marklogic.client.document

Interface DocumentRecord

public interface DocumentRecord

Each DocumentRecord represents one document, its uri, format, mime-type and possibly its metadata (collections, properties, quality, and permissions). Whether metadata is included depends on whether it was requested in the call sent to the server. For example, to request collections metadata:

JSONDocumentManager docMgr = databaseClient.newJSONDocumentManager();
docMgr.setNonDocumentFormat(Format.XML);
docMgr.setMetadataCategories(Metadata.COLLECTIONS);
DocumentPage documents = docMgr.read("doc1.json", "doc2.json");
try {
    for ( DocumentRecord record : documents ) {
        String uri = record.getUri();
        JacksonHandle content = record.getContent(new JacksonHandle());
        DocumentMetadataHandle metadata = record.getMetadata(new DocumentMetadataHandle());
        DocumentCollections collections = metadata.getCollections();
        // ... do something ...
    }
} finally {
    documents.close();
}
  

Method Summary

Methods

Modifier and Type	Method and Description
<T extends AbstractReadHandle> T	getContent(T contentHandle) Given a handle, populates the handle with the document contents directly from the server (or the transformed contents if a ServerTransform was used).
Format	getFormat() Returns the format of the document in the server
<T extends DocumentMetadataReadHandle> T	getMetadata(T metadataHandle) Given a handle, populates the handle with the structured metadata directly from the REST API.
String	getMimetype() Returns the mime-type ("Content-Type" header) of the document as specified by the server (uses the server's mime-type mapping for file extensions)
String	getUri() Returns the uri (unique identifier) of the document in the server

Method Detail

getUri

String getUri()

Returns the uri (unique identifier) of the document in the server

getFormat

Format getFormat()

Returns the format of the document in the server

getMimetype

String getMimetype()

Returns the mime-type ("Content-Type" header) of the document as specified by the server (uses the server's mime-type mapping for file extensions)

getMetadata

<T extends DocumentMetadataReadHandle> T getMetadata(T metadataHandle)

Given a handle, populates the handle with the structured metadata directly from the REST API. Depending on the nonDocumentFormat set on the DocumentManager, this will be XML or JSON format. If the nonDocumentFormat is XML, you can use DocumentMetadataHandle which offers convenient metadata access methods.

See Also:

REST API Dev Guide -> Working with Metadata

getContent

<T extends AbstractReadHandle> T getContent(T contentHandle)

Given a handle, populates the handle with the document contents directly from the server (or the transformed contents if a ServerTransform was used). Use a handle that is appropriate for the format of this document.