com.marklogic.client.document

Interface DocumentWriteSet

All Superinterfaces:

Collection<DocumentWriteOperation>, Iterable<DocumentWriteOperation>, Set<DocumentWriteOperation>

public interface DocumentWriteSet
extends Set<DocumentWriteOperation>

Builds a set of DocumentWriteOperations to be sent to the server through the REST API as a bulk write request.

See Also:

DocumentManager.write(DocumentWriteSet), REST API Guide -> Writing Multiple Documents

Method Summary

Methods

Modifier and Type	Method and Description
DocumentWriteSet	add(DocumentDescriptor desc, AbstractWriteHandle contentHandle) Adds to this write set a document with the given uri template, and contents provided by the handle
DocumentWriteSet	add(DocumentDescriptor desc, DocumentMetadataWriteHandle metadataHandle, AbstractWriteHandle contentHandle) Adds to this write set a document with the given uri template, metadata, and contents provided by the handle
DocumentWriteSet	add(String docId, AbstractWriteHandle contentHandle) Adds to this write set a document with the given docId (server uri) and contents provided by the handle
DocumentWriteSet	add(String docId, DocumentMetadataWriteHandle metadataHandle, AbstractWriteHandle contentHandle) Adds to this write set a document with the given docId (server uri), metadata, and contents provided by the handle
DocumentWriteSet	addDefault(DocumentMetadataWriteHandle metadataHandle) Sets the default metadata for this write set for all documents added after this call
DocumentWriteSet	disableDefault() Removes the default metadata for this write set for all documents added after this call

Methods inherited from interface java.util.Set

add, addAll, clear, contains, containsAll, equals, hashCode, isEmpty, iterator, remove, removeAll, retainAll, size, toArray, toArray

Method Detail

addDefault

DocumentWriteSet addDefault(DocumentMetadataWriteHandle metadataHandle)

Sets the default metadata for this write set for all documents added after this call

disableDefault

DocumentWriteSet disableDefault()

Removes the default metadata for this write set for all documents added after this call

add

DocumentWriteSet add(String docId,
                   AbstractWriteHandle contentHandle)

Adds to this write set a document with the given docId (server uri) and contents provided by the handle

Parameters:

docId - the URI identifier for the document

contentHandle - a handle for writing the content of the document

add

DocumentWriteSet add(String docId,
                   DocumentMetadataWriteHandle metadataHandle,
                   AbstractWriteHandle contentHandle)

Adds to this write set a document with the given docId (server uri), metadata, and contents provided by the handle

Parameters:

docId - the URI identifier for the document

metadataHandle - a handle for writing the metadata of the document

contentHandle - a handle for writing the content of the document

add

DocumentWriteSet add(DocumentDescriptor desc,
                   AbstractWriteHandle contentHandle)

Adds to this write set a document with the given uri template, and contents provided by the handle

Parameters:

desc - a descriptor for the URI identifier, format, and mimetype of the document

contentHandle - a handle for writing the content of the document

add

DocumentWriteSet add(DocumentDescriptor desc,
                   DocumentMetadataWriteHandle metadataHandle,
                   AbstractWriteHandle contentHandle)

Adds to this write set a document with the given uri template, metadata, and contents provided by the handle

Parameters:

desc - a descriptor for the URI identifier, format, and mimetype of the document

metadataHandle - a handle for writing the metadata of the document

contentHandle - a handle for writing the content of the document