Package | Description |
---|---|
com.marklogic.client.admin |
The package provides the classes for configuration and initialization
of the REST server.
|
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.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.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> T |
ResourceExtensionsManager.listServicesAs(Format format,
java.lang.Class<T> as)
Reads the list of resource service extensions installed on the server
in a JSON or XML representation provided as an object of an IO class.
|
<T> T |
ResourceExtensionsManager.listServicesAs(Format format,
java.lang.Class<T> as,
boolean refresh)
Reads the list of resource service extensions installed on the server
in a JSON or XML representation provided as an object of an IO class.
|
<T> T |
TransformExtensionsManager.listTransformsAs(Format format,
java.lang.Class<T> as)
Reads the list of transform extensions installed on the server
in a JSON or XML representation provided as an object of an IO class.
|
<T> T |
TransformExtensionsManager.listTransformsAs(Format format,
java.lang.Class<T> as,
boolean refresh)
Reads the list of transform extensions installed on the server
in a JSON or XML representation provided as an object of an IO class.
|
<T> T |
QueryOptionsManager.optionsListAs(Format format,
java.lang.Class<T> as)
Retrieves the list of available named query options in a JSON or
XML representation provided as an object of an IO class.
|
<T> T |
QueryOptionsManager.readOptionsAs(java.lang.String name,
Format format,
java.lang.Class<T> as)
Fetch a query options configuration from the REST Server by name.
|
void |
QueryOptionsManager.writeOptionsAs(java.lang.String name,
Format format,
java.lang.Object queryOptions)
Write a named QueryOptions configuration to the REST server in a JSON or
XML representation provided as an object of an IO class.
|
Modifier and Type | Method and Description |
---|---|
Format |
LineSplitter.getFormat()
Returns the document format set to splitter.
|
Modifier and Type | Method and Description |
---|---|
java.util.Map<java.lang.String,Format> |
ZipSplitter.getExtensionFormats()
Returns the extensionFormats set to splitter.
|
Modifier and Type | Method and Description |
---|---|
void |
LineSplitter.setFormat(Format format)
Used to set document format to splitter.
|
ExportListener |
ExportListener.withNonDocumentFormat(Format nonDocumentFormat)
Sets the format for metadata available from
DocumentRecord.getMetadata to listeners registered with
onDocumentReady (assuming withMetadataCategory has been called to request specific metdata). |
ExportToWriterListener |
ExportToWriterListener.withNonDocumentFormat(Format nonDocumentFormat)
The format for the metadata retrieved with each document.
|
Modifier and Type | Method and Description |
---|---|
Format |
DocumentManager.getContentFormat()
Gets the default format of the managed documents
|
Format |
ContentDescriptor.getFormat()
Returns the format of the content.
|
Format |
DocumentRecord.getFormat()
Returns the format of the document in the server
|
Format |
DocumentManager.getNonDocumentFormat()
Returns the format (if set) for the search response from
search and
metadata available from DocumentPage.next().getMetadata(handle) (assuming
setMetadataCategories has been called
to request specific metadata). |
Modifier and Type | Method and Description |
---|---|
DocumentMetadataPatchBuilder |
DocumentManager.newPatchBuilder(Format pathFormat)
For XMLDocumentManager or JSONDocumentManager, creates a builder for specifying changes
to the document and metadata of a document.
|
void |
DocumentManager.setContentFormat(Format format)
Sets the default format of the managed documents
|
void |
ContentDescriptor.setFormat(Format format)
Specifies the format of the content as binary, JSON, text, or XML.
|
void |
DocumentManager.setNonDocumentFormat(Format nonDocumentFormat)
Specifies the format for the search response from
search and
metadata available from DocumentPage.next().getMetadata(handle) (assuming
setMetadataCategories has been called
to request specific metadata). |
DocumentDescriptor |
DocumentDescriptor.withFormat(Format format)
Specifies the format for a database document and
returns the descriptor object
|
DocumentUriTemplate |
DocumentUriTemplate.withFormat(Format format)
Specifies the format of the document
and returns the template object.
|
Modifier and Type | Method and Description |
---|---|
Format |
EvalResult.getFormat()
The format of this result from the Content-Type header
provided by the REST API eval endpoint.
|
Modifier and Type | Method and Description |
---|---|
void |
HTMLCleanerHandle.setFormat(Format format) |
URIHandle |
URIHandle.withFormat(Format format) |
Modifier and Type | Method and Description |
---|---|
Format |
ResourceServices.ServiceResult.getFormat()
Returns the format of the content.
|
Modifier and Type | Method and Description |
---|---|
void |
DOM4JHandle.setFormat(Format format)
Restricts the format to XML.
|
Modifier and Type | Method and Description |
---|---|
void |
GSONHandle.setFormat(Format format)
Restricts the format to JSON.
|
Modifier and Type | Method and Description |
---|---|
void |
JDOMHandle.setFormat(Format format)
Restricts the format to XML.
|
Modifier and Type | Method and Description |
---|---|
Format |
BaseHandle.getFormat() |
static Format |
Format.getFromDataType(java.lang.String dataType)
Returns the format based on a document data type
as used in Data Services.
|
static Format |
Format.getFromMimetype(java.lang.String mimeType)
Returns the format implied by the mime type
|
static Format |
Format.valueOf(java.lang.String name)
Returns the enum constant of this type with the specified name.
|
static Format[] |
Format.values()
Returns an array containing the constants of this enum type, in
the order they are declared.
|
Modifier and Type | Method and Description |
---|---|
void |
BaseHandle.setFormat(Format format) |
void |
DOMHandle.setFormat(Format format)
Restricts the format to XML.
|
void |
DocumentMetadataHandle.setFormat(Format format)
Restricts the format used parsing and serializing the metadata.
|
void |
InputSourceHandle.setFormat(Format format)
Restricts the format to XML.
|
void |
JAXBHandle.setFormat(Format format)
Restricts the format to XML.
|
void |
QueryOptionsListHandle.setFormat(Format format)
Sets the format associated with this handle.
|
void |
SearchHandle.setFormat(Format format)
Sets the format associated with this handle.
|
void |
SourceHandle.setFormat(Format format)
Restricts the format to XML.
|
void |
TuplesHandle.setFormat(Format format)
Sets the format associated with this handle.
|
void |
ValuesHandle.setFormat(Format format)
Sets the format associated with this handle.
|
void |
ValuesListHandle.setFormat(Format format)
Sets the format associated with this handle.
|
void |
XMLEventReaderHandle.setFormat(Format format)
Restricts the format to XML.
|
void |
XMLStreamReaderHandle.setFormat(Format format)
Restricts the format to XML.
|
BytesHandle |
BytesHandle.withFormat(Format format)
Specifies the format of the content and returns the handle
as a fluent convenience.
|
FileHandle |
FileHandle.withFormat(Format format)
Specifies the format of the content and returns the handle
as a fluent convenience.
|
InputStreamHandle |
InputStreamHandle.withFormat(Format format)
Specifies the format of the content and returns the handle
as a fluent convenience.
|
JacksonDatabindHandle<T> |
JacksonDatabindHandle.withFormat(Format format)
Specifies the format of the content and returns the handle
as a fluent convenience.
|
JacksonHandle |
JacksonHandle.withFormat(Format format)
Specifies the format of the content and returns the handle
as a fluent convenience.
|
JacksonParserHandle |
JacksonParserHandle.withFormat(Format format)
Specifies the format of the content and returns the handle
as a fluent convenience.
|
OutputStreamHandle |
OutputStreamHandle.withFormat(Format format)
Specifies the format of the content and returns the handle
as a fluent convenience.
|
QueryOptionsListHandle |
QueryOptionsListHandle.withFormat(Format format)
Fluent setter for the format associated with this handle.
|
ReaderHandle |
ReaderHandle.withFormat(Format format)
Specifies the format of the content and returns the handle
as a fluent convenience.
|
SearchHandle |
SearchHandle.withFormat(Format format)
Fluent setter for the format associated with this handle.
|
StringHandle |
StringHandle.withFormat(Format format)
Specifies the format of the content and returns the handle
as a fluent convenience.
|
TuplesHandle |
TuplesHandle.withFormat(Format format)
Fluent setter for the format associated with this handle.
|
ValuesHandle |
ValuesHandle.withFormat(Format format)
Fluent setter for the format associated with this handle.
|
ValuesListHandle |
ValuesListHandle.withFormat(Format format)
Fluent setter for the format associated with this handle.
|
Modifier and Type | Method and Description |
---|---|
Format |
MatchDocumentSummary.getFormat()
Returns the format associated with this document
|
Modifier and Type | Method and Description |
---|---|
RawCombinedQueryDefinition |
QueryManager.newRawCombinedQueryDefinitionAs(Format format,
java.lang.Object rawQuery)
Defines a combined query from a JSON or XML representation provided as an object of an IO class.
|
RawCombinedQueryDefinition |
QueryManager.newRawCombinedQueryDefinitionAs(Format format,
java.lang.Object rawQuery,
java.lang.String optionsName)
Defines a combined query from a JSON or XML representation provided as an object of an IO class.
|
RawCtsQueryDefinition |
QueryManager.newRawCtsQueryDefinitionAs(Format format,
java.lang.Object rawQuery)
Defines a serialized cts query from a JSON or XML representation provided as an object of an IO class.
|
RawCtsQueryDefinition |
QueryManager.newRawCtsQueryDefinitionAs(Format format,
java.lang.Object rawQuery,
java.lang.String optionsName)
Defines a serialized cts query from a JSON or XML representation provided as an object of an IO class.
|
RawQueryByExampleDefinition |
QueryManager.newRawQueryByExampleDefinitionAs(Format format,
java.lang.Object rawQuery)
Defines a simple query by example from a JSON or XML representation provided as an object of an IO class.
|
RawQueryByExampleDefinition |
QueryManager.newRawQueryByExampleDefinitionAs(Format format,
java.lang.Object rawQuery,
java.lang.String optionsName)
Defines a simple query by example from a JSON or XML representation provided as an object of an IO class.
|
RawStructuredQueryDefinition |
QueryManager.newRawStructuredQueryDefinitionAs(Format format,
java.lang.Object rawQuery)
Defines a structured query from a JSON or XML representation provided as an object of an IO class.
|
RawStructuredQueryDefinition |
QueryManager.newRawStructuredQueryDefinitionAs(Format format,
java.lang.Object rawQuery,
java.lang.String optionsName)
Defines a structured query from a JSON or XML representation provided as an object of an IO class.
|
Modifier and Type | Method and Description |
---|---|
Format |
RowRecord.getContentFormat(PlanExprCol col)
Identifies the format where a column has a document or
other content node value in the row instead of an atomic value.
|
Format |
RowRecord.getContentFormat(java.lang.String columnName)
Identifies the format where a column has a document or
other content node value in the row instead of an atomic value.
|
Copyright © 2013-2020 MarkLogic Corporation.