Uses of Interface
com.marklogic.client.io.marker.DocumentMetadataWriteHandle

Packages that use DocumentMetadataWriteHandle

Package	Description
com.marklogic.client.bitemporal
com.marklogic.client.datamovement	The MarkLogic Data Movement SDK supports long-running write, read, delete, or transform jobs.
com.marklogic.client.document	The package provides classes for creating, retrieving, updating, and deleting documents in the database for the REST server.
com.marklogic.client.extra.dom4j	The package provides an adapter for using the dom4j Open Source library to read and write XML documents, XML structured search, and other XML data structures.
com.marklogic.client.extra.gson	The package provides an adapter for using the GSON Open Source library to read and write JSON documents, JSON structured search, and other JSON input and output.
com.marklogic.client.extra.jdom	The package provides an adapter for using the JDOM Open Source library to read and write XML documents, XML structured search, and other XML data structures.
com.marklogic.client.extra.xom	The package provides an adapter for using the XOM Open Source library to read and write XML documents, XML structured search, and other XML data structures.
com.marklogic.client.io	The package provides the handle classes with different representations for document content when you read documents from the database or write documents to the database.
com.marklogic.client.io.marker	The package provides marker interfaces for reading and writing each kind of document format.

Uses of DocumentMetadataWriteHandle in com.marklogic.client.bitemporal

Methods in com.marklogic.client.bitemporal with parameters of type DocumentMetadataWriteHandle

Modifier and Type	Method and Description
TemporalDescriptor	TemporalDocumentManager.create(DocumentUriTemplate template, DocumentMetadataWriteHandle metadataHandle, W contentHandle, ServerTransform transform, Transaction transaction, String temporalCollection) Just like create but create document in a temporalCollection, which will enforce all the rules of bitemporal data management.
TemporalDescriptor	TemporalDocumentManager.create(DocumentUriTemplate template, DocumentMetadataWriteHandle metadataHandle, W contentHandle, ServerTransform transform, Transaction transaction, String temporalCollection, Calendar systemTime) Just like create but create document at a specific system time
TemporalDescriptor	TemporalDocumentManager.write(DocumentDescriptor desc, DocumentMetadataWriteHandle metadataHandle, W contentHandle, ServerTransform transform, Transaction transaction, String temporalCollection) Just like write but write document in a temporalCollection, which will enforce all the rules of bitemporal data management.
TemporalDescriptor	TemporalDocumentManager.write(DocumentDescriptor desc, DocumentMetadataWriteHandle metadataHandle, W contentHandle, ServerTransform transform, Transaction transaction, String temporalCollection, Calendar systemTime) Just like write but write document at a specific system time
TemporalDescriptor	TemporalDocumentManager.write(DocumentDescriptor desc, String temporalDocumentURI, DocumentMetadataWriteHandle metadataHandle, W contentHandle, ServerTransform transform, Transaction transaction, String temporalCollection) Just like write but creates a new version of the document in the logical temporal collection URI passed as argument and names the new version of the document as the URI in the Document descriptor
TemporalDescriptor	TemporalDocumentManager.write(DocumentDescriptor desc, String temporalDocumentURI, DocumentMetadataWriteHandle metadataHandle, W contentHandle, ServerTransform transform, Transaction transaction, String temporalCollection, Calendar systemTime) Just like write but writes document at a specific system time
TemporalDescriptor	TemporalDocumentManager.write(String docId, DocumentMetadataWriteHandle metadataHandle, W contentHandle, ServerTransform transform, Transaction transaction, String temporalCollection) Just like write but write document in a temporalCollection, which will enforce all the rules of bitemporal data management.
TemporalDescriptor	TemporalDocumentManager.write(String docId, DocumentMetadataWriteHandle metadataHandle, W contentHandle, ServerTransform transform, Transaction transaction, String temporalCollection, Calendar systemTime) Just like write but write document at a specific system time
TemporalDescriptor	TemporalDocumentManager.write(String uri, String temporalDocumentURI, DocumentMetadataWriteHandle metadataHandle, W contentHandle, ServerTransform transform, Transaction transaction, String temporalCollection) Just like write but creates a new version of the document in the logical temporal collection URI passed as argument and names the new version of the document as the docId passed.
TemporalDescriptor	TemporalDocumentManager.write(String uri, String temporalDocumentURI, DocumentMetadataWriteHandle metadataHandle, W contentHandle, ServerTransform transform, Transaction transaction, String temporalCollection, Calendar systemTime) Just like write but writes document at a specific system time

Uses of DocumentMetadataWriteHandle in com.marklogic.client.datamovement

Methods in com.marklogic.client.datamovement that return DocumentMetadataWriteHandle

Modifier and Type	Method and Description
DocumentMetadataWriteHandle	WriteEvent.getMetadata() The metadata written to the server.

Methods in com.marklogic.client.datamovement with parameters of type DocumentMetadataWriteHandle

Modifier and Type	Method and Description
WriteBatcher	WriteBatcher.add(String uri, DocumentMetadataWriteHandle metadataHandle, AbstractWriteHandle contentHandle) Add a document to be batched then written to the server when a batch is full or WriteBatcher.flushAsync() or WriteBatcher.flushAndWait() is called.
WriteBatcher	WriteBatcher.addAs(String uri, DocumentMetadataWriteHandle metadataHandle, Object content) Add a document to be batched then written to the server when a batch is full or WriteBatcher.flushAsync() or WriteBatcher.flushAndWait() is called.

Uses of DocumentMetadataWriteHandle in com.marklogic.client.document

Methods in com.marklogic.client.document that return DocumentMetadataWriteHandle

Modifier and Type	Method and Description
DocumentMetadataWriteHandle	DocumentWriteOperation.getMetadata() The handle with the metadata as set by your call to add or add.

Methods in com.marklogic.client.document with parameters of type DocumentMetadataWriteHandle

Modifier and Type	Method and Description
DocumentWriteSet	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	DocumentWriteSet.add(DocumentDescriptor desc, DocumentMetadataWriteHandle metadataHandle, AbstractWriteHandle contentHandle, String temporalDocumentURI) Adds to this write set a document with the given uri template, metadata, temporalDocumentURI and contents provided by the handle
DocumentWriteSet	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	DocumentWriteSet.add(String docId, DocumentMetadataWriteHandle metadataHandle, AbstractWriteHandle contentHandle, String temporalDocumentURI) Adds to this write set a document with the given docId (server uri), metadata, temporalDocumentURI and contents provided by the handle
DocumentWriteSet	DocumentWriteSet.addAs(String docId, DocumentMetadataWriteHandle metadataHandle, Object content) Adds to this write set a document with the given docId (server uri), metadata, and contents.
DocumentWriteSet	DocumentWriteSet.addAs(String docId, DocumentMetadataWriteHandle metadataHandle, Object content, String temporalDocumentURI) Adds to this write set a document with the given docId (server uri), metadata, temporalDocumentURI and contents.
DocumentWriteSet	DocumentWriteSet.addDefault(DocumentMetadataWriteHandle metadataHandle) Sets the default metadata for this write set for all documents added after this call
DocumentDescriptor	DocumentManager.create(DocumentUriTemplate template, DocumentMetadataWriteHandle metadataHandle, W contentHandle) Creates a database document with metadata and content and a uri assigned by the server.
DocumentDescriptor	DocumentManager.create(DocumentUriTemplate template, DocumentMetadataWriteHandle metadataHandle, W contentHandle, ServerTransform transform) Creates a database document with metadata and content and a uri assigned by the server as transformed on the server.
DocumentDescriptor	DocumentManager.create(DocumentUriTemplate template, DocumentMetadataWriteHandle metadataHandle, W contentHandle, ServerTransform transform, Transaction transaction) Creates a database document with metadata and content and a uri assigned by the server in an open database transaction as transformed on the server.
DocumentDescriptor	DocumentManager.create(DocumentUriTemplate template, DocumentMetadataWriteHandle metadataHandle, W contentHandle, Transaction transaction)
DocumentDescriptor	DocumentManager.createAs(DocumentUriTemplate template, DocumentMetadataWriteHandle metadataHandle, Object content) Creates a database document with a uri assigned by the server from an object of an IO class.
DocumentDescriptor	DocumentManager.createAs(DocumentUriTemplate template, DocumentMetadataWriteHandle metadataHandle, Object content, ServerTransform transform) Creates a database document with a uri assigned by the server from an object of an IO class.
void	DocumentManager.write(DocumentDescriptor desc, DocumentMetadataWriteHandle metadataHandle, W contentHandle) Writes the document metadata and content to the database from the representations provided by the handles
void	DocumentManager.write(DocumentDescriptor desc, DocumentMetadataWriteHandle metadataHandle, W contentHandle, ServerTransform transform) Writes the document metadata and content to the database as transformed on the server.
void	DocumentManager.write(DocumentDescriptor desc, DocumentMetadataWriteHandle metadataHandle, W contentHandle, ServerTransform transform, Transaction transaction) Writes the document metadata and content to an open database transaction as transformed on the server.
void	DocumentManager.write(DocumentDescriptor desc, DocumentMetadataWriteHandle metadataHandle, W contentHandle, Transaction transaction) Writes the document metadata and content to an open database transaction from the representations provided by the handles
void	DocumentManager.write(String docId, DocumentMetadataWriteHandle metadataHandle, W contentHandle) Writes the document metadata and content to the database from the representations provided by the handles
void	DocumentManager.write(String docId, DocumentMetadataWriteHandle metadataHandle, W contentHandle, ServerTransform transform) Writes the document metadata and content to the database as transformed on the server.
void	DocumentManager.write(String docId, DocumentMetadataWriteHandle metadataHandle, W contentHandle, ServerTransform transform, Transaction transaction) Writes the document metadata and content to an open database transaction as transformed on the server.
void	DocumentManager.write(String docId, DocumentMetadataWriteHandle metadataHandle, W contentHandle, Transaction transaction) Writes the document metadata and content to an open database transaction from the representations provided by the handles
void	DocumentManager.writeAs(String docId, DocumentMetadataWriteHandle metadataHandle, Object content) Writes the document content to the database from an object of an IO class.
void	DocumentManager.writeAs(String docId, DocumentMetadataWriteHandle metadataHandle, Object content, ServerTransform transform) Writes the document content to the database from an object of an IO class.
void	DocumentManager.writeMetadata(String docId, DocumentMetadataWriteHandle metadataHandle) Writes the document metadata to the database from the representation provided by the handle
void	DocumentManager.writeMetadata(String docId, DocumentMetadataWriteHandle metadataHandle, Transaction transaction) Writes the document metadata to an open database transaction from the representation provided by the handle

Uses of DocumentMetadataWriteHandle in com.marklogic.client.extra.dom4j

Classes in com.marklogic.client.extra.dom4j that implement DocumentMetadataWriteHandle

Modifier and Type	Class and Description
class	DOM4JHandle A DOM4JHandle represents XML content as a dom4j document for reading or writing.

Uses of DocumentMetadataWriteHandle in com.marklogic.client.extra.gson

Classes in com.marklogic.client.extra.gson that implement DocumentMetadataWriteHandle

Modifier and Type	Class and Description
class	GSONHandle A GSONHandle represents JSON content as a GSON JsonElement for reading or writing.

Uses of DocumentMetadataWriteHandle in com.marklogic.client.extra.jdom

Classes in com.marklogic.client.extra.jdom that implement DocumentMetadataWriteHandle

Modifier and Type	Class and Description
class	JDOMHandle A JDOM Handle represents XML content as a JDOM document for reading or writing.

Uses of DocumentMetadataWriteHandle in com.marklogic.client.extra.xom

Classes in com.marklogic.client.extra.xom that implement DocumentMetadataWriteHandle

Modifier and Type	Class and Description
class	XOMHandle A XOM Handle represents XML content as a XOM document for reading or writing.

Uses of DocumentMetadataWriteHandle in com.marklogic.client.io

Classes in com.marklogic.client.io that implement DocumentMetadataWriteHandle

Modifier and Type	Class and Description
class	BytesHandle A Bytes Handle represents document content as a byte array for reading or writing.
class	DocumentMetadataHandle A DocumentMetadataHandle represents the metadata for a database document.
class	DOMHandle A DOM Handle represents XML content as a DOM document for reading or writing.
class	FileHandle A File Handle represents document content as a file for reading or writing.
class	InputSourceHandle An Input Source Handle represents XML content as an input source for reading or writing.
class	InputStreamHandle An InputStreamHandle represents a resource as an InputStream for reading or writing.
class	JacksonDatabindHandle<T> An adapter for using the Jackson Open Source library for JSON; represents JSON content for reading or writing as objects of the specified POJO class.
class	JacksonHandle An adapter for using the Jackson Open Source library for JSON; represents JSON content as a Jackson JsonNode for reading or writing.
class	JacksonParserHandle An adapter for using the streaming capabilities of the Jackson Open Source library.
class	OutputStreamHandle An OutputStreamHandle generates output during writing.
class	ReaderHandle A Reader Handle represents a character content as a reader for reading to or writing from the database.
class	SourceHandle A Source Handle represents XML content as a transform source for reading or transforms a source into a result for writing.
class	StringHandle A String Handle represents document content as a string for reading or writing.
class	XMLEventReaderHandle An XML Event Reader Handle represents XML content as an XML event reader for reading as a series of StAX events.
class	XMLStreamReaderHandle An XML Stream Reader Handle represents XML content as an XML stream reader for reading as a StAX pull stream.

Uses of DocumentMetadataWriteHandle in com.marklogic.client.io.marker

Subinterfaces of DocumentMetadataWriteHandle in com.marklogic.client.io.marker

Modifier and Type	Interface and Description
interface	StructureWriteHandle A Structure Write Handle can represent a data structure written to the database.