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); // make sure to use a try-with-resources block or call documents.close() try ( DocumentPage documents = docMgr.read("doc1.json", "doc2.json") ) { 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 ... } }

Method Summary

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).
<T> T	getContentAs(java.lang.Class<T> as) Reads the document content from the multipart response into the representation specified by the IO class.
DocumentDescriptor	getDescriptor() Returns a descriptor for the document content including the document version if enabled on the server.
Format	getFormat() Returns the format of the document in the server
long	getLength() Returns the length of the document content.
<T extends DocumentMetadataReadHandle> T	getMetadata(T metadataHandle) Given a handle, populates the handle with the structured metadata directly from the REST API.
<T> T	getMetadataAs(java.lang.Class<T> as) Reads the metadata from the multipart response into the representation specified by the IO class.
java.lang.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)
java.lang.String	getUri() Returns the uri (unique identifier) of the document in the server

Method Detail

getUri

java.lang.String getUri()

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

Returns:

the uri

getDescriptor

DocumentDescriptor getDescriptor()

Returns a descriptor for the document content including the document version if enabled on the server.

Returns:

the descriptor

getFormat

Format getFormat()

Returns the format of the document in the server

Returns:

the format of the document in the server

getMimetype

java.lang.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)

Returns:

the mime-type

getLength

long getLength()

Returns the length of the document content.

Returns:

the content length

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.

Type Parameters:

T - the type of DocumentMetadataReadHandle to return

Parameters:

metadataHandle - the handle to populate with the metadata

Returns:

a handle populated with the document metadata

See Also:

REST API Dev Guide -> Working with Metadata

getMetadataAs

<T> T getMetadataAs(java.lang.Class<T> as)

Reads the metadata from the multipart response into the representation specified by the IO class. The IO class must have been registered before creating the database client. By default, the provided handles that implement ContentHandle are registered. Learn more about shortcut methods

Type Parameters:

T - the type of object that will be returned by the handle registered for it

Parameters:

as - the Class which a handle should instantiate, populate and return

Returns:

the document metadata as the Class type requested

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.

Type Parameters:

T - the type of AbstractReadHandle to return

Parameters:

contentHandle - the handle to populate with the contents

Returns:

a handle populated with the document contents

getContentAs

<T> T getContentAs(java.lang.Class<T> as)

Reads the document content from the multipart response into the representation specified by the IO class. The IO class must have been registered before creating the database client. By default, the provided handles that implement ContentHandle are registered. Learn more about shortcut methods

Type Parameters:

T - the type of object that will be returned by the handle registered for it

Parameters:

as - the Class which a handle should instantiate, populate and return

Returns:

the document contents as the Class type requested