Package | Description |
---|---|
com.marklogic.client |
The package provides the core classes, interfaces and exceptions for working with the database.
|
com.marklogic.client.admin |
The package provides the classes for configuration and initialization
of 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.query |
The package provides classes for queries including searching documents
and reading values directly from indexes in the database for the REST server.
|
com.marklogic.client.row |
The package provides classes for sending plan requests to and
processing row responses from the REST server.
|
Modifier and Type | Method and Description |
---|---|
<T extends StructureReadHandle> |
Transaction.readStatus(T handle)
Reads the status for the transaction including whether the transaction
has timed out.
|
Modifier and Type | Method and Description |
---|---|
<T extends StructureReadHandle> |
ResourceExtensionsManager.listServices(T listHandle)
Reads the list of resource service extensions installed on the server.
|
<T extends StructureReadHandle> |
ResourceExtensionsManager.listServices(T listHandle,
boolean refresh)
Reads the list of resource service extensions installed on the server,
specifying whether to refresh the metadata about each extension by parsing
the extension source.
|
<T extends StructureReadHandle> |
TransformExtensionsManager.listTransforms(T listHandle)
Lists the installed transform extensions.
|
<T extends StructureReadHandle> |
TransformExtensionsManager.listTransforms(T listHandle,
boolean refresh)
Lists the installed transform extensions, specifying whether to refresh
the metadata about each extension by parsing the extension source.
|
Modifier and Type | Class and Description |
---|---|
class |
DOM4JHandle
A DOM4JHandle represents XML content as a dom4j document for reading or writing.
|
Modifier and Type | Class and Description |
---|---|
class |
GSONHandle
A GSONHandle represents JSON content as a GSON JsonElement for reading or
writing.
|
Modifier and Type | Class and Description |
---|---|
class |
JDOMHandle
A JDOM Handle represents XML content as a JDOM document for reading or writing.
|
Modifier and Type | Class and Description |
---|---|
class |
BytesHandle
A Bytes Handle represents document content as a byte array for reading or writing.
|
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 |
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 | Method and Description |
---|---|
<T extends StructureReadHandle> |
QueryManager.convert(RawQueryByExampleDefinition query,
T convertedHandle)
Sends a query by example to the server to convert into a combined query
that expresses the criteria as a structured search.
|
<T extends StructureReadHandle> |
ExtractedItem.get(T handle)
Get the item using the specified handle.
|
<T extends StructureReadHandle> |
QueryManager.validate(RawQueryByExampleDefinition query,
T reportHandle)
Checks a query by example for mistakes in expressing the criteria.
|
Modifier and Type | Method and Description |
---|---|
<T extends StructureReadHandle> |
RowManager.explain(PlanBuilder.Plan plan,
T handle)
Constructs a plan for retrieving a set of database rows and returns a handle
for the explanation of the plan as a JSON or XML structure.
|
<T extends StructureReadHandle> |
RowManager.resultDoc(PlanBuilder.Plan plan,
T handle)
Constructs and retrieves a set of database rows based on a plan using
a handle to get the set of rows as a single JSON or XML structure.
|
<T extends StructureReadHandle> |
RowManager.resultDoc(PlanBuilder.Plan plan,
T handle,
Transaction transaction)
Constructs and retrieves a set of database rows based on a plan using
a handle to get the set of rows as a single JSON or XML structure
and reflecting documents written or deleted by an uncommitted transaction.
|
<T extends StructureReadHandle> |
RowManager.resultRows(PlanBuilder.Plan plan,
T rowHandle)
Constructs and retrieves a set of database rows based on a plan using
a JSON or XML handle for each row.
|
<T extends StructureReadHandle> |
RowManager.resultRows(PlanBuilder.Plan plan,
T rowHandle,
Transaction transaction)
Constructs and retrieves a set of database rows based on a plan using
a JSON or XML handle for each row and reflecting documents written or
deleted by an uncommitted transaction.
|
Copyright © 2013-2021 MarkLogic Corporation.