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.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.
|
Modifier and Type | Method | Description |
---|---|---|
TemporalDescriptor |
TemporalDocumentManager.create(DocumentUriTemplate template,
DocumentMetadataWriteHandle metadataHandle,
W contentHandle,
ServerTransform transform,
Transaction transaction,
java.lang.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,
java.lang.String temporalCollection,
java.util.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,
java.lang.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,
java.lang.String temporalCollection,
java.util.Calendar systemTime) |
Just like
write but write document at a specific system
time |
TemporalDescriptor |
TemporalDocumentManager.write(DocumentDescriptor desc,
java.lang.String temporalDocumentURI, DocumentMetadataWriteHandle metadataHandle,
W contentHandle,
ServerTransform transform,
Transaction transaction,
java.lang.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,
java.lang.String temporalDocumentURI, DocumentMetadataWriteHandle metadataHandle,
W contentHandle,
ServerTransform transform,
Transaction transaction,
java.lang.String temporalCollection,
java.util.Calendar systemTime) |
Just like
write but writes document at a specific system
time |
TemporalDescriptor |
TemporalDocumentManager.write(java.lang.String docId,
DocumentMetadataWriteHandle metadataHandle,
W contentHandle,
ServerTransform transform,
Transaction transaction,
java.lang.String temporalCollection) |
Just like
write but write document in a temporalCollection,
which will enforce all the rules of bitemporal data
management. |
TemporalDescriptor |
TemporalDocumentManager.write(java.lang.String docId,
DocumentMetadataWriteHandle metadataHandle,
W contentHandle,
ServerTransform transform,
Transaction transaction,
java.lang.String temporalCollection,
java.util.Calendar systemTime) |
Just like
write but write document at a specific system
time |
TemporalDescriptor |
TemporalDocumentManager.write(java.lang.String uri,
java.lang.String temporalDocumentURI, DocumentMetadataWriteHandle metadataHandle,
W contentHandle,
ServerTransform transform,
Transaction transaction,
java.lang.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(java.lang.String uri,
java.lang.String temporalDocumentURI, DocumentMetadataWriteHandle metadataHandle,
W contentHandle,
ServerTransform transform,
Transaction transaction,
java.lang.String temporalCollection,
java.util.Calendar systemTime) |
Just like
write but writes document at a specific system
time |
Modifier and Type | Method | Description |
---|---|---|
DocumentMetadataWriteHandle |
WriteEvent.getMetadata() |
The metadata written to the server.
|
Modifier and Type | Method | Description |
---|---|---|
WriteBatcher |
WriteBatcher.add(java.lang.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(java.lang.String uri,
DocumentMetadataWriteHandle metadataHandle,
java.lang.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. |
Modifier and Type | Method | Description |
---|---|---|
DocumentMetadataWriteHandle |
DocumentWriteOperation.getMetadata() |
Modifier and Type | Method | 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,
java.lang.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(java.lang.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(java.lang.String docId,
DocumentMetadataWriteHandle metadataHandle,
AbstractWriteHandle contentHandle,
java.lang.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(java.lang.String docId,
DocumentMetadataWriteHandle metadataHandle,
java.lang.Object content) |
Adds to this write set a document with the given
docId (server uri), metadata, and contents.
|
DocumentWriteSet |
DocumentWriteSet.addAs(java.lang.String docId,
DocumentMetadataWriteHandle metadataHandle,
java.lang.Object content,
java.lang.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,
java.lang.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,
java.lang.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 To call
write(), an application must authenticate as rest-writer or
rest-admin.
|
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 To call write(), an application must authenticate as
rest-writer or rest-admin.
|
void |
DocumentManager.write(java.lang.String docId,
DocumentMetadataWriteHandle metadataHandle,
W contentHandle) |
Writes the document metadata and content to the
database from the representations provided by the handles To call
write(), an application must authenticate as rest-writer or
rest-admin.
|
void |
DocumentManager.write(java.lang.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(java.lang.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(java.lang.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 To call write(), an application must authenticate as
rest-writer or rest-admin.
|
void |
DocumentManager.writeAs(java.lang.String docId,
DocumentMetadataWriteHandle metadataHandle,
java.lang.Object content) |
Writes the document content to the database from
an object of an IO class.
|
void |
DocumentManager.writeAs(java.lang.String docId,
DocumentMetadataWriteHandle metadataHandle,
java.lang.Object content, ServerTransform transform) |
Writes the document content to the database from
an object of an IO class.
|
void |
DocumentManager.writeMetadata(java.lang.String docId,
DocumentMetadataWriteHandle metadataHandle) |
Writes the document metadata to the database
from the representation provided by the handle To call
writeMetadata(), an application must authenticate as rest-writer or
rest-admin.
|
void |
DocumentManager.writeMetadata(java.lang.String docId,
DocumentMetadataWriteHandle metadataHandle,
Transaction transaction) |
Writes the document metadata to an open database
transaction from the representation provided by the handle To call
writeMetadata(), an application must authenticate as rest-writer or
rest-admin.
|
Modifier and Type | Class | Description |
---|---|---|
class |
DOM4JHandle |
A DOM4JHandle represents XML content as a dom4j
document for reading or writing.
|
Modifier and Type | Class | Description |
---|---|---|
class |
GSONHandle |
A GSONHandle represents JSON content as a GSON
JsonElement for reading or writing.
|
Modifier and Type | Class | Description |
---|---|---|
class |
JDOMHandle |
A JDOM Handle represents XML content as a JDOM
document for reading or writing.
|
Modifier and Type | Class | 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.
|
Modifier and Type | Interface | Description |
---|---|---|
interface |
CtsQueryWriteHandle |
A CtsQueryWriteHandle represents a serialized
cts query.
|
interface |
StructureWriteHandle |
A Structure Write Handle represents a query
serialized as a structured query, combined query, or query by
example.
|
Copyright © 2022 MarkLogic Corporation