Package | Description |
---|---|
com.marklogic.client.admin |
The package provides the classes for
configuration and initialization of the REST server.
|
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.eval | |
com.marklogic.client.expression |
The package provides classes for building Optic
plan pipelines and expressions for execution on the REST
server.
|
com.marklogic.client.extensions |
The package provides base and support classes so
you can derive a new Resource Manager to provide a client interface
for a Resource Services extension on 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 |
---|---|---|
void |
ExtensionLibrariesManager.write(ExtensionLibraryDescriptor libraryDescriptor,
AbstractWriteHandle contentHandle) |
Writes the contents of a handle to the provided
path on the REST server.
|
void |
ExtensionLibrariesManager.write(java.lang.String libraryPath,
AbstractWriteHandle contentHandle) |
Writes the contents of a handle to the provided
path on the REST server.
|
Modifier and Type | Class | Description |
---|---|---|
class |
RuleDefinition |
A RuleDefinition represents a set of criteria
that describe a named condition.
|
Modifier and Type | Interface | Description |
---|---|---|
interface |
TemporalDocumentManager<R extends AbstractReadHandle,W extends AbstractWriteHandle> |
Modifier and Type | Class | Description |
---|---|---|
static class |
JSONSplitter.Visitor<T extends AbstractWriteHandle> |
The Visitor class is used to accumulate and
inspect state during the depth-first traversal of the JSON tree and
make the decision of how to split the JSON file.
|
interface |
Splitter<T extends AbstractWriteHandle> |
Splitter splits an input stream into a Java
stream of write handles.
|
Modifier and Type | Method | Description |
---|---|---|
AbstractWriteHandle |
WriteEvent.getContent() |
The content written to the server.
|
Modifier and Type | Method | Description |
---|---|---|
java.util.Map<java.lang.String,Splitter<?
extends AbstractWriteHandle>> |
PathSplitter.getSplitters() |
Get the splitterMap of the PathSplitter
|
java.util.stream.Stream<? extends
AbstractWriteHandle> |
PathSplitter.splitHandles(java.util.stream.Stream<java.nio.file.Path> paths) |
Take a stream of Paths and convert the content
into a stream of AbstractWriteHandle
|
Modifier and Type | Method | Description |
---|---|---|
WriteBatcher |
WriteBatcher.add(java.lang.String uri,
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.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. |
Modifier and Type | Interface | Description |
---|---|---|
interface |
DocumentManager<R extends AbstractReadHandle,W extends AbstractWriteHandle> |
A Document Manager provides database operations
on a document.
|
Modifier and Type | Interface | Description |
---|---|---|
static interface |
DocumentMetadataPatchBuilder.PatchHandle |
A PatchHandle produced by the builder can
produce a string representation of the patch for saving, logging,
or other uses.
|
Modifier and Type | Method | Description |
---|---|---|
AbstractWriteHandle |
DocumentWriteOperation.getContent() |
Modifier and Type | Method | Description |
---|---|---|
DocumentWriteSet |
DocumentWriteSet.add(DocumentDescriptor desc,
AbstractWriteHandle contentHandle) |
Adds to this write set a document with the given
uri template, and contents provided by the handle
|
DocumentWriteSet |
DocumentWriteSet.add(DocumentDescriptor desc,
AbstractWriteHandle contentHandle,
java.lang.String temporalDocumentURI) |
Adds to this write set a document with the given
uri template, temporalDocumentURI and contents provided by the
handle
|
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,
AbstractWriteHandle contentHandle) |
Adds to this write set a document with the given
docId (server uri) and contents provided by the handle
|
DocumentWriteSet |
DocumentWriteSet.add(java.lang.String docId,
AbstractWriteHandle contentHandle,
java.lang.String temporalDocumentURI) |
Adds to this write set a document with the given
docId (server uri), 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
|
Modifier and Type | Method | Description |
---|---|---|
static
java.util.stream.Stream<DocumentWriteOperation> |
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.
|
Modifier and Type | Method | Description |
---|---|---|
ServerEvaluationCall |
ServerEvaluationCall.addVariable(java.lang.String name,
AbstractWriteHandle value) |
Set a variable name-value pair to pass to the
code executing server-side.
|
Modifier and Type | Method | Description |
---|---|---|
PlanBuilder.Plan |
PlanBuilderBase.PlanBase.bindParam(PlanParamExpr param,
AbstractWriteHandle content,
java.util.Map<java.lang.String,java.util.Map<java.lang.String,AbstractWriteHandle>> columnAttachments) |
Specifies a content handle to replace a
placeholder parameter during this execution of the plan in all
expressions in which the parameter appears.
|
PlanBuilder.Plan |
PlanBuilderBase.PlanBase.bindParam(java.lang.String param,
AbstractWriteHandle content) |
Specifies a content handle to replace a
placeholder parameter during this execution of the plan in all
expressions in which the parameter appears.
|
PlanBuilder.Plan |
PlanBuilderBase.PlanBase.bindParam(java.lang.String param,
AbstractWriteHandle content,
java.util.Map<java.lang.String,java.util.Map<java.lang.String,AbstractWriteHandle>> columnAttachments) |
Specifies a content handle to replace a
placeholder parameter during this execution of the plan in all
expressions in which the parameter appears.
|
Modifier and Type | Method | Description |
---|---|---|
PlanBuilder.Plan |
PlanBuilderBase.PlanBase.bindParam(PlanParamExpr param,
AbstractWriteHandle content,
java.util.Map<java.lang.String,java.util.Map<java.lang.String,AbstractWriteHandle>> columnAttachments) |
Specifies a content handle to replace a
placeholder parameter during this execution of the plan in all
expressions in which the parameter appears.
|
PlanBuilder.Plan |
PlanBuilderBase.PlanBase.bindParam(java.lang.String param,
AbstractWriteHandle content,
java.util.Map<java.lang.String,java.util.Map<java.lang.String,AbstractWriteHandle>> columnAttachments) |
Specifies a content handle to replace a
placeholder parameter during this execution of the plan in all
expressions in which the parameter appears.
|
Modifier and Type | Method | Description |
---|---|---|
<W extends AbstractWriteHandle> |
ResourceServices.post(RequestParameters params,
W[] input, Transaction transaction,
java.lang.String... mimetypes) |
Applies multiple content by calling a POST
service.
|
<R extends AbstractReadHandle,W
extends AbstractWriteHandle> |
ResourceServices.post(RequestParameters params,
W[] input, Transaction transaction,
R output) |
Applies content by calling a POST service.
|
<W extends AbstractWriteHandle> |
ResourceServices.post(RequestParameters params,
W[] input, java.lang.String... mimetypes) |
Applies multiple content by calling a POST
service.
|
<R extends AbstractReadHandle,W
extends AbstractWriteHandle> |
ResourceServices.post(RequestParameters params,
W[] input, R output) |
Applies content by calling a POST service.
|
<R extends AbstractReadHandle,W
extends AbstractWriteHandle> |
ResourceServices.put(RequestParameters params,
W[] input, Transaction transaction,
R output) |
Writes multiple content by calling a PUT
service.
|
<R extends AbstractReadHandle,W
extends AbstractWriteHandle> |
ResourceServices.put(RequestParameters params,
W[] input, R output) |
Writes multiple content by calling a PUT
service.
|
Modifier and Type | Method | Description |
---|---|---|
ResourceServices.ServiceResultIterator |
ResourceServices.post(RequestParameters params,
AbstractWriteHandle input,
Transaction transaction,
java.lang.String... mimetypes) |
Applies multiple content by calling a POST
service.
|
<R extends AbstractReadHandle> |
ResourceServices.post(RequestParameters params,
AbstractWriteHandle input,
Transaction transaction,
R output) |
Applies content by calling a POST service.
|
ResourceServices.ServiceResultIterator |
ResourceServices.post(RequestParameters params,
AbstractWriteHandle input,
java.lang.String... mimetypes) |
Applies multiple content by calling a POST
service.
|
<R extends AbstractReadHandle> |
ResourceServices.post(RequestParameters params,
AbstractWriteHandle input,
R output) |
Applies content by calling a POST service.
|
<W extends AbstractWriteHandle> |
ResourceServices.post(RequestParameters params,
W[] input, Transaction transaction,
java.lang.String... mimetypes) |
Applies multiple content by calling a POST
service.
|
<R extends AbstractReadHandle,W
extends AbstractWriteHandle> |
ResourceServices.post(RequestParameters params,
W[] input, Transaction transaction,
R output) |
Applies content by calling a POST service.
|
<W extends AbstractWriteHandle> |
ResourceServices.post(RequestParameters params,
W[] input, java.lang.String... mimetypes) |
Applies multiple content by calling a POST
service.
|
<R extends AbstractReadHandle,W
extends AbstractWriteHandle> |
ResourceServices.post(RequestParameters params,
W[] input, R output) |
Applies content by calling a POST service.
|
<R extends AbstractReadHandle> |
ResourceServices.put(RequestParameters params,
AbstractWriteHandle input,
Transaction transaction,
R output) |
Writes content by calling a PUT service.
|
<R extends AbstractReadHandle> |
ResourceServices.put(RequestParameters params,
AbstractWriteHandle input,
R output) |
Writes content by calling a PUT service.
|
<R extends AbstractReadHandle,W
extends AbstractWriteHandle> |
ResourceServices.put(RequestParameters params,
W[] input, Transaction transaction,
R output) |
Writes multiple content by calling a PUT
service.
|
<R extends AbstractReadHandle,W
extends AbstractWriteHandle> |
ResourceServices.put(RequestParameters params,
W[] input, R output) |
Writes multiple content by calling a PUT
service.
|
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 |
JAXBHandle<C> |
A JAXB Handle roundtrips a POJO (a Java data
structure) to and from a database document.
|
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 |
BinaryWriteHandle |
A Binary Write Handle can represent binary
content written to the database.
|
interface |
BufferableContentHandle<C,R> |
A Bufferable Content Handle provides an adapter
for a content representation that can be read multiple times for
purposes such as resending input when retrying after a failed
request.
|
interface |
BufferableHandle |
A Bufferable Handle can read content from a
byte[] buffer or write content as a byte[] buffer without changing
the state of an external resource.
|
interface |
ContentHandle<C> |
A Content Handle provides get / set access to a
representation of content such a byte[] array, input stream, file,
reader, string, and so on.
|
interface |
CtsQueryWriteHandle |
A CtsQueryWriteHandle represents a serialized
cts query.
|
interface |
DocumentMetadataWriteHandle |
A Document Metadata Write Handle can represent
document metadata written to the database.
|
interface |
DocumentPatchHandle |
A Document Patch Handle can represent a patch
with changes to document metadata or structured content.
|
interface |
GenericWriteHandle |
A Generic Write Handle can represent content of
an unknown format written to the database.
|
interface |
JSONWriteHandle |
A JSON Write Handle can represent JSON content
written to the database.
|
interface |
QuadsWriteHandle |
A marker interface for handles capable of
writing semantic quads.
|
interface |
QueryOptionsWriteHandle |
A QueryOptionsWriteHandle represents a query
options node to be written to the server configuration.
|
interface |
ResendableContentHandle<C,R> |
A Resendable Content Handle provides an adapter
for a content representation that can be read multiple times for
purposes such as resending input when retrying after a failed
request.
|
interface |
RuleWriteHandle |
|
interface |
StreamingContentHandle<C,R> |
A Streaming Content Handle provides an adapter
for a streaming content representation to make it possible to
construct a bufferable content representation so the content can be
read multiple times for purposes such as resending input when
retrying after a failed request.
|
interface |
StructureWriteHandle |
A Structure Write Handle represents a query
serialized as a structured query, combined query, or query by
example.
|
interface |
TextWriteHandle |
A Text Write Handle can represent text content
written to the database.
|
interface |
TriplesWriteHandle |
A marker interface for handles capable of
writing semantic triples.
|
interface |
XMLWriteHandle |
A XML Write Handle can represent XML content
written to the database.
|
Copyright © 2022 MarkLogic Corporation