com.marklogic.client.document

Interface DocumentWriteOperation

All Superinterfaces:

java.lang.Comparable<DocumentWriteOperation>

public interface DocumentWriteOperation
extends java.lang.Comparable<DocumentWriteOperation>

A reflection of the write operations queued by calls to add, add, addDefault, or disableDefault.

Nested Class Summary

Nested Classes

Modifier and Type	Interface and Description
static interface	DocumentWriteOperation.DocumentUriMaker
static class	DocumentWriteOperation.OperationType

Method Summary

Modifier and Type	Method and Description
static java.util.stream.Stream<DocumentWriteOperation>	from(java.util.stream.Stream<? extends AbstractWriteHandle> content, DocumentWriteOperation.DocumentUriMaker uriMaker) The from method prepares each content object for writing as a document including generating a URI by inserting a UUID.
AbstractWriteHandle	getContent() The handle with the content as set by your call to add or add.
DocumentMetadataWriteHandle	getMetadata() The handle with the metadata as set by your call to add or add.
DocumentWriteOperation.OperationType	getOperationType() Returns the DocumentWriteOperation.OperationType set implicitly by your call to add, addDefault, or disableDefault.
java.lang.String	getTemporalDocumentURI() The logical temporal document URI of the document as set by your call to one of the 'add' methods which adds a document to a DocumentWriteSet
java.lang.String	getUri() The uri for this document if set explicitly by your call to add(String, ...)
static DocumentWriteOperation.DocumentUriMaker	uriMaker(java.lang.String format) The uriMaker method creates a uri for each document written in the database

Methods inherited from interface java.lang.Comparable

compareTo

Method Detail

getOperationType

DocumentWriteOperation.OperationType getOperationType()

Returns the DocumentWriteOperation.OperationType set implicitly by your call to add, addDefault, or disableDefault.

Returns:

the operation type which was set implicitly

getUri

java.lang.String getUri()

The uri for this document if set explicitly by your call to add(String, ...)

Returns:

the uri

getMetadata

DocumentMetadataWriteHandle getMetadata()

The handle with the metadata as set by your call to add or add.

Returns:

the handle with the metadata

getContent

AbstractWriteHandle getContent()

The handle with the content as set by your call to add or add.

Returns:

the handle with the content

getTemporalDocumentURI

java.lang.String getTemporalDocumentURI()

The logical temporal document URI of the document as set by your call to one of the 'add' methods which adds a document to a DocumentWriteSet

Returns:

the logical temporal document URI

from

static java.util.stream.Stream<DocumentWriteOperation> from(java.util.stream.Stream<? extends AbstractWriteHandle> content,
                                                            DocumentWriteOperation.DocumentUriMaker uriMaker)

The from method prepares each content object for writing as a document including generating a URI by inserting a UUID.

Parameters:

content - a subclass of AbstractWriteHandle

uriMaker - DocumentUriMaker which internally accepts an AbstractWriteHandle and returns a String

Returns:

a stream of DocumentWriteOperation to be written in the database.

uriMaker

static DocumentWriteOperation.DocumentUriMaker uriMaker(java.lang.String format)
                                                 throws java.lang.IllegalArgumentException

The uriMaker method creates a uri for each document written in the database

Parameters:

format - refers to the pattern passed.

Returns:

DocumentUriMaker which contains the formatted uri for the new document.

Throws:

java.lang.IllegalArgumentException