Package | Description |
---|---|
com.marklogic.client.alerting |
A REST interface to MarkLogic alerting capabilities.
|
com.marklogic.client.bitemporal | |
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 and Description |
---|---|
<T extends RuleListReadHandle> |
RuleManager.match(QueryDefinition docQuery,
long start,
long pageLength,
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(String[] docIds,
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.match(StructureWriteHandle document,
String[] candidateRules,
T ruleListHandle,
ServerTransform transform)
Matches server rules based on a document supplied in a write handle.
|
<T extends RuleListReadHandle> |
RuleManager.matchAs(Object content,
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 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 |
void |
TemporalDocumentManager.write(DocumentWriteSet writeSet,
ServerTransform transform,
Transaction transaction,
String temporalCollection)
Just like
write but create 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)
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 |
Modifier and Type | Method and Description |
---|---|
ServerTransform |
ServerTransform.addParameter(String name,
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 and 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,
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,
Object content,
ServerTransform transform)
Creates a database document with a uri assigned by the server from an object of an IO class.
|
<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 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 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 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 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,
String... uris)
Reads from the database a list of documents matching the provided uris.
|
DocumentPage |
DocumentManager.read(ServerTransform transform,
Transaction transaction,
String... uris)
Reads from the database a list of documents matching the provided uris.
|
<T extends R> |
DocumentManager.read(String docId,
DocumentMetadataReadHandle metadataHandle,
T contentHandle,
ServerTransform transform)
Reads the document metadata and content from the database as transformed on the server.
|
<T extends BinaryReadHandle> |
BinaryDocumentManager.read(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(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 R> |
DocumentManager.read(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(String docId,
T contentHandle,
ServerTransform transform)
Reads the document content from the database as transformed on the server.
|
<T extends BinaryReadHandle> |
BinaryDocumentManager.read(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(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(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(String docId,
Class<T> as,
ServerTransform transform)
Reads the document content from the database in the representation specified by the IO class.
|
<T> T |
DocumentManager.readAs(String docId,
DocumentMetadataReadHandle metadataHandle,
Class<T> as,
ServerTransform transform)
Reads the document metadata and 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(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,
W contentHandle,
ServerTransform transform)
Writes the document content to the database as transformed on the server.
|
void |
DocumentManager.write(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(String docId,
DocumentMetadataWriteHandle metadataHandle,
Object content,
ServerTransform transform)
Writes the document content to the database from an object of an IO class.
|
void |
DocumentManager.writeAs(String docId,
Object content,
ServerTransform transform)
Writes the document content to the database from an object of an IO class.
|
Modifier and Type | Method and Description |
---|---|
ServerTransform |
QueryDefinition.getResponseTransform()
Returns the transform that modifies responses to this query
on the server.
|
Modifier and Type | Method and Description |
---|---|
void |
QueryDefinition.setResponseTransform(ServerTransform transform)
Specifies a transform that modifies responses to this query
on the server.
|
Copyright © 2013-2016 MarkLogic Corporation.