Package | Description |
---|---|
com.marklogic.client.alerting |
A REST interface to MarkLogic alerting
capabilities.
|
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.query |
The package provides classes for queries
including searching documents and reading values directly from
indexes in the database for the REST server.
|
Modifier and Type | Method | Description |
---|---|---|
<T extends RuleListReadHandle> |
RuleManager.match(StructureWriteHandle document,
java.lang.String[] candidateRules, T ruleListHandle,
ServerTransform transform) |
Matches server rules based on a document
supplied in a write handle.
|
<T extends RuleListReadHandle> |
RuleManager.match(QueryDefinition docQuery,
long start, long pageLength,
java.lang.String[] candidateRules, T ruleListHandle,
ServerTransform transform) |
Matches server rules based on results of a
search, with pagination applied to search.
|
<T extends RuleListReadHandle> |
RuleManager.match(java.lang.String[] docIds,
java.lang.String[] candidateRules, T ruleListHandle,
ServerTransform transform) |
Matches server rules based on an array of
document IDs and an array of rule names.
|
<T extends RuleListReadHandle> |
RuleManager.matchAs(java.lang.Object content,
java.lang.String[] candidateRules, T ruleListHandle,
ServerTransform transform) |
Matches server rules based on a document
supplied in a textual representation provided as an object of an IO
class.
|
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 |
void |
TemporalDocumentManager.write(DocumentWriteSet writeSet,
ServerTransform transform,
Transaction transaction,
java.lang.String temporalCollection) |
Just like
write but create 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) |
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 |
---|---|---|
ServerTransform |
WriteBatcher.getTransform() |
Modifier and Type | Method | Description |
---|---|---|
ApplyTransformListener |
ApplyTransformListener.withTransform(ServerTransform transform) |
The ServerTransform to run on each document from
each batch.
|
ExportListener |
ExportListener.withTransform(ServerTransform transform) |
Sets the server tranform to modify the document
contents.
|
ExportToWriterListener |
ExportToWriterListener.withTransform(ServerTransform transform) |
|
WriteBatcher |
WriteBatcher.withTransform(ServerTransform transform) |
The ServerTransform to modify each document from
each batch before it is written to the database.
|
Modifier and Type | Method | Description |
---|---|---|
ServerTransform |
ServerTransform.addParameter(java.lang.String name,
java.lang.String value) |
Appends a value to the list for a parameter and
returns this instance for method chaining.
|
ServerTransform |
DocumentManager.getReadTransform() |
Returns the transform for read requests that
don't specify a transform.
|
ServerTransform |
DocumentManager.getWriteTransform() |
Returns the transform for write requests that
don't specify a transform.
|
Modifier and Type | Method | Description |
---|---|---|
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,
W contentHandle,
ServerTransform transform) |
Creates a database document with a uri assigned
by the server as transformed on the server.
|
DocumentDescriptor |
DocumentManager.create(DocumentUriTemplate template,
W contentHandle,
ServerTransform transform,
Transaction transaction) |
Creates a database document with a uri assigned
by the server in an open database transaction as transformed on the
server.
|
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.
|
DocumentDescriptor |
DocumentManager.createAs(DocumentUriTemplate template,
java.lang.Object content, ServerTransform transform) |
Creates a database document with a uri assigned
by the server from an object of an IO class.
|
<T extends BinaryReadHandle> |
BinaryDocumentManager.read(DocumentDescriptor desc,
DocumentMetadataReadHandle metadataHandle,
T contentHandle, ServerTransform transform,
long start, long length) |
Reads metadata and a range of bytes from the
content of a binary database document as transformed on the
server.
|
<T extends BinaryReadHandle> |
BinaryDocumentManager.read(DocumentDescriptor desc,
DocumentMetadataReadHandle metadataHandle,
T contentHandle, ServerTransform transform,
long start, long length, Transaction transaction) |
Reads metadata and a range of bytes from the
content of a binary document for an open database transaction as
transformed on the server.
|
<T extends BinaryReadHandle> |
BinaryDocumentManager.read(DocumentDescriptor desc,
T contentHandle, ServerTransform transform,
long start, long length) |
Reads a range of bytes from the content of a
binary database document as transformed on the server.
|
<T extends BinaryReadHandle> |
BinaryDocumentManager.read(DocumentDescriptor desc,
T contentHandle, ServerTransform transform,
long start, long length, Transaction transaction) |
Reads a range of bytes from the content of a
binary document for an open database transaction as transformed on
the server.
|
<T extends BinaryReadHandle> |
BinaryDocumentManager.read(java.lang.String docId,
DocumentMetadataReadHandle metadataHandle,
T contentHandle, ServerTransform transform,
long start, long length) |
Reads metadata and a range of bytes from the
content of a binary database document as transformed on the
server.
|
<T extends BinaryReadHandle> |
BinaryDocumentManager.read(java.lang.String docId,
DocumentMetadataReadHandle metadataHandle,
T contentHandle, ServerTransform transform,
long start, long length, Transaction transaction) |
Reads metadata and a range of bytes from the
content of a binary document for an open database transaction as
transformed on the server.
|
<T extends BinaryReadHandle> |
BinaryDocumentManager.read(java.lang.String docId,
T contentHandle, ServerTransform transform,
long start, long length) |
Reads a range of bytes from the content of a
binary database document as transformed on the server.
|
<T extends BinaryReadHandle> |
BinaryDocumentManager.read(java.lang.String docId,
T contentHandle, ServerTransform transform,
long start, long length, Transaction transaction) |
Reads a range of bytes from the content of a
binary document for an open database transaction as transformed on
the server.
|
<T extends R> |
DocumentManager.read(DocumentDescriptor desc,
DocumentMetadataReadHandle metadataHandle,
T contentHandle, ServerTransform transform) |
Reads the document metadata and content from the
database as transformed on the server.
|
<T extends R> |
DocumentManager.read(DocumentDescriptor desc,
DocumentMetadataReadHandle metadataHandle,
T contentHandle, ServerTransform transform,
Transaction transaction) |
Reads the document metadata and content from an
open database transaction as transformed on the server.
|
<T extends R> |
DocumentManager.read(DocumentDescriptor desc,
T contentHandle, ServerTransform transform) |
Reads the document content from the database as
transformed on the server.
|
<T extends R> |
DocumentManager.read(DocumentDescriptor desc,
T contentHandle, ServerTransform transform,
Transaction transaction) |
Reads the document content from an open database
transaction as transformed on the server.
|
DocumentPage |
DocumentManager.read(ServerTransform transform,
Transaction transaction,
java.lang.String... uris) |
Reads from the database a list of documents
matching the provided uris.
|
DocumentPage |
DocumentManager.read(ServerTransform transform,
java.lang.String... uris) |
Reads from the database a list of documents
matching the provided uris.
|
<T extends R> |
DocumentManager.read(java.lang.String docId,
DocumentMetadataReadHandle metadataHandle,
T contentHandle, ServerTransform transform) |
Reads the document metadata and content from the
database as transformed on the server.
|
<T extends R> |
DocumentManager.read(java.lang.String docId,
DocumentMetadataReadHandle metadataHandle,
T contentHandle, ServerTransform transform,
Transaction transaction) |
Reads the document metadata and content from an
open database transaction as transformed on the server.
|
<T extends R> |
DocumentManager.read(java.lang.String docId,
T contentHandle, ServerTransform transform) |
Reads the document content from the database as
transformed on the server.
|
<T extends R> |
DocumentManager.read(java.lang.String docId,
T contentHandle, ServerTransform transform,
Transaction transaction) |
Reads the document content from an open database
transaction as transformed on the server.
|
<T> T |
DocumentManager.readAs(java.lang.String docId,
DocumentMetadataReadHandle metadataHandle,
java.lang.Class<T> as, ServerTransform transform) |
Reads the document metadata and content from the
database in the representation specified by the IO class.
|
<T> T |
DocumentManager.readAs(java.lang.String docId,
java.lang.Class<T> as, ServerTransform transform) |
Reads the document content from the database in
the representation specified by the IO class.
|
void |
DocumentManager.setReadTransform(ServerTransform transform) |
Specifies a transform for read requests that
don't specify a transform.
|
void |
DocumentManager.setWriteTransform(ServerTransform transform) |
Specifies a transform for write requests that
don't specify a transform.
|
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,
W contentHandle,
ServerTransform transform) |
Writes the document content to the database as
transformed on the server.
|
void |
DocumentManager.write(DocumentDescriptor desc,
W contentHandle,
ServerTransform transform,
Transaction transaction) |
Writes the document content to an open database
transaction as transformed on the server.
|
void |
DocumentManager.write(DocumentWriteSet writeSet,
ServerTransform transform) |
Write a set of documents and metadata to the
server via REST API bulk capabilities.
|
void |
DocumentManager.write(DocumentWriteSet writeSet,
ServerTransform transform,
Transaction transaction) |
Write a set of documents and metadata to the
server via REST API bulk capabilities.
|
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,
W contentHandle,
ServerTransform transform) |
Writes the document content to the database as
transformed on the server.
|
void |
DocumentManager.write(java.lang.String docId,
W contentHandle,
ServerTransform transform,
Transaction transaction) |
Writes the document content to an open database
transaction as transformed on the server.
|
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.writeAs(java.lang.String docId,
java.lang.Object content, ServerTransform transform) |
Writes the document content to the database from
an object of an IO class.
|
Modifier and Type | Method | Description |
---|---|---|
ServerTransform |
QueryDefinition.getResponseTransform() |
Returns the transform that modifies responses to
this query on the server.
|
Modifier and Type | Method | Description |
---|---|---|
void |
QueryDefinition.setResponseTransform(ServerTransform transform) |
Specifies a transform that modifies responses to
this query on the server.
|
Copyright © 2013-2019 MarkLogic Corporation.