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.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.example.extension |
The package provides examples of extensions that operate on a batch
of database documents.
|
com.marklogic.client.example.handle |
The package provides examples of extensions that read or write database documents
in a new way or with a new representation.
|
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.
|
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 AbstractReadHandle> |
ExtensionLibrariesManager.read(ExtensionLibraryDescriptor libraryDescriptor,
T readHandle)
Reads the contents of a library asset into a handle.
|
<T extends AbstractReadHandle> |
ExtensionLibrariesManager.read(java.lang.String libraryPath,
T readHandle)
Reads the contents of a library asset into a handle.
|
Modifier and Type | Class and Description |
---|---|
class |
RuleDefinition
A RuleDefinition represents a set of criteria that describe a named condition.
|
class |
RuleDefinitionList
Models a list of RuleDefinitions.
|
Modifier and Type | Interface and Description |
---|---|
interface |
TemporalDocumentManager<R extends AbstractReadHandle,W extends AbstractWriteHandle> |
Modifier and Type | Interface and Description |
---|---|
interface |
DocumentManager<R extends AbstractReadHandle,W extends AbstractWriteHandle>
A Document Manager provides database operations on a document.
|
Modifier and Type | Method and Description |
---|---|
<T extends AbstractReadHandle> |
DocumentRecord.getContent(T contentHandle)
Given a handle, populates the handle with the document contents directly from
the server (or the transformed contents if a ServerTransform was used).
|
<T extends AbstractReadHandle> |
DocumentPage.nextContent(T contentHandle)
Convenience method combines the functionality of Page.next() and DocumentRecord.getContent().
|
Modifier and Type | Method and Description |
---|---|
<H extends AbstractReadHandle> |
ServerEvaluationCall.eval(H responseHandle)
Provides the single result of the server-side eval or invoke call, wrapped in an io
handle.
|
<H extends AbstractReadHandle> |
EvalResult.get(H handle)
Use a handle to retrieve the contents of this result.
|
Modifier and Type | Method and Description |
---|---|
<R extends AbstractReadHandle> |
BatchManager.ReadOutput.getContent(R handle) |
<R extends AbstractReadHandle> |
SearchCollector.CollectorResults.next(R handle) |
Modifier and Type | Class and Description |
---|---|
class |
URIHandle
A URI Handle sends read document content to a URI or
receives written database content from a URI.
|
Modifier and Type | Method and Description |
---|---|
<R extends AbstractReadHandle> |
ResourceServices.delete(RequestParameters params,
R output)
Deletes content by calling a DELETE service.
|
<R extends AbstractReadHandle> |
ResourceServices.delete(RequestParameters params,
Transaction transaction,
R output)
Deletes content by calling a DELETE service.
|
<R extends AbstractReadHandle> |
ResourceServices.get(RequestParameters params,
R output)
Reads resource content by calling a GET service.
|
<R extends AbstractReadHandle> |
ResourceServices.get(RequestParameters params,
Transaction transaction,
R output)
Reads resource content by calling a GET service.
|
<R extends AbstractReadHandle> |
ResourceServices.ServiceResult.getContent(R handle)
Returns a handle on the content.
|
<R extends AbstractReadHandle> |
ResourceServices.post(RequestParameters params,
AbstractWriteHandle input,
R output)
Applies 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.
|
<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.post(RequestParameters params,
W[] input,
Transaction transaction,
R output)
Applies content by calling a POST service.
|
<R extends AbstractReadHandle> |
ResourceServices.put(RequestParameters params,
AbstractWriteHandle input,
R output)
Writes content by calling a PUT service.
|
<R extends AbstractReadHandle> |
ResourceServices.put(RequestParameters params,
AbstractWriteHandle input,
Transaction transaction,
R output)
Writes 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.
|
<R extends AbstractReadHandle,W extends AbstractWriteHandle> |
ResourceServices.put(RequestParameters params,
W[] input,
Transaction transaction,
R output)
Writes multiple content by calling a PUT service.
|
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 |
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 |
QueryOptionsListHandle
A QueryOptionsListHandle is used to access the list of named query options that exist on the server.
|
class |
ReaderHandle
A Reader Handle represents a character content as a reader
for reading to or writing from the database.
|
class |
SearchHandle
A SearchHandle represents a set of search results returned by the server.
|
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 |
TuplesHandle
A TuplesHandle represents a set of tuples returned by a query on the server.
|
class |
ValuesHandle
A ValuesHandle represents a list of values or of tuples
(combination of values for the same document) retrieved
from the indexes.
|
class |
ValuesListHandle
A ValuesListHandle represents a list of available named lexicon configurations
from saved query options.
|
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 and Description |
---|---|
interface |
BinaryReadHandle
A Binary Read Handle can represent binary content read from the database.
|
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 |
DocumentMetadataReadHandle
A Metadata Read Handle can represent metadata read from the database.
|
interface |
GenericReadHandle
A Generic Read Handle can represent content of an unknown format read from the database.
|
interface |
JSONReadHandle
A JSON Read Handle can represent JSON content read from the database.
|
interface |
QueryOptionsListReadHandle
A QueryOptionsListReadHandle represents a list of query options read from the server configuration.
|
interface |
QueryOptionsReadHandle
A QueryOptionsReadHandle represents a query options node read from the server configuration.
|
interface |
RuleListReadHandle |
interface |
RuleReadHandle |
interface |
SearchReadHandle
A SearchReadHandle represents the results of a search performed over the database.
|
interface |
SPARQLResultsReadHandle
A marker interface for handles capable of reading SPARQL results
(returned by
SPARQLQueryManager.executeSelect ). |
interface |
StructureReadHandle
A Structure Read Handle can represent a data structure read from the
database.
|
interface |
TextReadHandle
A Text Read Handle can represent text content read from the database.
|
interface |
TriplesReadHandle
A marker interface for handles capable of reading semantic triples.
|
interface |
TuplesReadHandle
A TuplesReadHandle represents a set of tuples read from the database.
|
interface |
ValuesListReadHandle
A ValuesListReadHandle represents a list of sets of values read from the database.
|
interface |
ValuesReadHandle
A ValuesReadHandle represents a set of values read from the database.
|
interface |
XMLReadHandle
A XML Read Handle can represent XML content read from the database.
|
Modifier and Type | Method and Description |
---|---|
<T extends AbstractReadHandle> |
RowRecord.getContent(PlanExprCol col,
T contentHandle)
Gets the content of a column with a document or other
content node value.
|
<T extends AbstractReadHandle> |
RowRecord.getContent(java.lang.String columnName,
T contentHandle)
Gets the content of a column with a document or other
content node value.
|
Copyright © 2013-2018 MarkLogic Corporation.