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.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.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 | Description |
---|---|---|
<T extends XMLReadHandle> |
TransformExtensionsManager.readXSLTransform(java.lang.String transformName,
T sourceHandle) |
Reads the source for a transform implemented in
XSLT.
|
Modifier and Type | Method | Description |
---|---|---|
<T extends XMLReadHandle> |
RuleDefinition.exportQueryDefinition(T handle) |
Exports the embedded query definitions and
options to a handle
|
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 |
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 |
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 |
JAXBHandle<C> |
A JAXB Handle roundtrips a POJO (a Java data
structure) to and from a database document.
|
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 | Description |
---|---|---|
<T extends XMLReadHandle> |
SearchHandle.getConstraint(java.lang.String name,
T handle) |
|
<T extends XMLReadHandle> |
SearchHandle.getConstraintIterator(T handle) |
|
<T extends XMLReadHandle> |
SearchHandle.getPlan(T handle) |
|
<T extends XMLReadHandle> |
SearchHandle.getQuery(T handle) |
Modifier and Type | Method | Description |
---|---|---|
<T extends XMLReadHandle> |
SearchResults.getConstraint(java.lang.String name,
T handle) |
Returns the named constraint used in the search
(if requested).
|
<T extends XMLReadHandle> |
SearchResults.getConstraintIterator(T handle) |
Returns an iterator over the constraints used in
the search (if requested).
|
<T extends XMLReadHandle> |
MatchDocumentSummary.getFirstSnippet(T handle) |
Returns the content of the first snippet for the
matched result document as a convenience, especially for a raw
snippet that contains the entire result document.
|
<T extends XMLReadHandle> |
MatchDocumentSummary.getMetadata(T handle) |
Returns the metadata extracted from the result
document.
|
<T extends XMLReadHandle> |
SearchResults.getPlan(T handle) |
Returns the plan for the search (if
requested).
|
<T extends XMLReadHandle> |
SearchResults.getQuery(T handle) |
Returns the cts:query used in the search (if
requested).
|
<T extends XMLReadHandle> |
MatchDocumentSummary.getRelevanceInfo(T handle) |
Returns the relevance information for the
result.
|
<T extends XMLReadHandle> |
MatchDocumentSummary.getSnippetIterator(T handle) |
Returns an iterator over the snippets matched
for the result.
|
Modifier and Type | Method | Description |
---|---|---|
<T extends XMLReadHandle> |
RowManager.generateView(PlanBuilder.PreparePlan plan,
java.lang.String schema, java.lang.String view,
T handle) |
Generates generates a view that encapsulates a
plan.
|
Copyright © 2022 MarkLogic Corporation