Package com.marklogic.client.document

The package provides classes for creating, retrieving, updating, and deleting documents in the database for the REST server. Use DatabaseClient to create managers for documents in different formats.

Interface Summary

Interface	Description
BinaryDocumentManager	A Binary Document Manager provides database operations on binary documents.
ContentDescriptor	A Content Descriptor identifies the properties of some content.
DocumentDescriptor	A Document Descriptor describes a database document.
DocumentManager<R extends AbstractReadHandle,W extends AbstractWriteHandle>	A Document Manager provides database operations on a document.
DocumentMetadataPatchBuilder	A DocumentMetadataPatchBuilder specifies changes to the metadata of a database document.
DocumentMetadataPatchBuilder.Call	A Call specifies how to apply a built-in or library function when replacing an existing fragment.
DocumentMetadataPatchBuilder.CallBuilder	A CallBuilder constructs a Call to a built-in or library function to produce the replacement for an existing fragment.
DocumentMetadataPatchBuilder.PatchHandle	A PatchHandle produced by the builder can produce a string representation of the patch for saving, logging, or other uses.
DocumentPage	Allows iteration over documents in the page as DocumentRecord instances.
DocumentPatchBuilder	A DocumentPatchBuilder specifies changes to the metadata, content, or both of a database document.
DocumentRecord	Each DocumentRecord represents one document, its uri, format, mime-type and possibly its metadata (collections, properties, quality, and permissions).
DocumentUriTemplate	A DocumentUriTemplate specifies how the server should construct a name for a document.
DocumentWriteOperation	A reflection of the write operations queued by calls to add, add, addDefault, or disableDefault.
DocumentWriteOperation.DocumentUriMaker
DocumentWriteSet	Builds a set of DocumentWriteOperations to be sent to the server through the REST API as a bulk write request.
GenericDocumentManager	A Generic Document Manager supports database operations on documents with an unknown format.
JSONDocumentManager	A JSON Document Manager supports database operations on JSON documents.
TextDocumentManager	A Text Document Manager supports database operations on text documents.
XMLDocumentManager	A XML Document Manager supports database operations on XML documents.

Class Summary

Class	Description
ServerTransform	ServerTransform specifies the invocation of a transform on the server including both the name of the transform and the parameters passed to the transform.

Enum Summary

Enum	Description
BinaryDocumentManager.MetadataExtraction	The MetadataExtraction enumeration identifies whether properties are extracted from binary documents to metadata properties on the binary document, to a separate XHTML document, or not at all.
DocumentManager.Metadata	The Metadata enumeration specifies the categories of metadata read from or written to the database.
DocumentMetadataPatchBuilder.Cardinality	The Cardinality enumeration indicates the number of times that a path can match without error (which defaults to ZERO_OR_MORE, meaning any number of matches).
DocumentPatchBuilder.PathLanguage	MarkLogic's REST API patch operations support two path languages for JSON, XPATH and JSONPATH.
DocumentPatchBuilder.Position	The Position enumeration indicates the location relative to the context for inserting content.
DocumentWriteOperation.OperationType
XMLDocumentManager.DocumentRepair	The DocumentRepair enumeration specifies whether an XML document is repaired as much as possible or not at all.