- call() - Method in interface com.marklogic.client.document.DocumentMetadataPatchBuilder
-
A factory method for building calls to modify an existing node
by applying built-in functions or functions from a library.
- check() - Method in class com.marklogic.client.example.handle.URIHandle
-
- check(String) - Method in class com.marklogic.client.example.handle.URIHandle
-
- check(URI) - Method in class com.marklogic.client.example.handle.URIHandle
-
- checkDictionaries(String...) - Method in class com.marklogic.client.example.cookbook.ResourceExtension.DictionaryManager
-
- checkProperties(Properties) - Static method in class com.marklogic.client.example.util.Bootstrapper
-
- circle(double, double, double) - Method in class com.marklogic.client.query.StructuredQueryBuilder
-
Specifies a geospatial region as a circle,
supplying coordinates for the center.
- circle(StructuredQueryBuilder.Point, double) - Method in class com.marklogic.client.query.StructuredQueryBuilder
-
Specifies a geospatial region as a circle,
supplying a point for the center.
- clear() - Method in class com.marklogic.client.util.EditableNamespaceContext
-
Removes all namespace bindings.
- clear() - Method in class com.marklogic.client.util.RequestParameters
-
Removes all parameters.
- clearHandleRegistry() - Method in class com.marklogic.client.DatabaseClientFactory.Bean
-
Removes the current registered associations so the
handle registry is empty.
- clearHandleRegistry() - Static method in class com.marklogic.client.DatabaseClientFactory
-
Removes the current registered associations so the
handle registry is empty.
- clearMetadataCategories() - Method in interface com.marklogic.client.document.DocumentManager
-
Clears the metadata categories.
- ClientCreator - Class in com.marklogic.client.example.cookbook
-
ClientCreator illustrates how to create a database client.
- ClientCreator() - Constructor for class com.marklogic.client.example.cookbook.ClientCreator
-
- close() - Method in class com.marklogic.client.example.extension.BatchManager.BatchResponse
-
- close() - Method in class com.marklogic.client.example.extension.SearchCollector.CollectorResults
-
- close() - Method in interface com.marklogic.client.extensions.ResourceServices.ServiceResultIterator
-
Closes the iterator when no longer needed.
- close() - Method in class com.marklogic.client.io.XMLStreamReaderHandle
-
Closes the XMLStreamReader and the InputStream, if any, used to populate
the XMLStreamReader.
- close() - Method in interface com.marklogic.client.util.RequestLogger
-
Close the log.
- collect(String, long) - Method in class com.marklogic.client.example.extension.SearchCollector
-
- collect(String, long, String) - Method in class com.marklogic.client.example.extension.SearchCollector
-
- collect(String, String, long) - Method in class com.marklogic.client.example.extension.SearchCollector
-
- collect(String, String, long, String) - Method in class com.marklogic.client.example.extension.SearchCollector
-
- collect(QName, String, long) - Method in class com.marklogic.client.example.extension.SearchCollector
-
- collect(QName, String, long, String) - Method in class com.marklogic.client.example.extension.SearchCollector
-
- collect(QName, QName, String, long) - Method in class com.marklogic.client.example.extension.SearchCollector
-
- collect(QName, QName, String, long, String) - Method in class com.marklogic.client.example.extension.SearchCollector
-
- collect(StructuredQueryDefinition, long) - Method in class com.marklogic.client.example.extension.SearchCollector
-
- collection(String) - Method in class com.marklogic.client.admin.config.QueryOptionsBuilder
-
Deprecated.
Builds a QueryCollection object to use the Collection URI lexicon as source of
constraint values.
- collection(String, QueryOptions.Facets, String...) - Method in class com.marklogic.client.admin.config.QueryOptionsBuilder
-
Deprecated.
Builds a QueryCollection object to use the Collection URI lexicon as source of
constraint values.
- collection(String...) - Method in class com.marklogic.client.query.StructuredQueryBuilder
-
Matches documents belonging to at least one
of the criteria collections.
- collectionConstraint(String, String...) - Method in class com.marklogic.client.query.StructuredQueryBuilder
-
Matches documents belonging to at least one
of the criteria collections with the specified constraint.
- com.marklogic.client - package com.marklogic.client
-
The package provides the core classes, interfaces and exceptions for working with the database.
- com.marklogic.client.admin - package com.marklogic.client.admin
-
The package provides the classes for configuration and initialization
of the REST server.
- com.marklogic.client.admin.config - package com.marklogic.client.admin.config
-
The package provides classes and interfaces that implement MarkLogic Search API configuration using
Java Objects.
- com.marklogic.client.admin.config.support - package com.marklogic.client.admin.config.support
-
- com.marklogic.client.alerting - package com.marklogic.client.alerting
-
A REST interface to MarkLogic alerting capabilities.
- com.marklogic.client.document - package 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.example.cookbook - package com.marklogic.client.example.cookbook
-
The package provides examples for common actions in working with the database.
- com.marklogic.client.example.extension - package com.marklogic.client.example.extension
-
The package provides examples of extensions that operate on a batch
of database documents.
- com.marklogic.client.example.handle - package 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.example.util - package com.marklogic.client.example.util
-
The package provides utilities for bootstrapping and tearing down a MarkLogic REST instance.
- com.marklogic.client.extensions - package 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 - package 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 - package 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.httpclient - package com.marklogic.client.extra.httpclient
-
The package supports optional configuration of the Open Source
HttpClient library.
- com.marklogic.client.extra.jackson - package com.marklogic.client.extra.jackson
-
The package provides an adapter for using the Jackson Open Source library
to read and write JSON documents, JSON structured search, and other JSON
input and output.
- com.marklogic.client.extra.jdom - package 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.extra.xom - package com.marklogic.client.extra.xom
-
The package provides an adapter for using the XOM Open Source library
to read and write XML documents, XML structured search, and other XML
data structures.
- com.marklogic.client.io - package 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 - package com.marklogic.client.io.marker
-
The package provides marker interfaces for reading and writing each kind of document format.
- com.marklogic.client.query - package 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.util - package com.marklogic.client.util
-
The package provides loggers, specialized maps, and other utilities
shared across other packages.
- commit() - Method in interface com.marklogic.client.Transaction
-
Completes the transaction, making writes and deletes visible to other database clients.
- COMMON - Static variable in interface com.marklogic.client.DatabaseClientFactory.SSLHostnameVerifier
-
The COMMON SSLHostnameVerifier applies common rules
for checking hostnames during SSL authentication (similar
to org.apache.http.conn.ssl.BrowserCompatHostnameVerifier).
- compileXPath(String) - Method in class com.marklogic.client.io.DOMHandle
-
Compile an XPath string expression for efficient evaluation later.
- computedBucket(String, String, String, String, QueryOptions.QueryRange.ComputedBucket.AnchorValue) - Method in class com.marklogic.client.admin.config.QueryOptionsBuilder
-
Deprecated.
- concatenateAfter(String) - Method in interface com.marklogic.client.document.DocumentMetadataPatchBuilder.CallBuilder
-
Calls the built-in method to append an existing string
to the supplied string.
- concatenateBefore(String) - Method in interface com.marklogic.client.document.DocumentMetadataPatchBuilder.CallBuilder
-
Calls the built-in method to concatenate an existing string
before the supplied string.
- concatenateBetween(String, String) - Method in interface com.marklogic.client.document.DocumentMetadataPatchBuilder.CallBuilder
-
Calls the built-in method to concatenate an existing string
between the supplied strings.
- concurrencyLevel(Integer) - Method in class com.marklogic.client.admin.config.support.QueryOptionsConfiguration
-
- configure() - Method in class com.marklogic.client.admin.config.QueryOptionsBuilder
-
Deprecated.
Create a new QueryOptionsConfiguration object, which can be used to
fluently set various configuration options.
- configure(T) - Method in interface com.marklogic.client.DatabaseClientFactory.ClientConfigurator
-
Called as the last step in configuring the communication library.
- configure(DatabaseClient) - Static method in class com.marklogic.client.example.cookbook.RawClientAlert
-
- configure(String, int, String, String, DatabaseClientFactory.Authentication) - Static method in class com.marklogic.client.example.cookbook.SearchResponseTransform
-
- configure(String, int, String, String, DatabaseClientFactory.Authentication) - Static method in class com.marklogic.client.example.cookbook.StringSearch
-
- configure(String, int, String, String, DatabaseClientFactory.Authentication) - Static method in class com.marklogic.client.example.cookbook.StructuredSearch
-
- configure(String, int, String, String, DatabaseClientFactory.Authentication) - Static method in class com.marklogic.client.example.cookbook.Suggest
-
- configureExample(String, int, String, String, DatabaseClientFactory.Authentication) - Static method in class com.marklogic.client.example.extension.SearchCollectorExample
-
- configureQueryOptions(DatabaseClient) - Static method in class com.marklogic.client.example.extension.SearchCollectorExample
-
- constraint(String, ConstraintSource) - Method in class com.marklogic.client.admin.config.QueryOptionsBuilder
-
Deprecated.
Builds a constraint object with the supplied name and source.
- ConstraintSource - Interface in com.marklogic.client.admin.config.support
-
Marks the options configurations that can back constraints.
- constraintValue(String) - Method in class com.marklogic.client.admin.config.QueryOptionsBuilder
-
Deprecated.
Constructs an argument to be used for building ExtractMetadata
configuration.
- containerConstraint(String, StructuredQueryDefinition) - Method in class com.marklogic.client.query.StructuredQueryBuilder
-
Matches a query within the substructure of the container specified
by the constraint.
- containerQuery(StructuredQueryBuilder.ContainerIndex, StructuredQueryDefinition) - Method in class com.marklogic.client.query.StructuredQueryBuilder
-
Matches a query within the substructure contained by an element or JSON key.
- containsKey(Object) - Method in class com.marklogic.client.util.EditableNamespaceContext
-
Checks whether a prefix has a binding.
- containsKey(String) - Method in interface com.marklogic.client.util.NameMap
-
Whether the map contains the string name as a key.
- containsKey(Object) - Method in class com.marklogic.client.util.RequestParameters
-
Checks whether the parameter name has been specified.
- containsValue(Object) - Method in class com.marklogic.client.util.EditableNamespaceContext
-
Checks whether a namespace URI has a binding.
- containsValue(Object) - Method in class com.marklogic.client.util.RequestParameters
-
Checks whether any parameters have the value.
- ContentDescriptor - Interface in com.marklogic.client.document
-
A Content Descriptor identifies the properties of some content.
- ContentHandle<C> - Interface in com.marklogic.client.io.marker
-
A Content Handle provides get / set access to a representation
of content such a byte[] array, input stream, file, reader, string,
and so on.
- ContentHandleFactory - Interface in com.marklogic.client.io.marker
-
A ContentHandleFactory creates instances of a ContentHandle that provides
an adapter for an IO representation.
- convert(RawQueryByExampleDefinition, T) - Method in interface com.marklogic.client.query.QueryManager
-
Converts a query by example into a combined query that expresses the criteria
as a structured search.
- copy() - Method in interface com.marklogic.client.DatabaseClientFactory.HandleFactoryRegistry
-
Create a copy of the current registry
- copy(String) - Method in class com.marklogic.client.util.RequestParameters
-
Creates a copy of the parameters, prepending a namespace prefix
to each parameter name.
- copyContent(T) - Method in interface com.marklogic.client.util.RequestLogger
-
Copies content to the log during request processing
up to the length limit specified for the logger.
- CountedDistinctValue - Class in com.marklogic.client.query
-
A CountedDistinctValue is a value that includes a frequency.
- CountedDistinctValue() - Constructor for class com.marklogic.client.query.CountedDistinctValue
-
- create(DocumentUriTemplate, W) - Method in interface com.marklogic.client.document.DocumentManager
-
Creates a database document with a uri assigned by the server.
- create(DocumentUriTemplate, W, ServerTransform) - Method in interface com.marklogic.client.document.DocumentManager
-
Creates a database document with a uri assigned by the server as transformed on the server.
- create(DocumentUriTemplate, W, Transaction) - Method in interface com.marklogic.client.document.DocumentManager
-
Creates a database document with a uri assigned by the server in an open database transaction.
- create(DocumentUriTemplate, W, ServerTransform, Transaction) - Method in interface com.marklogic.client.document.DocumentManager
-
Creates a database document with a uri assigned by the server in an open database transaction as transformed on the server.
- create(DocumentUriTemplate, DocumentMetadataWriteHandle, W) - Method in interface com.marklogic.client.document.DocumentManager
-
Creates a database document with metadata and content and a uri assigned by the server.
- create(DocumentUriTemplate, DocumentMetadataWriteHandle, W, ServerTransform) - Method in interface com.marklogic.client.document.DocumentManager
-
Creates a database document with metadata and content and a uri assigned by the server as transformed on the server.
- create(DocumentUriTemplate, DocumentMetadataWriteHandle, W, Transaction) - Method in interface com.marklogic.client.document.DocumentManager
-
- create(DocumentUriTemplate, DocumentMetadataWriteHandle, W, ServerTransform, Transaction) - Method in interface com.marklogic.client.document.DocumentManager
-
Creates a database document with metadata and content and a uri assigned by the server in an open database transaction as transformed on the server.
- createAs(DocumentUriTemplate, Object) - Method in interface com.marklogic.client.document.DocumentManager
-
Creates a database document with a uri assigned by the server from an object of an IO class.
- createAs(DocumentUriTemplate, Object, ServerTransform) - Method in interface com.marklogic.client.document.DocumentManager
-
Creates a database document with a uri assigned by the server from an object of an IO class.
- createAs(DocumentUriTemplate, DocumentMetadataWriteHandle, Object) - Method in interface com.marklogic.client.document.DocumentManager
-
Creates a database document with a uri assigned by the server from an object of an IO class.
- createAs(DocumentUriTemplate, DocumentMetadataWriteHandle, Object, ServerTransform) - Method in interface com.marklogic.client.document.DocumentManager
-
Creates a database document with a uri assigned by the server from an object of an IO class.
- createDictionary(String, String[]) - Method in class com.marklogic.client.example.cookbook.ResourceExtension.DictionaryManager
-
- customConstraint(String, String...) - Method in class com.marklogic.client.query.StructuredQueryBuilder
-
Matches documents as specified by a constraint that implements
a custom query parameterized with the supplied text.
- customFacet(QueryOptions.XQueryExtension, QueryOptions.XQueryExtension, QueryOptions.XQueryExtension, String...) - Method in class com.marklogic.client.admin.config.QueryOptionsBuilder
-
Deprecated.
Defines an XQuery customization for specifying constraint faceting
behavior.
- customParse(QueryOptions.XQueryExtension, String...) - Method in class com.marklogic.client.admin.config.QueryOptionsBuilder
-
Deprecated.
Defines an XQuery customization for specifying constraint values.
- DatabaseClient - Interface in com.marklogic.client
-
A Database Client instantiates document and query managers and other objects
with shared access to a database.
- DatabaseClientFactory - Class in com.marklogic.client
-
A Database Client Factory configures a database client for making
database requests.
- DatabaseClientFactory.Authentication - Enum in com.marklogic.client
-
Authentication enumerates the methods for verifying a user and
password with the database.
- DatabaseClientFactory.Bean - Class in com.marklogic.client
-
A Database Client Factory Bean provides an object for specifying configuration
before creating a client to make database requests.
- DatabaseClientFactory.Bean() - Constructor for class com.marklogic.client.DatabaseClientFactory.Bean
-
Zero-argument constructor for bean applications.
- DatabaseClientFactory.ClientConfigurator<T> - Interface in com.marklogic.client
-
A ClientConfigurator provides custom configuration for the communication library
used to sending client requests and receiving server responses.
- DatabaseClientFactory.HandleFactoryRegistry - Interface in com.marklogic.client
-
A HandleFactoryRegistry associates IO representation classes
with handle factories.
- DatabaseClientFactory.SSLHostnameVerifier - Interface in com.marklogic.client
-
An SSLHostnameVerifier checks whether a hostname is acceptable
during SSL authentication.
- DatabaseClientFactory.SSLHostnameVerifier.Builtin - Class in com.marklogic.client
-
Builtin supports builtin implementations of SSLHostnameVerifier.
- debug(Boolean) - Method in class com.marklogic.client.admin.config.support.QueryOptionsConfiguration
-
- DEFAULT_COLLATION - Static variable in class com.marklogic.client.admin.config.QueryOptions
-
Deprecated.
- DEFAULT_PAGE_LENGTH - Static variable in interface com.marklogic.client.query.QueryManager
-
The default maximum number of documents in a page of search results.
- delete(String) - Method in interface com.marklogic.client.admin.ExtensionLibrariesManager
-
Removes a library asset from the server.
- delete(ExtensionLibraryDescriptor) - Method in interface com.marklogic.client.admin.ExtensionLibrariesManager
-
Removes a library asset from the server.
- delete(String) - Method in interface com.marklogic.client.alerting.RuleManager
-
Removes a rule from the server.
- delete(String) - Method in interface com.marklogic.client.document.DocumentManager
-
Deletes the document metadata and content from the database
To call delete(), an application must authenticate as rest-writer or rest-admin.
- delete(String, Transaction) - Method in interface com.marklogic.client.document.DocumentManager
-
Deletes the document metadata and content from an open database transaction
To call delete(), an application must authenticate as rest-writer or rest-admin.
- delete(DocumentDescriptor) - Method in interface com.marklogic.client.document.DocumentManager
-
Deletes the document metadata and content from the database
To call delete(), an application must authenticate as rest-writer or rest-admin.
- delete(DocumentDescriptor, Transaction) - Method in interface com.marklogic.client.document.DocumentManager
-
Deletes the document metadata and content from an open database transaction
To call delete(), an application must authenticate as rest-writer or rest-admin.
- delete(String) - Method in interface com.marklogic.client.document.DocumentPatchBuilder
-
Specifies an operation to delete an existing JSON or XML fragment.
- delete(String, DocumentMetadataPatchBuilder.Cardinality) - Method in interface com.marklogic.client.document.DocumentPatchBuilder
-
Specifies an operation to delete an existing JSON or XML fragment.
- delete() - Method in class com.marklogic.client.example.extension.GraphManager
-
Deletes the deafult graph
- delete(String) - Method in class com.marklogic.client.example.extension.GraphManager
-
Deletes a named graph.
- delete(RequestParameters, R) - Method in interface com.marklogic.client.extensions.ResourceServices
-
Deletes content by calling a DELETE service.
- delete(RequestParameters, Transaction, R) - Method in interface com.marklogic.client.extensions.ResourceServices
-
Deletes content by calling a DELETE service.
- delete(DeleteQueryDefinition) - Method in interface com.marklogic.client.query.QueryManager
-
Deletes documents based on the query criteria.
- delete(DeleteQueryDefinition, Transaction) - Method in interface com.marklogic.client.query.QueryManager
-
Deletes documents based on the query criteria as part
of the specified transaction.
- deleteAll() - Method in interface com.marklogic.client.admin.NamespacesManager
-
Deletes all namespace bindings on the server.
- deleteBuckets() - Method in class com.marklogic.client.admin.config.QueryOptions.QueryRange
-
Deprecated.
remove all computed and defined buckets from a RangeOption
- deleteCollection(String...) - Method in interface com.marklogic.client.document.DocumentMetadataPatchBuilder
-
Deletes the specified collections.
- deleteDictionary(String) - Method in class com.marklogic.client.example.cookbook.ResourceExtension.DictionaryManager
-
- deleteGraph(DatabaseClient) - Static method in class com.marklogic.client.example.extension.GraphSPARQLExample
-
- deleteOptions(String) - Method in interface com.marklogic.client.admin.QueryOptionsManager
-
Remove a search configuration from the REST server.
- deletePermission(String...) - Method in interface com.marklogic.client.document.DocumentMetadataPatchBuilder
-
Deletes the specified roles.
- deletePrefix(String) - Method in interface com.marklogic.client.admin.NamespacesManager
-
Deletes a namespace binding on the server.
- deleteProperty(String...) - Method in interface com.marklogic.client.document.DocumentMetadataPatchBuilder
-
Deletes the specified metadata properties with simple names.
- deleteProperty(QName...) - Method in interface com.marklogic.client.document.DocumentMetadataPatchBuilder
-
Deletes the specified metadata properties with namespaced names.
- DeleteQueryDefinition - Interface in com.marklogic.client.query
-
A DeleteQueryDefinition is a query definition suitable for use in performing a delete query.
- deleteServices(String) - Method in interface com.marklogic.client.admin.ResourceExtensionsManager
-
Uninstalls the services that implement a resource.
- deleteSortOrders() - Method in class com.marklogic.client.admin.config.QueryOptions.QueryState
-
Deprecated.
- deleteSuggestionOptions() - Method in class com.marklogic.client.admin.config.QueryOptions.QuerySuggestionSource
-
Deprecated.
- deleteTransform(String) - Method in interface com.marklogic.client.admin.TransformExtensionsManager
-
Uninstalls the transform.
- directory(boolean, String...) - Method in class com.marklogic.client.query.StructuredQueryBuilder
-
Matches documents at the specified depth within at least one
of the criteria directories.
- directory(int, String...) - Method in class com.marklogic.client.query.StructuredQueryBuilder
-
Matches documents at the specified depth within at least one
of the criteria directories.
- divideBy(Number) - Method in interface com.marklogic.client.document.DocumentMetadataPatchBuilder.CallBuilder
-
Calls the built-in method to divide an existing value
by the supplied number.
- document(String...) - Method in class com.marklogic.client.query.StructuredQueryBuilder
-
Matches the specified documents.
- DocumentDelete - Class in com.marklogic.client.example.cookbook
-
DocumentDelete illustrates how to delete a database document.
- DocumentDelete() - Constructor for class com.marklogic.client.example.cookbook.DocumentDelete
-
- DocumentDescriptor - Interface in com.marklogic.client.document
-
A Document Descriptor describes a database document.
- DocumentFormats - Class in com.marklogic.client.example.cookbook
-
DocumentFormats illustrates working with documents in multiple or unknown formats.
- DocumentFormats() - Constructor for class com.marklogic.client.example.cookbook.DocumentFormats
-
- documentFragment(StructuredQueryDefinition) - Method in class com.marklogic.client.query.StructuredQueryBuilder
-
Associates a query with the content of documents (as opposed to
the properties of documents).
- DocumentManager<R extends AbstractReadHandle,W extends AbstractWriteHandle> - Interface in com.marklogic.client.document
-
A Document Manager provides database operations on a document.
- DocumentManager.Metadata - Enum in com.marklogic.client.document
-
The Metadata enumeration specifies the categories of metadata read from or written to the database.
- DocumentMetadataHandle - Class in com.marklogic.client.io
-
A DocumentMetadataHandle represents the metadata for a database document
as a POJO (Plain Old Java Object).
- DocumentMetadataHandle() - Constructor for class com.marklogic.client.io.DocumentMetadataHandle
-
Zero-argument constructor.
- DocumentMetadataHandle.Capability - Enum in com.marklogic.client.io
-
A document operation restricted to users with a role.
- DocumentMetadataHandle.DocumentCollections - Interface in com.marklogic.client.io
-
A DocumentCollections represents the collections for a database document
as a POJO (Plain Old Java Object).
- DocumentMetadataHandle.DocumentPermissions - Interface in com.marklogic.client.io
-
A DocumentPermissions represents the permissions for a database document
as a POJO (Plain Old Java Object).
- DocumentMetadataHandle.DocumentProperties - Interface in com.marklogic.client.io
-
A DocumentProperties represents the properties for a database document
as a POJO (Plain Old Java Object).
- DocumentMetadataPatchBuilder - Interface in com.marklogic.client.document
-
A DocumentMetadataPatchBuilder specifies changes to the metadata
of a database document.
- DocumentMetadataPatchBuilder.Call - Interface in com.marklogic.client.document
-
A Call specifies how to apply a built-in or library function
when replacing an existing fragment.
- DocumentMetadataPatchBuilder.CallBuilder - Interface in com.marklogic.client.document
-
A CallBuilder constructs a Call to a built-in or library function
to produce the replacement for an existing fragment.
- DocumentMetadataPatchBuilder.Cardinality - Enum in com.marklogic.client.document
-
The Cardinality enumeration indicates the number of times
that a path can match without error (which defaults to
ZERO_OR_MORE, meaning any number of matches).
- DocumentMetadataPatchBuilder.PatchHandle - Interface in com.marklogic.client.document
-
A PatchHandle produced by the builder can produce a string
representation of the patch for saving, logging, or other uses.
- DocumentMetadataRead - Class in com.marklogic.client.example.cookbook
-
DocumentMetadataReader illustrates how to read the metadata and content of a database document
in a single request.
- DocumentMetadataRead() - Constructor for class com.marklogic.client.example.cookbook.DocumentMetadataRead
-
- DocumentMetadataReadHandle - Interface in com.marklogic.client.io.marker
-
A Metadata Read Handle can represent metadata read from the database.
- DocumentMetadataWrite - Class in com.marklogic.client.example.cookbook
-
DocumentMetadataWriter illustrates how to write metadata and content to a database document
in a single request.
- DocumentMetadataWrite() - Constructor for class com.marklogic.client.example.cookbook.DocumentMetadataWrite
-
- DocumentMetadataWriteHandle - Interface in com.marklogic.client.io.marker
-
A Document Metadata Write Handle can represent document metadata written to the database.
- DocumentOutputStream - Class in com.marklogic.client.example.cookbook
-
DocumentOutputStream illustrates how to write content to a document
using an OutputStream.
- DocumentOutputStream() - Constructor for class com.marklogic.client.example.cookbook.DocumentOutputStream
-
- DocumentPatchBuilder - Interface in com.marklogic.client.document
-
A DocumentPatchBuilder specifies changes to the metadata, content,
or both of a database document.
- DocumentPatchBuilder.Position - Enum in com.marklogic.client.document
-
The Position enumeration indicates the location relative
to the context for inserting content.
- DocumentPatchHandle - Interface in com.marklogic.client.io.marker
-
A Document Patch Handle can represent a patch with changes
to document metadata or structured content.
- DocumentRead - Class in com.marklogic.client.example.cookbook
-
DocumentReader illustrates how to read the content of a database document.
- DocumentRead() - Constructor for class com.marklogic.client.example.cookbook.DocumentRead
-
- DocumentReadTransform - Class in com.marklogic.client.example.cookbook
-
DocumentReadTransform installs a server transform for converting XML documents
with a known vocabulary to HTML documents for presentation.
- DocumentReadTransform() - Constructor for class com.marklogic.client.example.cookbook.DocumentReadTransform
-
- DocumentSplitter - Class in com.marklogic.client.example.extension
-
DocumentSplitter provides an extension for splitting an input XML document
into multiple documents.
- DocumentSplitter(DatabaseClient) - Constructor for class com.marklogic.client.example.extension.DocumentSplitter
-
- DocumentUriTemplate - Interface in com.marklogic.client.document
-
A DocumentUriTemplate specifies how the server should construct
a name for a document.
- DocumentWrite - Class in com.marklogic.client.example.cookbook
-
DocumentWriter illustrates how to write content to a database document.
- DocumentWrite() - Constructor for class com.marklogic.client.example.cookbook.DocumentWrite
-
- DocumentWriteServerURI - Class in com.marklogic.client.example.cookbook
-
DocumentWriterServerURI illustrates how to write content, letting MarkLogic assign a server URI
- DocumentWriteServerURI() - Constructor for class com.marklogic.client.example.cookbook.DocumentWriteServerURI
-
- DocumentWriteTransform - Class in com.marklogic.client.example.cookbook
-
DocumentWriteTransform installs a server transform for converting HTML documents
to XHTML documents so HTML documents can be written to the database, indexed,
and easily modified.
- DocumentWriteTransform() - Constructor for class com.marklogic.client.example.cookbook.DocumentWriteTransform
-
- doFacets(Boolean) - Method in class com.marklogic.client.admin.config.QueryOptions.FacetableConstraintConfiguration
-
Deprecated.
Perform facets on this constraint.
- DOM4JHandle - Class in com.marklogic.client.extra.dom4j
-
A DOM4JHandle represents XML content as a dom4j document for reading or writing.
- DOM4JHandle() - Constructor for class com.marklogic.client.extra.dom4j.DOM4JHandle
-
Zero-argument constructor.
- DOM4JHandle(Document) - Constructor for class com.marklogic.client.extra.dom4j.DOM4JHandle
-
Provides a handle on XML content as a dom4j document structure.
- DOM4JHandleExample - Class in com.marklogic.client.example.handle
-
DOM4JHandleExample illustrates writing and reading content as a dom4j structure
using the dom4j extra library.
- DOM4JHandleExample() - Constructor for class com.marklogic.client.example.handle.DOM4JHandleExample
-
- DOMHandle - Class in com.marklogic.client.io
-
A DOM Handle represents XML content as a DOM document for reading or writing.
- DOMHandle() - Constructor for class com.marklogic.client.io.DOMHandle
-
Zero-argument constructor.
- DOMHandle(Document) - Constructor for class com.marklogic.client.io.DOMHandle
-
Initializes the handle with a DOM document for the content.
- GenericDocumentManager - Interface in com.marklogic.client.document
-
A Generic Document Manager supports database operations on documents with an unknown format.
- GenericReadHandle - Interface in com.marklogic.client.io.marker
-
A Generic Read Handle can represent content of an unknown format read from the database.
- GenericWriteHandle - Interface in com.marklogic.client.io.marker
-
A Generic Write Handle can represent content of an unknown format written to the database.
- geoAttributePair(StructuredQueryBuilder.Element, StructuredQueryBuilder.Attribute, StructuredQueryBuilder.Attribute) - Method in class com.marklogic.client.query.StructuredQueryBuilder
-
Identifies a parent element with child latitude and longitude attributes
to match with a geospatial query.
- geoElement(StructuredQueryBuilder.Element) - Method in class com.marklogic.client.query.StructuredQueryBuilder
-
Identifies an element whose text has the latitude and longitude
coordinates to match with a geospatial query.
- geoElement(StructuredQueryBuilder.Element, StructuredQueryBuilder.Element) - Method in class com.marklogic.client.query.StructuredQueryBuilder
-
Identifies a parent element with a child element whose text has
the latitude and longitude coordinates to match with a geospatial query.
- geoElementPair(StructuredQueryBuilder.Element, StructuredQueryBuilder.Element, StructuredQueryBuilder.Element) - Method in class com.marklogic.client.query.StructuredQueryBuilder
-
Identifies a parent element with child latitude and longitude elements
to match with a geospatial query.
- geoPath(StructuredQueryBuilder.PathIndex) - Method in class com.marklogic.client.query.StructuredQueryBuilder
-
Identifies a path with the latitude and longitude to match
with a geospatial query.
- geospatial(GeospatialSpec, HeatmapAndOptions, String...) - Method in class com.marklogic.client.admin.config.QueryOptionsBuilder
-
Deprecated.
Builds a geospatial specification for a two-dimensional constraint.
- geospatial(GeospatialSpec, String...) - Method in class com.marklogic.client.admin.config.QueryOptionsBuilder
-
Deprecated.
Builds a geospatial specification for a two-dimensional constraint.
- geospatial(StructuredQueryBuilder.GeospatialIndex, StructuredQueryBuilder.Region...) - Method in class com.marklogic.client.query.StructuredQueryBuilder
-
Matches an element, element pair, element attribute, pair, or path
specifying a geospatial point that appears within one of the criteria regions.
- geospatial(StructuredQueryBuilder.GeospatialIndex, StructuredQueryBuilder.FragmentScope, String[], StructuredQueryBuilder.Region...) - Method in class com.marklogic.client.query.StructuredQueryBuilder
-
Matches an element, element pair, element attribute, pair, or path
specifying a geospatial point that appears within one of the criteria regions.
- geospatialConstraint(String, StructuredQueryBuilder.Region...) - Method in class com.marklogic.client.query.StructuredQueryBuilder
-
Matches the container specified by the constraint
whose geospatial point appears within one of the criteria regions.
- GeospatialIndex - Interface in com.marklogic.client.admin.config.support
-
Marker for geospatial index configurations.
- GeospatialIndexType - Enum in com.marklogic.client.admin.config.support
-
- GeospatialSpec - Interface in com.marklogic.client.admin.config.support
-
Defines an interface to the methods for storing
geospatial values in MarkLogic indexes.
- get(int) - Method in class com.marklogic.client.admin.config.QueryOptions.QueryAnnotation
-
Deprecated.
- get() - Method in class com.marklogic.client.example.handle.HTMLCleanerHandle
-
- get() - Method in class com.marklogic.client.example.handle.URIHandle
-
- get(RequestParameters, R) - Method in interface com.marklogic.client.extensions.ResourceServices
-
Reads resource content by calling a GET service.
- get(RequestParameters, Transaction, R) - Method in interface com.marklogic.client.extensions.ResourceServices
-
Reads resource content by calling a GET service.
- get(RequestParameters, String...) - Method in interface com.marklogic.client.extensions.ResourceServices
-
Reads multiple resource content by calling a GET service.
- get(RequestParameters, Transaction, String...) - Method in interface com.marklogic.client.extensions.ResourceServices
-
Reads multiple resource content by calling a GET service.
- get() - Method in class com.marklogic.client.extra.dom4j.DOM4JHandle
-
Returns the XML document structure.
- get() - Method in class com.marklogic.client.extra.gson.GSONHandle
-
Returns the root node of the JSON tree.
- get() - Method in class com.marklogic.client.extra.jackson.JacksonHandle
-
Returns the root node of the JSON tree.
- get() - Method in class com.marklogic.client.extra.jdom.JDOMHandle
-
Returns the XML document structure.
- get() - Method in class com.marklogic.client.extra.xom.XOMHandle
-
Returns the XML document structure.
- get() - Method in class com.marklogic.client.io.BytesHandle
-
Returns the byte array for the handle content.
- get() - Method in class com.marklogic.client.io.DOMHandle
-
Returns the DOM document for the content.
- get() - Method in class com.marklogic.client.io.FileHandle
-
Returns the file for the handle content.
- get() - Method in class com.marklogic.client.io.InputSourceHandle
-
Returns the input source for the content.
- get() - Method in class com.marklogic.client.io.InputStreamHandle
-
Returns an input stream for a resource read from the database.
- get() - Method in class com.marklogic.client.io.JAXBHandle
-
Returns the root object of the JAXB structure for the content.
- get(Class<T>) - Method in class com.marklogic.client.io.JAXBHandle
-
Returns the root object of the JAXB structure for the content
cast to a more specific class.
- get() - Method in interface com.marklogic.client.io.marker.ContentHandle
-
Returns the content.
- get() - Method in class com.marklogic.client.io.OutputStreamHandle
-
Returns the output stream sender that writes the content.
- get() - Method in class com.marklogic.client.io.ReaderHandle
-
Returns a character reader for reading content.
- get() - Method in class com.marklogic.client.io.SourceHandle
-
Returns the transform source that produces the content.
- get() - Method in class com.marklogic.client.io.StringHandle
-
Returns the string for the content.
- get() - Method in class com.marklogic.client.io.XMLEventReaderHandle
-
Returns an XML Event Reader for for reading a resource from the database
as a series of StAX events.
- get() - Method in class com.marklogic.client.io.XMLStreamReaderHandle
-
Returns an XML Stream Reader for for reading a resource from the database
as a StAX pull stream.
- get(String, Class<T>) - Method in class com.marklogic.client.query.AggregateResult
-
Returns the value cast to the specified type.
- get(String, Class<T>) - Method in class com.marklogic.client.query.CountedDistinctValue
-
Returns the value cast to the specified type.
- get(Class<T>) - Method in class com.marklogic.client.query.TypedDistinctValue
-
Returns the value as an instance of the specified class.
- get(Object) - Method in class com.marklogic.client.util.EditableNamespaceContext
-
Returns the URI for a prefix.
- get(String) - Method in interface com.marklogic.client.util.NameMap
-
Returns the value of the string name.
- get(QName, Class<T>) - Method in interface com.marklogic.client.util.NameMap
-
Returns the value of the QName, cast to the supplied type.
- get(String, Class<T>) - Method in interface com.marklogic.client.util.NameMap
-
Returns the value of the string name, cast to the supplied type.
- get(Object) - Method in class com.marklogic.client.util.RequestParameters
-
Gets the values for a parameter name.
- getAdditionalQuery() - Method in class com.marklogic.client.admin.config.QueryOptions
-
Deprecated.
- getAdditionalQuery() - Method in class com.marklogic.client.admin.config.QueryOptions.QueryState
-
Deprecated.
- getAdditionalQuery() - Method in class com.marklogic.client.io.QueryOptionsHandle
-
Deprecated.
Returns the additional query from a query options configuration.
- getAggregate() - Method in class com.marklogic.client.admin.config.QueryOptions.QueryTuples
-
Deprecated.
- getAggregate() - Method in class com.marklogic.client.admin.config.QueryOptions.QueryValues
-
Deprecated.
- getAggregate(String) - Method in class com.marklogic.client.io.TuplesHandle
-
- getAggregate(String) - Method in class com.marklogic.client.io.ValuesHandle
-
- getAggregate(String) - Method in interface com.marklogic.client.query.TuplesResults
-
Returns the aggregate result for the named aggregate function.
- getAggregate() - Method in interface com.marklogic.client.query.ValuesDefinition
-
Returns the name of the aggregate function applied to this query.
- getAggregate(String) - Method in interface com.marklogic.client.query.ValuesResults
-
Returns the aggregate result for the named aggregate function.
- getAggregatePath() - Method in interface com.marklogic.client.query.ValuesDefinition
-
Returns the aggregate path.
- getAggregateResolutionTime() - Method in interface com.marklogic.client.query.ValuesMetrics
-
Returns the facet resolution time in milliseconds.
- getAggregates() - Method in class com.marklogic.client.io.TuplesHandle
-
- getAggregates() - Method in class com.marklogic.client.io.ValuesHandle
-
- getAggregates() - Method in interface com.marklogic.client.query.TuplesResults
-
Returns an array of the aggregates.
- getAggregates() - Method in interface com.marklogic.client.query.ValuesResults
-
Returns an array of the aggregates.
- getAll() - Method in class com.marklogic.client.admin.config.QueryOptions.QueryAnnotation
-
Deprecated.
- getAllPrefixes() - Method in class com.marklogic.client.util.EditableNamespaceContext
-
Returns all bound prefixes.
- getAllPrefixes() - Method in interface com.marklogic.client.util.IterableNamespaceContext
-
Returns all bound prefixes.
- getAllSnippetText() - Method in interface com.marklogic.client.query.MatchLocation
-
Returns the entire text of the snippet.
- getAnchor() - Method in class com.marklogic.client.admin.config.QueryOptions.QueryRange.ComputedBucket
-
Deprecated.
Returns a value for anchoring this computed bucket.
- getAnchorValue() - Method in class com.marklogic.client.admin.config.QueryOptions.QueryRange.ComputedBucket
-
Deprecated.
- getAnnotations() - Method in class com.marklogic.client.admin.config.QueryOptions.DefaultTermSource
-
Deprecated.
- getAnnotations() - Method in class com.marklogic.client.admin.config.QueryOptions
-
Deprecated.
- getAnnotations() - Method in class com.marklogic.client.admin.config.QueryOptions.QueryConstraint
-
Deprecated.
Returns the list of annotations on the constraint.
- getAnnotations() - Method in class com.marklogic.client.admin.config.QueryOptions.QueryCustom
-
Deprecated.
Gets the annotations on this custom constraint.
- getAnnotations() - Method in class com.marklogic.client.admin.config.QueryOptions.QueryOperator
-
Deprecated.
- getAnnotations() - Method in class com.marklogic.client.admin.config.QueryOptions.QuerySortOrder
-
Deprecated.
- getAnnotations() - Method in class com.marklogic.client.admin.config.QueryOptions.QueryState
-
Deprecated.
- getAnnotations() - Method in class com.marklogic.client.admin.config.QueryOptions.QuerySuggestionSource
-
Deprecated.
- getAnnotations() - Method in class com.marklogic.client.admin.config.QueryOptions.QueryTerm
-
Deprecated.
- getAnnotations() - Method in class com.marklogic.client.admin.config.QueryOptions.QueryTuples
-
Deprecated.
- getAnnotations() - Method in class com.marklogic.client.admin.config.QueryOptions.QueryValues
-
Deprecated.
- getAnnotations() - Method in interface com.marklogic.client.admin.config.support.Annotatable
-
- getAnnotations() - Method in class com.marklogic.client.io.QueryOptionsHandle
-
Deprecated.
Returns a List of all the annotations in the query options.
- getApply() - Method in class com.marklogic.client.admin.config.QueryOptions.Aggregate
-
Deprecated.
Gets the apply function.
- getApply() - Method in class com.marklogic.client.admin.config.QueryOptions.QueryGrammar.QueryJoiner
-
Deprecated.
- getApply() - Method in class com.marklogic.client.admin.config.QueryOptions.QueryGrammar.QueryStarter
-
Deprecated.
- getApply() - Method in class com.marklogic.client.admin.config.QueryOptions.QueryTransformResults
-
Deprecated.
- getApply() - Method in class com.marklogic.client.admin.config.QueryOptions.XQueryExtension
-
Deprecated.
- getAt() - Method in class com.marklogic.client.admin.config.QueryOptions.QueryTransformResults
-
Deprecated.
- getAt() - Method in class com.marklogic.client.admin.config.QueryOptions.XQueryExtension
-
Deprecated.
- getAttribute() - Method in class com.marklogic.client.admin.config.QueryOptions.BaseConstraintItem
-
Deprecated.
Gets the XML QName referring to an attribute.
- getAttribute() - Method in class com.marklogic.client.admin.config.QueryOptions.QuerySortOrder
-
Deprecated.
- getAttribute() - Method in interface com.marklogic.client.admin.config.support.IndexSpec
-
- getAttribute() - Method in class com.marklogic.client.admin.config.support.IndexSpecImpl
-
- getAttribute() - Method in interface com.marklogic.client.query.ElementLocator
-
Returns the name of the attribute (if specified).
- getAttrName() - Method in class com.marklogic.client.admin.config.QueryOptions.AttributeOrElementValue
-
Deprecated.
- getAttrNs() - Method in class com.marklogic.client.admin.config.QueryOptions.AttributeOrElementValue
-
Deprecated.
- getAuthentication() - Method in class com.marklogic.client.DatabaseClientFactory.Bean
-
Returns the authentication type for clients created with a
DatabaseClientFactory.Bean object.
- getAuthType() - Method in class com.marklogic.client.example.util.Bootstrapper.ConfigServer
-
- getBaseUri() - Method in class com.marklogic.client.example.handle.URIHandle
-
- getBatchSize() - Method in class com.marklogic.client.example.extension.OpenCSVBatcher
-
- getBindings() - Method in class com.marklogic.client.admin.config.QueryOptions.PathIndex
-
Deprecated.
- getBindings() - Method in class com.marklogic.client.admin.config.QueryOptions.QuerySearchableExpression
-
Deprecated.
Gets the array of namespace to prefix bindings
- getBox() - Method in interface com.marklogic.client.query.FacetHeatmapValue
-
Returns the box associated with the heatmap as an array.
- getBuckets() - Method in class com.marklogic.client.admin.config.QueryOptions.QueryRange
-
Deprecated.
Returns the list of buckets for this QueryRange.
- getBuilder() - Method in class com.marklogic.client.extra.jdom.JDOMHandle
-
Returns the JDOM structure builder for XML content.
- getBuilder() - Method in class com.marklogic.client.extra.xom.XOMHandle
-
Returns the XOM structure builder for XML content.
- getByteLength() - Method in interface com.marklogic.client.document.ContentDescriptor
-
Returns the length of the content in bytes.
- getByteLength() - Method in class com.marklogic.client.io.BaseHandle
-
- getCapability() - Method in class com.marklogic.client.admin.ExtensionLibraryDescriptor.Permission
-
gets the capability of this permission
- getClient() - Method in class com.marklogic.client.example.handle.URIHandle
-
- getClientImplementation() - Method in interface com.marklogic.client.DatabaseClient
-
Returns the client object from the library that implements communication with the
server.
- getCollation() - Method in class com.marklogic.client.admin.config.QueryOptions.FacetableConstraintConfiguration
-
Deprecated.
Returns the collation for this facetable constraint.
- getCollation() - Method in class com.marklogic.client.admin.config.QueryOptions.QuerySortOrder
-
Deprecated.
- getCollation() - Method in class com.marklogic.client.admin.config.QueryOptions.WordLexicon
-
Deprecated.
- getCollation() - Method in class com.marklogic.client.admin.config.support.RangeIndexType
-
- getCollation() - Method in interface com.marklogic.client.admin.config.support.RangeSpec
-
- getCollection() - Method in class com.marklogic.client.admin.config.QueryOptions.QueryTuples
-
Deprecated.
- getCollection() - Method in class com.marklogic.client.admin.config.QueryOptions.QueryValues
-
Deprecated.
- getCollections() - Method in class com.marklogic.client.io.DocumentMetadataHandle
-
Returns a container for the collections for the document
as read from the server or modified locally.
- getCollections() - Method in interface com.marklogic.client.query.QueryDefinition
-
Returns the array of collections to which the query is limited.
- getComparator() - Method in class com.marklogic.client.admin.config.QueryOptions.QueryGrammar.QueryJoiner
-
Deprecated.
- getComputedBuckets() - Method in class com.marklogic.client.admin.config.QueryOptions.QueryRange
-
Deprecated.
The list of computed buckets for this QueryRange.
- getConcurrencyLevel() - Method in class com.marklogic.client.admin.config.QueryOptions
-
Deprecated.
- getConcurrencyLevel() - Method in class com.marklogic.client.admin.config.support.QueryOptionsConfiguration
-
- getConcurrencyLevel() - Method in class com.marklogic.client.io.QueryOptionsHandle
-
Deprecated.
Returns the concurrency level from the query options configuration.
- getConfidence() - Method in interface com.marklogic.client.query.MatchDocumentSummary
-
Returns the confidence messsure associated with the document.
- getConfiguration() - Method in class com.marklogic.client.example.handle.HTMLCleanerHandle
-
- getConstraint(String) - Method in class com.marklogic.client.io.QueryOptionsHandle
-
Deprecated.
Return the named query constraint from the query options.
- getConstraint(String, T) - Method in class com.marklogic.client.io.SearchHandle
-
- getConstraint(String, T) - Method in interface com.marklogic.client.query.SearchResults
-
Returns the named constraint used in the search
(if requested).
- getConstraintConfiguration() - Method in class com.marklogic.client.admin.config.QueryOptions.QuerySuggestionSource
-
Deprecated.
- getConstraintIterator(T) - Method in class com.marklogic.client.io.SearchHandle
-
- getConstraintIterator(T) - Method in interface com.marklogic.client.query.SearchResults
-
Returns an iterator over the constraints used in the search
(if requested).
- getConstraintNames() - Method in class com.marklogic.client.io.SearchHandle
-
- getConstraintNames() - Method in interface com.marklogic.client.query.SearchResults
-
Returns the array of constraint names used in the search
(if requested).
- getConstraints() - Method in class com.marklogic.client.io.QueryOptionsHandle
-
Deprecated.
Returns a List of all the constraints in the query options.
- getConstraintValues() - Method in class com.marklogic.client.admin.config.QueryOptions.QueryExtractMetadata
-
Deprecated.
- getConsume() - Method in class com.marklogic.client.admin.config.QueryOptions.QueryGrammar.QueryJoiner
-
Deprecated.
- getContent() - Method in class com.marklogic.client.admin.config.QueryOptions.QueryRange.Bucket
-
Deprecated.
Returns the textual label for the bucket.
- getContent(R) - Method in class com.marklogic.client.example.extension.BatchManager.ReadOutput
-
- getContent(R) - Method in interface com.marklogic.client.extensions.ResourceServices.ServiceResult
-
Returns a handle on the content.
- getContentFormat() - Method in interface com.marklogic.client.document.DocumentManager
-
Gets the format of the managed documents
- getContentMax() - Method in interface com.marklogic.client.util.RequestLogger
-
Returns how much content is copied to the log.
- getContentMimetype() - Method in class com.marklogic.client.example.extension.BatchManager.ReadOutput
-
- getContentVersionRequests() - Method in interface com.marklogic.client.admin.ServerConfigurationManager
-
- getContext() - Method in class com.marklogic.client.DatabaseClientFactory.Bean
-
Returns the SSLContext for SSL clients created with a
DatabaseClientFactory.Bean object.
- getContext() - Method in class com.marklogic.client.example.handle.URIHandle
-
- getCount() - Method in class com.marklogic.client.query.CountedDistinctValue
-
Returns the frequency associated with this value.
- getCount() - Method in interface com.marklogic.client.query.FacetValue
-
Returns the count of items for that facet value.
- getCount() - Method in class com.marklogic.client.query.Tuple
-
Returns the frequency of this tuple in the database.
- getCriteria() - Method in interface com.marklogic.client.query.StringQueryDefinition
-
Returns the query criteria, that is the query string.
- getCursorPosition() - Method in interface com.marklogic.client.query.SuggestDefinition
-
Returns the cursor position for the suggest call.
- getDatabase() - Method in class com.marklogic.client.example.util.Bootstrapper.RESTServer
-
- getDebug() - Method in class com.marklogic.client.admin.config.QueryOptions
-
Deprecated.
- getDebug() - Method in class com.marklogic.client.admin.config.QueryOptions.QueryState
-
Deprecated.
- getDebug() - Method in class com.marklogic.client.admin.config.support.QueryOptionsConfiguration
-
- getDebug() - Method in class com.marklogic.client.io.QueryOptionsHandle
-
Deprecated.
Returns the state of the Debug flag in the query options.
- getDefaultDocumentReadTransform() - Method in interface com.marklogic.client.admin.ServerConfigurationManager
-
Returns the name of the default transform for reading documents.
- getDefaultDocumentReadTransformAll() - Method in interface com.marklogic.client.admin.ServerConfigurationManager
-
Returns whether the default transform for reading documents
applies to all users or only users with the rest-reader role.
- getDefaultMimetype() - Method in enum com.marklogic.client.io.Format
-
Returns the default mime type for the format.
- getDefaultNamespaceURI() - Method in class com.marklogic.client.util.EditableNamespaceContext
-
Returns the namespace URI bound to the empty prefix.
- getDefaultSuggestionSource() - Method in class com.marklogic.client.admin.config.QueryOptions
-
Deprecated.
- getDefaultSuggestionSource() - Method in class com.marklogic.client.io.QueryOptionsHandle
-
Deprecated.
Returns the default suggestion source in the query options.
- getDefaultWriteSchema() - Method in class com.marklogic.client.io.InputSourceHandle
-
Returns the default schema for validating the input source
while writing to the database.
- getDelimiter() - Method in class com.marklogic.client.admin.config.QueryOptions.QueryGrammar.QueryJoiner
-
Deprecated.
- getDelimiter() - Method in class com.marklogic.client.admin.config.QueryOptions.QueryGrammar.QueryStarter
-
Deprecated.
- getDescription() - Method in class com.marklogic.client.admin.ExtensionMetadata
-
Returns the description of the extension.
- getDescription() - Method in class com.marklogic.client.alerting.RuleDefinition
-
Returns the rule's definition.
- getDescription() - Method in class com.marklogic.client.example.cookbook.JAXBDocument.Product
-
- getDirection() - Method in class com.marklogic.client.admin.config.QueryOptions.QuerySortOrder
-
Deprecated.
- getDirection() - Method in interface com.marklogic.client.query.ValuesDefinition
-
Returns the direction of the results in this values query.
- getDirectory() - Method in interface com.marklogic.client.document.DocumentUriTemplate
-
Returns the directory that should prefix the document uri.
- getDirectory() - Method in interface com.marklogic.client.query.QueryDefinition
-
Returns the directory to which the query is limited.
- getDocumentRepair() - Method in interface com.marklogic.client.document.XMLDocumentManager
-
Returns the repair policy for XML documents written by the manager.
- getDoFacets() - Method in class com.marklogic.client.admin.config.QueryOptions.FacetableConstraintConfiguration
-
Deprecated.
Return whether this constraint is configured for facets.
- getE() - Method in class com.marklogic.client.admin.config.QueryOptions.Heatmap
-
Deprecated.
Returns the east longitude.
- getElement() - Method in class com.marklogic.client.admin.config.QueryOptions.BaseConstraintItem
-
Deprecated.
Gets the XML QName referring to an element.
- getElement() - Method in class com.marklogic.client.admin.config.QueryOptions.QueryGrammar.QueryJoiner
-
Deprecated.
- getElement() - Method in class com.marklogic.client.admin.config.QueryOptions.QueryGrammar.QueryStarter
-
Deprecated.
- getElement() - Method in class com.marklogic.client.admin.config.QueryOptions.QuerySortOrder
-
Deprecated.
- getElement() - Method in interface com.marklogic.client.admin.config.support.GeospatialSpec
-
- getElement() - Method in interface com.marklogic.client.admin.config.support.IndexSpec
-
- getElement() - Method in class com.marklogic.client.admin.config.support.IndexSpecImpl
-
- getElement() - Method in interface com.marklogic.client.query.ElementLocator
-
Returns the name of the element containing the attribute
or value.
- getElements() - Method in class com.marklogic.client.admin.config.QueryOptions.PreferredElements
-
Deprecated.
- getElemName() - Method in class com.marklogic.client.admin.config.QueryOptions.AttributeOrElementValue
-
Deprecated.
- getElemNs() - Method in class com.marklogic.client.admin.config.QueryOptions.AttributeOrElementValue
-
Deprecated.
- getEmptyApply() - Method in class com.marklogic.client.admin.config.QueryOptions.QueryTerm
-
Deprecated.
- getErrorFormat() - Method in interface com.marklogic.client.admin.ServerConfigurationManager
-
Returns the configured error format for the REST server instance.
- getErrorHandler() - Method in class com.marklogic.client.io.InputSourceHandle
-
Returns the error handler for errors discovered while parsing
the input source.
- getException(R) - Method in class com.marklogic.client.example.extension.BatchManager.OutputItem
-
- getExtension() - Method in interface com.marklogic.client.document.DocumentUriTemplate
-
Returns the extension that should suffix the document uri.
- getExtractMetadata() - Method in class com.marklogic.client.admin.config.QueryOptions
-
Deprecated.
- getExtractMetadata() - Method in class com.marklogic.client.io.QueryOptionsHandle
-
Deprecated.
Returns the extract metadata setting from the options node.
- getFacetNames() - Method in class com.marklogic.client.io.SearchHandle
-
Returns a list of the facet names returned in this search.
- getFacetNames() - Method in interface com.marklogic.client.query.SearchResults
-
Returns the array of facet names returned by this search.
- getFacetOptions() - Method in class com.marklogic.client.admin.config.QueryOptions.FacetableConstraintConfiguration
-
Deprecated.
Get the list of facet options.
- getFacetOptions() - Method in class com.marklogic.client.admin.config.support.HeatmapAndOptions
-
- getFacetResolutionTime() - Method in interface com.marklogic.client.query.SearchMetrics
-
Returns the facet resolution time in milliseconds.
- getFacetResult(String) - Method in class com.marklogic.client.io.SearchHandle
-
Returns the named facet results.
- getFacetResult(String) - Method in interface com.marklogic.client.query.SearchResults
-
Returns the facet results for the named facet.
- getFacetResults() - Method in class com.marklogic.client.io.SearchHandle
-
Returns an array of facet results for this search.
- getFacetResults() - Method in interface com.marklogic.client.query.SearchResults
-
Returns the array of facet results.
- getFacetValues() - Method in interface com.marklogic.client.query.FacetResult
-
Returns an array of the facet values.
- getFactory() - Method in class com.marklogic.client.io.DOMHandle
-
Returns the factory for building DOM documents.
- getFactory() - Method in class com.marklogic.client.io.InputSourceHandle
-
Returns the factory for parsing SAX events.
- getFactory() - Method in class com.marklogic.client.io.XMLEventReaderHandle
-
Returns the factory for parsing StAX events.
- getFactory() - Method in class com.marklogic.client.io.XMLStreamReaderHandle
-
Returns the factory for parsing StAX streams.
- getFailedRequest() - Method in exception com.marklogic.client.MarkLogicServerException
-
- getField() - Method in class com.marklogic.client.admin.config.QueryOptions.QueryTuples
-
Deprecated.
- getField() - Method in class com.marklogic.client.admin.config.QueryOptions.QueryValues
-
Deprecated.
- getField() - Method in interface com.marklogic.client.admin.config.support.IndexSpec
-
- getField() - Method in class com.marklogic.client.admin.config.support.IndexSpecImpl
-
- getFieldName() - Method in class com.marklogic.client.admin.config.QueryOptions.BaseConstraintItem
-
Deprecated.
Gets the name of a field that backs this constraint.
- getFieldName() - Method in class com.marklogic.client.admin.config.QueryOptions.QuerySortOrder
-
Deprecated.
- getFinishFacet() - Method in class com.marklogic.client.admin.config.QueryOptions.QueryCustom
-
Deprecated.
Returns the XQuery function called to finish the facet.
- getFirstSnippet(T) - Method in interface com.marklogic.client.query.MatchDocumentSummary
-
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.
- getFirstSnippetAs(Class<T>) - Method in interface com.marklogic.client.query.MatchDocumentSummary
-
Reads the content of the first snippet for the matched result document
in the representation specified by the IO class.
- getFirstSnippetText() - Method in interface com.marklogic.client.query.MatchDocumentSummary
-
Returns the text of the first snippet as a convenience,
especially for a raw snippet that contains an entire document
in JSON or text format.
- getFitness() - Method in interface com.marklogic.client.query.MatchDocumentSummary
-
Returns the fitness of the document.
- getForestName() - Method in interface com.marklogic.client.document.DocumentManager
-
Returns the name of the forest that should store written documents.
- getForests() - Method in class com.marklogic.client.admin.config.QueryOptions
-
Deprecated.
- getForests() - Method in class com.marklogic.client.admin.config.QueryOptions.QueryState
-
Deprecated.
- getForests() - Method in class com.marklogic.client.admin.config.support.QueryOptionsConfiguration
-
- getForests() - Method in class com.marklogic.client.io.QueryOptionsHandle
-
Deprecated.
Returns a List of the forest constraints.
- getFormat() - Method in interface com.marklogic.client.document.ContentDescriptor
-
Returns the format of the content.
- getFormat() - Method in interface com.marklogic.client.extensions.ResourceServices.ServiceResult
-
Returns the format of the content.
- getFormat() - Method in class com.marklogic.client.io.BaseHandle
-
- getFormat() - Method in class com.marklogic.client.io.QueryOptionsHandle
-
Deprecated.
Returns the underlying format supported by the query options handle.
- getFormat() - Method in interface com.marklogic.client.query.MatchDocumentSummary
-
Returns the format associated with this document
- getFragmentScope() - Method in class com.marklogic.client.admin.config.QueryOptions.BaseConstraintItem
-
Deprecated.
Gets the FragmenScope of this constraint source.
- getFragmentScope() - Method in class com.marklogic.client.admin.config.QueryOptions
-
Deprecated.
- getFragmentScope() - Method in class com.marklogic.client.admin.config.QueryOptions.WordLexicon
-
Deprecated.
- getFragmentScope() - Method in class com.marklogic.client.admin.config.support.QueryOptionsConfiguration
-
- getFragmentScope() - Method in class com.marklogic.client.io.QueryOptionsHandle
-
Deprecated.
Returns the fragment scope setting from the query options.
- getFrequency() - Method in interface com.marklogic.client.query.ValuesDefinition
-
Returns the frequency of the results.
- getGe() - Method in class com.marklogic.client.admin.config.QueryOptions.QueryRange.Bucket
-
Deprecated.
Returns the low end of the bucket's range.
- getGe() - Method in class com.marklogic.client.admin.config.QueryOptions.QueryRange.ComputedBucket
-
Deprecated.
Returns the low end of the bucket's range.
- getGeAnchor() - Method in class com.marklogic.client.admin.config.QueryOptions.QueryRange.ComputedBucket
-
Deprecated.
Returns a value for anchoring the "greater than or equal" value
for this computed bucket.
- getGeoAttrPair() - Method in class com.marklogic.client.admin.config.QueryOptions.QueryTuples
-
Deprecated.
- getGeoAttrPair() - Method in class com.marklogic.client.admin.config.QueryOptions.QueryValues
-
Deprecated.
- getGeoElem() - Method in class com.marklogic.client.admin.config.QueryOptions.QueryTuples
-
Deprecated.
- getGeoElem() - Method in class com.marklogic.client.admin.config.QueryOptions.QueryValues
-
Deprecated.
- getGeoElemPair() - Method in class com.marklogic.client.admin.config.QueryOptions.QueryTuples
-
Deprecated.
- getGeoElemPair() - Method in class com.marklogic.client.admin.config.QueryOptions.QueryValues
-
Deprecated.
- getGeospatialIndexType() - Method in interface com.marklogic.client.admin.config.support.GeospatialSpec
-
- getGrammar() - Method in class com.marklogic.client.admin.config.QueryOptions
-
Deprecated.
- getGrammar() - Method in class com.marklogic.client.io.QueryOptionsHandle
-
Deprecated.
Returns the search grammar specified in the query options.
- getGroup() - Method in class com.marklogic.client.example.util.Bootstrapper.RESTServer
-
- getHandle() - Method in interface com.marklogic.client.query.RawQueryDefinition
-
Returns the handle for the JSON or XML representation of the query.
- getHandledClasses() - Method in interface com.marklogic.client.io.marker.ContentHandleFactory
-
Returns classes that the handle always supports;
- getHandleRegistry() - Method in class com.marklogic.client.DatabaseClientFactory.Bean
-
Returns the registry for associating
IO representation classes with handle factories.
- getHandleRegistry() - Static method in class com.marklogic.client.DatabaseClientFactory
-
Returns the default registry with factories for creating handles
as adapters for IO representations.
- getHasHeader() - Method in class com.marklogic.client.example.extension.OpenCSVBatcher
-
- getHeatmap() - Method in class com.marklogic.client.admin.config.support.HeatmapAndOptions
-
- getHost() - Method in class com.marklogic.client.DatabaseClientFactory.Bean
-
Returns the host for clients created with a
DatabaseClientFactory.Bean object.
- getHost() - Method in class com.marklogic.client.example.util.Bootstrapper.ConfigServer
-
- getId() - Method in class com.marklogic.client.io.SearchHandle.Report
-
Returns the ID of the message.
- getId() - Method in class com.marklogic.client.io.SearchHandle.Warning
-
Returns the ID of the warning.
- getImplicit() - Method in class com.marklogic.client.admin.config.QueryOptions.QueryGrammar
-
Deprecated.
- getIndustry() - Method in class com.marklogic.client.example.cookbook.JAXBDocument.Product
-
- getJoiners() - Method in class com.marklogic.client.admin.config.QueryOptions.QueryGrammar
-
Deprecated.
- getJoinerText() - Method in class com.marklogic.client.admin.config.QueryOptions.QueryGrammar.QueryJoiner
-
Deprecated.
- getJsonKey() - Method in class com.marklogic.client.admin.config.QueryOptions.QuerySortOrder
-
Deprecated.
- getJsonKey() - Method in class com.marklogic.client.admin.config.QueryOptions.QueryTuples
-
Deprecated.
- getJsonKey() - Method in class com.marklogic.client.admin.config.QueryOptions.QueryValues
-
Deprecated.
- getJsonKey() - Method in interface com.marklogic.client.admin.config.support.IndexSpec
-
- getJsonKey() - Method in class com.marklogic.client.admin.config.support.IndexSpecImpl
-
- getJsonKeyName() - Method in class com.marklogic.client.admin.config.QueryOptions.BaseConstraintItem
-
Deprecated.
Gets the name of a json key that backs this constraint.
- getJsonKeyName() - Method in class com.marklogic.client.admin.config.QueryOptions.QueryValues
-
Deprecated.
- getJsonKeys() - Method in class com.marklogic.client.admin.config.QueryOptions.QueryExtractMetadata
-
Deprecated.
- getKey() - Method in interface com.marklogic.client.query.KeyLocator
-
Returns a JSON key.
- getLabel() - Method in class com.marklogic.client.admin.config.QueryOptions.QueryRange.ComputedBucket
-
Deprecated.
Returns the textual label for the bucket.
- getLabel() - Method in interface com.marklogic.client.query.FacetValue
-
Returns the label associated with that facet value.
- getLanguage() - Method in interface com.marklogic.client.document.JSONDocumentManager
-
Returns the language code for JSON documents written by the manager.
- getLatdivs() - Method in class com.marklogic.client.admin.config.QueryOptions.Heatmap
-
Deprecated.
Returns the number of latitudinal divisions.
- getLatitude() - Method in interface com.marklogic.client.admin.config.support.GeospatialSpec
-
- getLatitude() - Method in class com.marklogic.client.query.StructuredQueryBuilder.Point
-
Deprecated.
- getLength() - Method in interface com.marklogic.client.extensions.ResourceServices.ServiceResult
-
Returns the length of the content in bytes.
- getLimit() - Method in interface com.marklogic.client.query.SuggestDefinition
-
Returns the maximum number of suggestions to fetch.
- getLondivs() - Method in class com.marklogic.client.admin.config.QueryOptions.Heatmap
-
Deprecated.
Returns the number of longitudinal divisions.
- getLongitude() - Method in interface com.marklogic.client.admin.config.support.GeospatialSpec
-
- getLongitude() - Method in class com.marklogic.client.query.StructuredQueryBuilder.Point
-
Deprecated.
- getLt() - Method in class com.marklogic.client.admin.config.QueryOptions.QueryRange.Bucket
-
Deprecated.
Returns the high end of the bucket's range.
- getLt() - Method in class com.marklogic.client.admin.config.QueryOptions.QueryRange.ComputedBucket
-
Deprecated.
Returns the high end of the bucket's range.
- getLtAnchor() - Method in class com.marklogic.client.admin.config.QueryOptions.QueryRange.ComputedBucket
-
Deprecated.
Returns a value for anchoring the "less than" value
for this computed bucket.
- getMapper() - Method in class com.marklogic.client.extra.jackson.JacksonHandle
-
Returns the mapper used to construct node objects from JSON.
- getMarshaller() - Method in class com.marklogic.client.io.JAXBHandle
-
Returns the marshaller that converts a tree data structure
from Java objects to XML, reusing any existing marshaller.
- getMarshaller(boolean) - Method in class com.marklogic.client.io.JAXBHandle
-
Returns the marshaller that converts a tree data structure
from Java objects to XML.
- getMatchLocations() - Method in interface com.marklogic.client.query.MatchDocumentSummary
-
Returns an array of match locations.
- getMatchResults() - Method in class com.marklogic.client.io.SearchHandle
-
Returns an array of summaries for the matched documents.
- getMatchResults() - Method in interface com.marklogic.client.query.SearchResults
-
Returns the match results.
- getMaxMatches() - Method in class com.marklogic.client.admin.config.QueryOptions.QueryTransformResults
-
Deprecated.
- getMaxSnippetChars() - Method in class com.marklogic.client.admin.config.QueryOptions.QueryTransformResults
-
Deprecated.
- getMessage() - Method in class com.marklogic.client.io.SearchHandle.Report
-
Returns the text of the message.
- getMessage() - Method in class com.marklogic.client.io.SearchHandle.Warning
-
Returns the text of the warning message.
- getMessage() - Method in exception com.marklogic.client.MarkLogicServerException
-
- getMetadata() - Method in class com.marklogic.client.alerting.RuleDefinition
-
Gets the metadata object associated with this rule
- getMetadata() - Method in class com.marklogic.client.example.extension.BatchManager.ReadOutput
-
- getMetadata(R) - Method in class com.marklogic.client.example.extension.BatchManager.ReadOutput
-
- getMetadata() - Method in interface com.marklogic.client.query.MatchDocumentSummary
-
Returns the metadata associated with this document.
- getMetadata(T) - Method in interface com.marklogic.client.query.MatchDocumentSummary
-
Returns the metadata extracted from the result document.
- getMetadataAs(Class<T>) - Method in interface com.marklogic.client.query.MatchDocumentSummary
-
Reads the metadata extracted from the matched result document
in the representation specified by the IO class.
- getMetadataCategories() - Method in interface com.marklogic.client.document.DocumentManager
-
Returns the categories of metadata to read, write, or patch.
- getMetadataExtraction() - Method in interface com.marklogic.client.document.BinaryDocumentManager
-
Returns the metadata extraction policy.
- getMetadataResolutionTime() - Method in interface com.marklogic.client.query.SearchMetrics
-
Returns the metadata resolution time in milliseconds.
- getMethod() - Method in class com.marklogic.client.admin.ResourceExtensionsManager.MethodParameters
-
Returns the method for the parameters.
- getMetrics() - Method in class com.marklogic.client.io.SearchHandle
-
Returns the metrics associated with this search.
- getMetrics() - Method in class com.marklogic.client.io.TuplesHandle
-
- getMetrics() - Method in class com.marklogic.client.io.ValuesHandle
-
- getMetrics() - Method in interface com.marklogic.client.query.SearchResults
-
Returns the search metrics.
- getMetrics() - Method in interface com.marklogic.client.query.TuplesResults
-
Returns performance metrics about the query.
- getMetrics() - Method in interface com.marklogic.client.query.ValuesResults
-
Returns performance metrics about the query.
- getMimetype() - Method in interface com.marklogic.client.document.ContentDescriptor
-
Returns the mimetype of the content.
- getMimetype() - Method in interface com.marklogic.client.extensions.ResourceServices.ServiceResult
-
Returns the mimetype of the content.
- getMimetype() - Method in class com.marklogic.client.io.BaseHandle
-
- getMimeType() - Method in interface com.marklogic.client.query.MatchDocumentSummary
-
Returns the mime type associated with this document.
- getModulesDatabase() - Method in class com.marklogic.client.example.util.Bootstrapper.RESTServer
-
- getN() - Method in class com.marklogic.client.admin.config.QueryOptions.Heatmap
-
Deprecated.
Returns the north latitude.
- getName() - Method in class com.marklogic.client.admin.config.QueryOptions.Field
-
Deprecated.
Returns the name of the field.
- getName() - Method in class com.marklogic.client.admin.config.QueryOptions.JsonKey
-
Deprecated.
Returns the key.
- getName() - Method in class com.marklogic.client.admin.config.QueryOptions.MarkLogicQName
-
Deprecated.
- getName() - Method in class com.marklogic.client.admin.config.QueryOptions.QueryConstraint
-
Deprecated.
Returns the name of the constraint.
- getName() - Method in class com.marklogic.client.admin.config.QueryOptions.QueryElementQuery
-
Deprecated.
Returns the local name of the element.
- getName() - Method in class com.marklogic.client.admin.config.QueryOptions.QueryOperator
-
Deprecated.
- getName() - Method in class com.marklogic.client.admin.config.QueryOptions.QueryRange.Bucket
-
Deprecated.
Returns a unique name to reference this bucket.
- getName() - Method in class com.marklogic.client.admin.config.QueryOptions.QueryRange.ComputedBucket
-
Deprecated.
Returns the unique name to reference this bucket.
- getName() - Method in class com.marklogic.client.admin.config.QueryOptions.QueryState
-
Deprecated.
- getName() - Method in class com.marklogic.client.admin.config.QueryOptions.QueryTuples
-
Deprecated.
- getName() - Method in class com.marklogic.client.admin.config.QueryOptions.QueryValues
-
Deprecated.
- getName() - Method in class com.marklogic.client.alerting.RuleDefinition
-
Gets the name of the rule.
- getName() - Method in class com.marklogic.client.DatabaseClientFactory.SSLHostnameVerifier.Builtin
-
Returns the name of the built-in.
- getName() - Method in class com.marklogic.client.document.ServerTransform
-
Gets the name of the invoked transform.
- getName() - Method in class com.marklogic.client.example.cookbook.JAXBDocument.Product
-
- getName() - Method in class com.marklogic.client.extensions.ResourceManager
-
Returns the name of the resource.
- getName() - Method in class com.marklogic.client.io.SearchHandle.Report
-
Returns the name of the message.
- getName() - Method in class com.marklogic.client.io.TuplesHandle
-
- getName() - Method in class com.marklogic.client.io.ValuesHandle
-
- getName() - Method in class com.marklogic.client.query.AggregateResult
-
Returns the name of this aggregate.
- getName() - Method in interface com.marklogic.client.query.FacetResult
-
Returns the facet name.
- getName() - Method in interface com.marklogic.client.query.FacetValue
-
Returns the name of the facet value.
- getName() - Method in interface com.marklogic.client.query.TuplesResults
-
Returns the name of the tuples.
- getName() - Method in interface com.marklogic.client.query.ValuesDefinition
-
Returns the name of the values constraint.
- getName() - Method in interface com.marklogic.client.query.ValuesResults
-
Returns the name of the values.
- getNamespaceContext() - Method in interface com.marklogic.client.util.NameMap
-
Returns the namespace context (if any) that declares the
namespace bindings used to convert prefixed string names
into QNames.
- getNamespaces() - Method in interface com.marklogic.client.document.DocumentMetadataPatchBuilder
-
Returns the namespaces available for the paths
of a patch against XML documents.
- getNamespaces() - Method in class com.marklogic.client.query.StructuredQueryBuilder
-
Gets the namespace bindings used for the query.
- getNamespaceURI() - Method in class com.marklogic.client.admin.config.QueryOptions.ExpressionNamespaceBinding
-
Deprecated.
- getNamespaceURI(String) - Method in class com.marklogic.client.util.EditableNamespaceContext
-
Returns the URI for a namespace binding.
- getNs() - Method in class com.marklogic.client.admin.config.QueryOptions.MarkLogicQName
-
Deprecated.
- getNs() - Method in class com.marklogic.client.admin.config.QueryOptions.QueryElementQuery
-
Deprecated.
Returns the namespace URI for the element.
- getNs() - Method in class com.marklogic.client.admin.config.QueryOptions.QueryTransformResults
-
Deprecated.
- getNs() - Method in class com.marklogic.client.admin.config.QueryOptions.XQueryExtension
-
Deprecated.
- getOperationType() - Method in class com.marklogic.client.example.extension.BatchManager.DeleteOutput
-
- getOperationType() - Method in class com.marklogic.client.example.extension.BatchManager.OutputItem
-
- getOperationType() - Method in class com.marklogic.client.example.extension.BatchManager.ReadOutput
-
- getOperationType() - Method in class com.marklogic.client.example.extension.BatchManager.WriteOutput
-
- getOperator(String) - Method in class com.marklogic.client.io.QueryOptionsHandle
-
Deprecated.
Returns the named query operator.
- getOperators() - Method in class com.marklogic.client.io.QueryOptionsHandle
-
Deprecated.
Returns a List of the operators specified in the query options.
- getOptions() - Method in class com.marklogic.client.admin.config.QueryOptions.QueryGrammar.QueryJoiner
-
Deprecated.
- getOptions() - Method in class com.marklogic.client.admin.config.QueryOptions.QueryGrammar.QueryStarter
-
Deprecated.
- getOptions() - Method in class com.marklogic.client.io.QueryOptionsHandle
-
Deprecated.
Returns the underlying QueryOptions representation of the query options.
- getOptionsMap() - Method in class com.marklogic.client.query.QueryOptionsListBuilder.OptionsList
-
- getOptionsName() - Method in class com.marklogic.client.io.ValuesListHandle
-
Returns the name of the query options used for this query.
- getOptionsName() - Method in interface com.marklogic.client.query.QueryDefinition
-
Returns the name of the query options used for this query.
- getOptionsName() - Method in interface com.marklogic.client.query.SuggestDefinition
-
Returns the name of the query options used for this query.
- getOptionsName() - Method in interface com.marklogic.client.query.ValuesDefinition
-
Returns the name of the options node used for this values query.
- getOptionsName() - Method in interface com.marklogic.client.query.ValuesListDefinition
-
Returns the name of the options node associated with this query.
- getOutputFormat() - Method in class com.marklogic.client.extra.dom4j.DOM4JHandle
-
Returns the dom4j output format for serializing XML content.
- getOutputter() - Method in class com.marklogic.client.extra.jdom.JDOMHandle
-
Returns the JDOM serializer for XML content.
- getPageLength() - Method in class com.marklogic.client.admin.config.QueryOptions
-
Deprecated.
- getPageLength() - Method in class com.marklogic.client.admin.config.QueryOptions.QueryState
-
Deprecated.
- getPageLength() - Method in class com.marklogic.client.admin.config.support.QueryOptionsConfiguration
-
- getPageLength() - Method in class com.marklogic.client.example.extension.SearchCollector
-
- getPageLength() - Method in class com.marklogic.client.io.QueryOptionsHandle
-
Deprecated.
Returns the page length specified in the query options.
- getPageLength() - Method in class com.marklogic.client.io.SearchHandle
-
Returns the page length for this search.
- getPageLength() - Method in interface com.marklogic.client.query.QueryManager
-
Returns the maximum number of documents that can appear in any page of query results.
- getPageLength() - Method in interface com.marklogic.client.query.SearchResults
-
Returns the maximum number of results in the search response page.
- getParent() - Method in interface com.marklogic.client.admin.config.support.GeospatialSpec
-
- getParse() - Method in class com.marklogic.client.admin.config.QueryOptions.QueryCustom
-
Deprecated.
Returns the XQuery function called to implement the custom constraint.
- getParser() - Method in class com.marklogic.client.example.handle.HTMLCleanerHandle
-
- getParser() - Method in class com.marklogic.client.extra.gson.GSONHandle
-
Returns the parser used to construct element objects from JSON.
- getPassword() - Method in class com.marklogic.client.DatabaseClientFactory.Bean
-
Returns the password authentication for clients created with a
DatabaseClientFactory.Bean object.
- getPassword() - Method in class com.marklogic.client.example.util.Bootstrapper.ConfigServer
-
- getPath() - Method in class com.marklogic.client.admin.config.QueryOptions.BaseConstraintItem
-
Deprecated.
Gets the string representing a path index data source.
- getPath() - Method in class com.marklogic.client.admin.config.QueryOptions.PathIndex
-
Deprecated.
- getPath() - Method in class com.marklogic.client.admin.config.QueryOptions.QuerySearchableExpression
-
Deprecated.
Gets the String xPath expression
- getPath() - Method in class com.marklogic.client.admin.ExtensionLibraryDescriptor
-
gets the path of this module/asset
- getPath() - Method in interface com.marklogic.client.query.MatchDocumentSummary
-
Returns the path of the match.
- getPath() - Method in interface com.marklogic.client.query.MatchLocation
-
Returns the path to the matching location in the document.
- getPathIndex() - Method in class com.marklogic.client.admin.config.QueryOptions.BaseConstraintItem
-
Deprecated.
Gets the path index object that backs this data source.
- getPathIndex() - Method in interface com.marklogic.client.admin.config.support.IndexSpec
-
- getPathIndex() - Method in class com.marklogic.client.admin.config.support.IndexSpecImpl
-
- getPathNamespaceBindings() - Method in class com.marklogic.client.admin.config.QueryOptions.BaseConstraintItem
-
Deprecated.
Gets the namespace context in scope for a path index configuration.
- getPerMatchTokens() - Method in class com.marklogic.client.admin.config.QueryOptions.QueryTransformResults
-
Deprecated.
- getPermissions() - Method in class com.marklogic.client.admin.ExtensionLibraryDescriptor
-
gets the list of permissions assigned to this module, beyond the default permissions.
- getPermissions() - Method in class com.marklogic.client.io.DocumentMetadataHandle
-
Returns a container for the permissions on the document
as read from the server or modified locally.
- getPlan() - Method in class com.marklogic.client.io.SearchHandle
-
Returns the query plan associated with this search.
- getPlan(T) - Method in class com.marklogic.client.io.SearchHandle
-
- getPlan() - Method in interface com.marklogic.client.query.SearchResults
-
Returns the query plan.
- getPlan(T) - Method in interface com.marklogic.client.query.SearchResults
-
Returns the plan for the search (if requested).
- getPort() - Method in class com.marklogic.client.DatabaseClientFactory.Bean
-
Returns the port for clients created with a
DatabaseClientFactory.Bean object.
- getPort() - Method in class com.marklogic.client.example.util.Bootstrapper.ConfigServer
-
- getPort() - Method in class com.marklogic.client.example.util.Bootstrapper.RESTServer
-
- getPreferredElements() - Method in class com.marklogic.client.admin.config.QueryOptions.QueryTransformResults
-
Deprecated.
- getPrefix() - Method in class com.marklogic.client.admin.config.QueryOptions.ExpressionNamespaceBinding
-
Deprecated.
- getPrefix() - Method in class com.marklogic.client.admin.config.QueryOptions.QueryCollection
-
Deprecated.
The prefix to be removed from collectionOption URIs in
generating facet labels.
- getPrefix(String) - Method in class com.marklogic.client.util.EditableNamespaceContext
-
Returns the prefix for a namespace binding.
- getPrefixes(String) - Method in class com.marklogic.client.util.EditableNamespaceContext
-
Returns all prefixes with a namespace binding.
- getPrintStream() - Method in interface com.marklogic.client.util.RequestLogger
-
Returns the underlying PrintStream used for logging.
- getProperties() - Method in class com.marklogic.client.io.DocumentMetadataHandle
-
Returns a container for the properties of the document
as read from the server or modified locally.
- getProvider() - Method in class com.marklogic.client.admin.ExtensionMetadata
-
Returns the name of the organization providing the extension.
- getQNames() - Method in class com.marklogic.client.admin.config.QueryOptions.QueryExtractMetadata
-
Deprecated.
- getQuality() - Method in class com.marklogic.client.io.DocumentMetadataHandle
-
Returns the quality of the document.
- getQualityWeight() - Method in class com.marklogic.client.admin.config.QueryOptions
-
Deprecated.
- getQualityWeight() - Method in class com.marklogic.client.admin.config.QueryOptions.QueryState
-
Deprecated.
- getQualityWeight() - Method in class com.marklogic.client.admin.config.support.QueryOptionsConfiguration
-
- getQualityWeight() - Method in class com.marklogic.client.io.QueryOptionsHandle
-
Deprecated.
Returns the quality weight specified in the query options.
- getQuery(T) - Method in class com.marklogic.client.io.SearchHandle
-
- getQuery(T) - Method in interface com.marklogic.client.query.SearchResults
-
Returns the cts:query used in the search (if requested).
- getQueryConstraints() - Method in class com.marklogic.client.admin.config.QueryOptions
-
Deprecated.
- getQueryCriteria() - Method in class com.marklogic.client.io.SearchHandle
-
Returns the query definition used for the search represented by this handle.
- getQueryCriteria() - Method in class com.marklogic.client.io.TuplesHandle
-
Returns the tuples query definition used to identify this set of tuples.
- getQueryCriteria() - Method in class com.marklogic.client.io.ValuesHandle
-
- getQueryCriteria() - Method in interface com.marklogic.client.query.SearchResults
-
Returns the query definition associated with this query.
- getQueryCriteria() - Method in interface com.marklogic.client.query.TuplesResults
-
Returns the query used to locate these tuples.
- getQueryCriteria() - Method in interface com.marklogic.client.query.ValuesResults
-
Return the query definition for this set of results.
- getQueryDefinition() - Method in interface com.marklogic.client.query.ValuesDefinition
-
Returns the query definition associated with this values query.
- getQueryOperators() - Method in class com.marklogic.client.admin.config.QueryOptions
-
Deprecated.
- getQueryOptionValidation() - Method in interface com.marklogic.client.admin.ServerConfigurationManager
-
Returns whether the server validates query options before storing them.
- getQueryResolutionTime() - Method in interface com.marklogic.client.query.SearchMetrics
-
Returns the query resolution time in milliseconds.
- getQueryStrings() - Method in interface com.marklogic.client.query.SuggestDefinition
-
Returns the array of strings set for this SuggestDefinition.
- getQueryTuples() - Method in class com.marklogic.client.admin.config.QueryOptions
-
Deprecated.
- getQueryValidation() - Method in interface com.marklogic.client.admin.ServerConfigurationManager
-
Returns whether the server validates queries before running them.
- getQueryValues() - Method in class com.marklogic.client.admin.config.QueryOptions
-
Deprecated.
- getQuotation() - Method in class com.marklogic.client.admin.config.QueryOptions.QueryGrammar
-
Deprecated.
- getRange() - Method in class com.marklogic.client.admin.config.QueryOptions.QueryTuples
-
Deprecated.
- getRange() - Method in class com.marklogic.client.admin.config.QueryOptions.QueryValues
-
Deprecated.
- getReader() - Method in class com.marklogic.client.extra.dom4j.DOM4JHandle
-
Returns the dom4j reader for XML content.
- getReadTransform() - Method in interface com.marklogic.client.document.DocumentManager
-
Returns the transform for read requests that don't specify a transform.
- getRef() - Method in class com.marklogic.client.admin.config.QueryOptions.ConstraintValue
-
Deprecated.
- getRef() - Method in class com.marklogic.client.admin.config.QueryOptions.DefaultTermSource
-
Deprecated.
- getRef() - Method in class com.marklogic.client.admin.config.QueryOptions.QuerySuggestionSource
-
Deprecated.
- getRef() - Method in class com.marklogic.client.admin.config.QueryOptions.QueryTerm
-
Deprecated.
- getRelevanceInfo() - Method in interface com.marklogic.client.query.MatchDocumentSummary
-
Get relevance info for a particular result.
- getRelevanceInfo(T) - Method in interface com.marklogic.client.query.MatchDocumentSummary
-
Returns the relevance information for the result.
- getReports() - Method in class com.marklogic.client.io.SearchHandle
-
Returns an array of any reports associated with this search.
- getReports() - Method in interface com.marklogic.client.query.SearchResults
-
Returns the array of reports returned by this search.
- getRequestLogger() - Method in interface com.marklogic.client.extensions.ResourceServices
-
Returns the logger for debugging client requests.
- getResolver() - Method in class com.marklogic.client.io.DOMHandle
-
Returns the resolver for resolving references while parsing the document.
- getResolver() - Method in class com.marklogic.client.io.InputSourceHandle
-
Returns the resolver for resolving references while parsing
the input source.
- getResolver() - Method in class com.marklogic.client.io.XMLEventReaderHandle
-
Returns the resolver for resolving references while parsing
the event reader source.
- getResolver() - Method in class com.marklogic.client.io.XMLStreamReaderHandle
-
Returns the resolver for resolving references while parsing
the event reader source.
- getResourceName() - Method in interface com.marklogic.client.extensions.ResourceServices
-
Returns the name of the resource.
- getResponseTransform() - Method in interface com.marklogic.client.query.QueryDefinition
-
Returns the transform that modifies responses to this query
on the server.
- getReturnAggregates() - Method in class com.marklogic.client.admin.config.QueryOptions
-
Deprecated.
- getReturnAggregates() - Method in class com.marklogic.client.admin.config.support.QueryOptionsConfiguration
-
- getReturnAggregates() - Method in class com.marklogic.client.io.QueryOptionsHandle
-
Deprecated.
Returns the return aggregates option from the query options.
- getReturnConstraints() - Method in class com.marklogic.client.admin.config.QueryOptions
-
Deprecated.
- getReturnConstraints() - Method in class com.marklogic.client.admin.config.support.QueryOptionsConfiguration
-
- getReturnConstraints() - Method in class com.marklogic.client.io.QueryOptionsHandle
-
Deprecated.
Returns the return constraints option from the query options.
- getReturnFacets() - Method in class com.marklogic.client.admin.config.QueryOptions
-
Deprecated.
- getReturnFacets() - Method in class com.marklogic.client.admin.config.support.QueryOptionsConfiguration
-
- getReturnFacets() - Method in class com.marklogic.client.io.QueryOptionsHandle
-
Deprecated.
Returns the return facets option from the query options.
- getReturnFrequencies() - Method in class com.marklogic.client.admin.config.QueryOptions
-
Deprecated.
- getReturnFrequencies() - Method in class com.marklogic.client.admin.config.support.QueryOptionsConfiguration
-
- getReturnFrequencies() - Method in class com.marklogic.client.io.QueryOptionsHandle
-
Deprecated.
Returns the return frequencies option from the query options.
- getReturnMetrics() - Method in class com.marklogic.client.admin.config.QueryOptions
-
Deprecated.
- getReturnMetrics() - Method in class com.marklogic.client.admin.config.support.QueryOptionsConfiguration
-
- getReturnMetrics() - Method in class com.marklogic.client.io.QueryOptionsHandle
-
Deprecated.
Returns the return metrics option from the query options.
- getReturnPlan() - Method in class com.marklogic.client.admin.config.QueryOptions
-
Deprecated.
- getReturnPlan() - Method in class com.marklogic.client.admin.config.support.QueryOptionsConfiguration
-
- getReturnPlan() - Method in class com.marklogic.client.io.QueryOptionsHandle
-
Deprecated.
Returns the return query plan option from the query options.
- getReturnQtext() - Method in class com.marklogic.client.admin.config.QueryOptions
-
Deprecated.
- getReturnQtext() - Method in class com.marklogic.client.admin.config.support.QueryOptionsConfiguration
-
- getReturnQtext() - Method in class com.marklogic.client.io.QueryOptionsHandle
-
Deprecated.
Returns the return query text option from the query options.
- getReturnQuery() - Method in class com.marklogic.client.admin.config.QueryOptions
-
Deprecated.
- getReturnQuery() - Method in class com.marklogic.client.admin.config.support.QueryOptionsConfiguration
-
- getReturnQuery() - Method in class com.marklogic.client.io.QueryOptionsHandle
-
Deprecated.
Returns the return query option from the query options.
- getReturnResults() - Method in class com.marklogic.client.admin.config.QueryOptions
-
Deprecated.
- getReturnResults() - Method in class com.marklogic.client.admin.config.support.QueryOptionsConfiguration
-
- getReturnResults() - Method in class com.marklogic.client.io.QueryOptionsHandle
-
Deprecated.
Returns the return results option from the query options.
- getReturnSimilar() - Method in class com.marklogic.client.admin.config.QueryOptions
-
Deprecated.
- getReturnSimilar() - Method in class com.marklogic.client.admin.config.support.QueryOptionsConfiguration
-
- getReturnSimilar() - Method in class com.marklogic.client.io.QueryOptionsHandle
-
Deprecated.
Returns the return similar option from the query options.
- getReturnValues() - Method in class com.marklogic.client.admin.config.QueryOptions
-
Deprecated.
- getReturnValues() - Method in class com.marklogic.client.admin.config.support.QueryOptionsConfiguration
-
- getReturnValues() - Method in class com.marklogic.client.io.QueryOptionsHandle
-
Deprecated.
Returns the return values option from the query options.
- getRoleName() - Method in class com.marklogic.client.admin.ExtensionLibraryDescriptor.Permission
-
gets the role name for this permission.
- getRulesProvider() - Method in class com.marklogic.client.example.handle.HTMLCleanerHandle
-
- getS() - Method in class com.marklogic.client.admin.config.QueryOptions.Heatmap
-
Deprecated.
Returns the south latitude.
- getScore() - Method in class com.marklogic.client.admin.config.QueryOptions.QuerySortOrder
-
Deprecated.
- getScore() - Method in interface com.marklogic.client.query.MatchDocumentSummary
-
Returns the score associated with the document.
- getSearchableExpression() - Method in class com.marklogic.client.admin.config.QueryOptions
-
Deprecated.
- getSearchableExpression() - Method in class com.marklogic.client.admin.config.QueryOptions.QueryState
-
Deprecated.
- getSearchableExpression() - Method in class com.marklogic.client.io.QueryOptionsHandle
-
Deprecated.
Returns the searchable expression in the query options.
- getSearchableExpressionNamespaceBindings() - Method in class com.marklogic.client.admin.config.QueryOptions.QueryState
-
Deprecated.
- getSearchableExpressionNamespaceContext() - Method in class com.marklogic.client.admin.config.QueryOptions
-
Deprecated.
- getSearchableExpressionNamespaceContext() - Method in class com.marklogic.client.io.QueryOptionsHandle
-
Deprecated.
Returns the namespace context associated with the searchable expression in the query options.
- getSearchOptions() - Method in class com.marklogic.client.admin.config.QueryOptions
-
Deprecated.
- getSearchOptions() - Method in class com.marklogic.client.admin.config.QueryOptions.QueryState
-
Deprecated.
- getSearchOptions() - Method in class com.marklogic.client.admin.config.support.QueryOptionsConfiguration
-
- getSearchOptions() - Method in class com.marklogic.client.io.QueryOptionsHandle
-
Deprecated.
Returns a List of the search options in the query options.
- getSearchResult(R) - Method in class com.marklogic.client.example.extension.SearchCollector.CollectorResults
-
- getSerializer() - Method in class com.marklogic.client.example.handle.HTMLCleanerHandle
-
- getServer() - Method in class com.marklogic.client.example.util.Bootstrapper.RESTServer
-
- getServerRequestLogging() - Method in interface com.marklogic.client.admin.ServerConfigurationManager
-
Returns whether the server logs requests to the error log on the server.
- getSimilarDocumentUris() - Method in interface com.marklogic.client.query.MatchDocumentSummary
-
Returns the uris for documents similar to the result (if requested).
- getSnippetIterator(T) - Method in interface com.marklogic.client.query.MatchDocumentSummary
-
Returns an iterator over the snippets matched for the result.
- getSnippetResolutionTime() - Method in interface com.marklogic.client.query.SearchMetrics
-
Returns the snippet resolution time in milliseconds.
- getSnippets() - Method in interface com.marklogic.client.query.MatchDocumentSummary
-
Returns an array of snippets.
- getSnippets() - Method in interface com.marklogic.client.query.MatchLocation
-
Returns the array of elements in the snippet.
- getSnippetTransformType() - Method in class com.marklogic.client.io.SearchHandle
-
Identifies whether results have default,
raw document, customer, or no snippets.
- getSnippetTransformType() - Method in interface com.marklogic.client.query.SearchResults
-
The type of transform used to produce the result snippets.
- getSortOrders() - Method in class com.marklogic.client.admin.config.QueryOptions
-
Deprecated.
- getSortOrders() - Method in class com.marklogic.client.admin.config.QueryOptions.QueryState
-
Deprecated.
- getSortOrders() - Method in class com.marklogic.client.io.QueryOptionsHandle
-
Deprecated.
Returns a List of the sort orders specified in the query options.
- getSource() - Method in class com.marklogic.client.admin.config.QueryOptions.DefaultTermSource
-
Deprecated.
- getSource() - Method in class com.marklogic.client.admin.config.QueryOptions.QueryConstraint
-
Deprecated.
Returns the constrained index.
- getSource() - Method in class com.marklogic.client.admin.config.QueryOptions.QueryTerm
-
Deprecated.
get the constraint definition that backs default term queries.
- getStart() - Method in class com.marklogic.client.io.SearchHandle
-
Returns the start page for this search.
- getStart() - Method in interface com.marklogic.client.query.SearchResults
-
Returns the offset of the first result in the search reponse page.
- getStarters() - Method in class com.marklogic.client.admin.config.QueryOptions.QueryGrammar
-
Deprecated.
- getStarterText() - Method in class com.marklogic.client.admin.config.QueryOptions.QueryGrammar.QueryStarter
-
Deprecated.
- getStartFacet() - Method in class com.marklogic.client.admin.config.QueryOptions.QueryCustom
-
Deprecated.
Returns the XQuery function called to start the facet.
- getState(String) - Method in class com.marklogic.client.admin.config.QueryOptions.QueryOperator
-
Deprecated.
- getStates() - Method in class com.marklogic.client.admin.config.QueryOptions.QueryOperator
-
Deprecated.
- getStrength() - Method in class com.marklogic.client.admin.config.QueryOptions.QueryGrammar.QueryJoiner
-
Deprecated.
- getStrength() - Method in class com.marklogic.client.admin.config.QueryOptions.QueryGrammar.QueryStarter
-
Deprecated.
- getStringCriteria() - Method in interface com.marklogic.client.query.SuggestDefinition
-
Returns the text of the suggestion call.
- getStringQueries() - Method in class com.marklogic.client.io.SearchHandle
-
Returns the list of string queries, if specified
by the query options.
- getStringQueries() - Method in interface com.marklogic.client.query.SearchResults
-
Returns the string query input (if provided and requested).
- getSuccess() - Method in class com.marklogic.client.example.extension.BatchManager.BatchResponse
-
- getSuccess() - Method in class com.marklogic.client.example.extension.BatchManager.OutputItem
-
- getSuggestionOptions() - Method in class com.marklogic.client.admin.config.QueryOptions.QuerySuggestionSource
-
Deprecated.
- getSuggestionSources() - Method in class com.marklogic.client.admin.config.QueryOptions
-
Deprecated.
- getSuggestionSources() - Method in class com.marklogic.client.io.QueryOptionsHandle
-
Deprecated.
Returns a List of the suggestion sources in the query options.
- getTerm() - Method in class com.marklogic.client.admin.config.QueryOptions
-
Deprecated.
- getTerm() - Method in class com.marklogic.client.io.QueryOptionsHandle
-
Deprecated.
Returns the term associated specified in the query options.
- getTermFunction() - Method in class com.marklogic.client.admin.config.QueryOptions.QueryTerm
-
Deprecated.
- getTermOptions() - Method in class com.marklogic.client.admin.config.QueryOptions.BaseConstraintItem
-
Deprecated.
Gets the term options for this constraint source.
- getTermOptions() - Method in class com.marklogic.client.admin.config.QueryOptions.QueryTerm
-
Deprecated.
- getTermOptions() - Method in interface com.marklogic.client.admin.config.support.TermOptions
-
- getTermOptions() - Method in interface com.marklogic.client.admin.config.support.TermSource
-
- getText() - Method in interface com.marklogic.client.query.MatchSnippet
-
Returns the string value of the run of text in this part of the snippet.
- getTitle() - Method in class com.marklogic.client.admin.ExtensionMetadata
-
Returns the title of the extension.
- getTokenize() - Method in class com.marklogic.client.admin.config.QueryOptions.QueryGrammar.QueryJoiner
-
Deprecated.
- getTokenize() - Method in class com.marklogic.client.admin.config.QueryOptions.QueryGrammar.QueryStarter
-
Deprecated.
- getTotalResults() - Method in class com.marklogic.client.io.SearchHandle
-
Returns the total number of results in this search.
- getTotalResults() - Method in interface com.marklogic.client.query.SearchResults
-
Returns an estimate of the total number of results, which is accurate for unfiltered
queries.
- getTotalTime() - Method in interface com.marklogic.client.query.SearchMetrics
-
Returns the total time taken by the query in milliseconds.
- getTotalTime() - Method in interface com.marklogic.client.query.ValuesMetrics
-
Returns the total time taken by the query in milliseconds.
- getTransactionId() - Method in interface com.marklogic.client.Transaction
-
Returns the identifier for the transaction.
- getTransformer() - Method in class com.marklogic.client.io.SourceHandle
-
Returns a transformer for modifying the content.
- getTransformResults() - Method in class com.marklogic.client.admin.config.QueryOptions
-
Deprecated.
- getTransformResults() - Method in class com.marklogic.client.io.QueryOptionsHandle
-
Deprecated.
Returns the transform results setting specified in the query options.
- getTransformResultsOption() - Method in class com.marklogic.client.admin.config.QueryOptions.QueryState
-
Deprecated.
- getTuples() - Method in class com.marklogic.client.io.QueryOptionsHandle
-
Deprecated.
Returns a List of the tuples accessors in the query options.
- getTuples(String) - Method in class com.marklogic.client.io.QueryOptionsHandle
-
Deprecated.
Returns the named tuples accessor.
- getTuples() - Method in class com.marklogic.client.io.TuplesHandle
-
Returns an array of the Tuples returned by this query.
- getTuples() - Method in interface com.marklogic.client.query.TuplesResults
-
Returns an array of Tuples.
- getType() - Method in class com.marklogic.client.admin.config.QueryOptions.FacetableConstraintConfiguration
-
Deprecated.
Returns the datatype of the facetable constraint.
- getType() - Method in class com.marklogic.client.admin.config.QueryOptions.QuerySortOrder
-
Deprecated.
- getType() - Method in class com.marklogic.client.admin.config.support.RangeIndexType
-
- getType() - Method in interface com.marklogic.client.admin.config.support.RangeSpec
-
- getType() - Method in class com.marklogic.client.io.SearchHandle.Report
-
Returns the type of the message.
- getType() - Method in class com.marklogic.client.io.ValuesHandle
-
- getType() - Method in class com.marklogic.client.query.TypedDistinctValue
-
Returns the type of the value.
- getType() - Method in interface com.marklogic.client.query.ValuesResults
-
Returns the type of the values.
- getUdf() - Method in class com.marklogic.client.admin.config.QueryOptions.Aggregate
-
Deprecated.
Gets a user-defined function plugin
- getUnmarshaller() - Method in class com.marklogic.client.io.JAXBHandle
-
Returns the unmarshaller that converts a tree data structure
from XML to Java objects, reusing any existing unmarshaller.
- getUnmarshaller(boolean) - Method in class com.marklogic.client.io.JAXBHandle
-
Returns the unmarshaller that converts a tree data structure
from XML to Java objects.
- getUpdatePolicy() - Method in interface com.marklogic.client.admin.ServerConfigurationManager
-
Returns the policy for updating or deleting documents in the database.
- getUri() - Method in class com.marklogic.client.admin.config.QueryOptions.QueryTuples
-
Deprecated.
- getUri() - Method in class com.marklogic.client.admin.config.QueryOptions.QueryValues
-
Deprecated.
- getUri() - Method in interface com.marklogic.client.document.DocumentDescriptor
-
Returns the URI identifier for the database document.
- getUri() - Method in class com.marklogic.client.example.extension.BatchManager.OutputItem
-
- getUri() - Method in interface com.marklogic.client.query.MatchDocumentSummary
-
Returns the URI of the document.
- getUsage() - Static method in class com.marklogic.client.example.util.Bootstrapper
-
- getUser() - Method in class com.marklogic.client.DatabaseClientFactory.Bean
-
Returns the user authentication for clients created with a
DatabaseClientFactory.Bean object.
- getUser() - Method in class com.marklogic.client.example.util.Bootstrapper.ConfigServer
-
- getValue() - Method in class com.marklogic.client.admin.config.QueryOptions.QueryAdditionalQuery
-
Deprecated.
Get the element wrapped in this object, as a dom Element.
- getValue() - Method in class com.marklogic.client.query.AggregateResult
-
Returns the value of this aggregate as a string.
- getValues() - Method in class com.marklogic.client.io.QueryOptionsHandle
-
Deprecated.
Returns a List of the values accessors in the query options.
- getValues(String) - Method in class com.marklogic.client.io.QueryOptionsHandle
-
Deprecated.
Returns the named values accessor.
- getValues() - Method in class com.marklogic.client.io.ValuesHandle
-
- getValues() - Method in class com.marklogic.client.query.Tuple
-
Returns an array of all the values in this tuple.
- getValues() - Method in interface com.marklogic.client.query.ValuesResults
-
Returns an array of the values.
- getValuesMap() - Method in class com.marklogic.client.io.QueryOptionsListHandle
-
Returns a HashMap of the named query options from the server.
- getValuesMap() - Method in class com.marklogic.client.io.ValuesListHandle
-
Returns a HashMap of the named lexicon configurations.
- getValuesMap() - Method in interface com.marklogic.client.query.QueryOptionsListResults
-
Returns a HashMap of the named query options from the server.
- getValuesMap() - Method in interface com.marklogic.client.query.ValuesListResults
-
Returns the map of value results.
- getValuesOptions() - Method in class com.marklogic.client.admin.config.QueryOptions.QueryTuples
-
Deprecated.
- getValuesOptions() - Method in class com.marklogic.client.admin.config.QueryOptions.QueryValues
-
Deprecated.
- getValuesResolutionTime() - Method in interface com.marklogic.client.query.ValuesMetrics
-
Returns the query resolution time in milliseconds.
- getVerifier() - Method in class com.marklogic.client.DatabaseClientFactory.Bean
-
Returns the host verifier for clients created with a
DatabaseClientFactory.Bean object.
- getVersion() - Method in class com.marklogic.client.admin.ExtensionMetadata
-
Returns the version identifier for the extension implementation.
- getVersion() - Method in interface com.marklogic.client.document.DocumentDescriptor
-
Returns the version for the database document.
- getView() - Method in interface com.marklogic.client.query.QueryManager
-
Returns the type of view results produced by queries.
- getView() - Method in interface com.marklogic.client.query.ValuesDefinition
-
Returns the view for this values query.
- getW() - Method in class com.marklogic.client.admin.config.QueryOptions.Heatmap
-
Deprecated.
Returns the west longitude.
- getWarnings() - Method in class com.marklogic.client.io.SearchHandle
-
Returns an array of any warnings associated with this search.
- getWarnings() - Method in interface com.marklogic.client.query.SearchResults
-
Returns the array of warnings returned by this search.
- getWeight() - Method in class com.marklogic.client.admin.config.QueryOptions.BaseConstraintItem
-
Deprecated.
Gets the relative weight assigned to this constraint source.
- getWeight() - Method in class com.marklogic.client.admin.config.QueryOptions.QueryTerm
-
Deprecated.
- getWeight() - Method in interface com.marklogic.client.admin.config.support.TermOptions
-
- getWordLexicon() - Method in class com.marklogic.client.admin.config.QueryOptions.QuerySuggestionSource
-
Deprecated.
- getWriteTransform() - Method in interface com.marklogic.client.document.DocumentManager
-
Returns the transform for write requests that don't specify a transform.
- getXPathProcessor() - Method in class com.marklogic.client.io.DOMHandle
-
Get the processor used to evaluate XPath expressions.
- grammar(List<QueryOptions.QueryGrammar.QueryStarter>, List<QueryOptions.QueryGrammar.QueryJoiner>, String, Element) - Method in class com.marklogic.client.admin.config.QueryOptionsBuilder
-
Deprecated.
Builds the definition of a query grammar.
- GraphManager - Class in com.marklogic.client.example.extension
-
GraphManager is an extension that provides experimental graph CRUD functionality to the Java API.
- GraphManager(DatabaseClient) - Constructor for class com.marklogic.client.example.extension.GraphManager
-
- GraphSPARQLExample - Class in com.marklogic.client.example.extension
-
- GraphSPARQLExample() - Constructor for class com.marklogic.client.example.extension.GraphSPARQLExample
-
- GSONHandle - Class in com.marklogic.client.extra.gson
-
A GSONHandle represents JSON content as a GSON JsonElement for reading or
writing.
- GSONHandle() - Constructor for class com.marklogic.client.extra.gson.GSONHandle
-
Zero-argument constructor.
- GSONHandle(JsonElement) - Constructor for class com.marklogic.client.extra.gson.GSONHandle
-
Provides a handle on JSON content as a tree.
- GSONHandleExample - Class in com.marklogic.client.example.handle
-
GSONHandleExample illustrates writing and reading content as a JSON structure
using the GSON extra library.
- GSONHandleExample() - Constructor for class com.marklogic.client.example.handle.GSONHandleExample
-
- NAME - Static variable in class com.marklogic.client.example.cookbook.ResourceExtension.DictionaryManager
-
- NAME - Static variable in class com.marklogic.client.example.extension.BatchManager
-
- NAME - Static variable in class com.marklogic.client.example.extension.DocumentSplitter
-
- NAME - Static variable in class com.marklogic.client.example.extension.GraphManager
-
- NAME - Static variable in class com.marklogic.client.example.extension.SearchCollector
-
- NAME - Static variable in class com.marklogic.client.example.extension.SPARQLManager
-
- NameConverter - Class in com.marklogic.client.example.extension
-
NameConverter mangles and unmangles strings as local names
for XML elements.
- NameConverter() - Constructor for class com.marklogic.client.example.extension.NameConverter
-
- NameMap<V> - Interface in com.marklogic.client.util
-
A NameMap defines the interface for maps where the key is
a QName (a name qualified by a URI for global uniqueness or
for association with a domain).
- namespaces(QueryOptions.ExpressionNamespaceBinding...) - Method in class com.marklogic.client.admin.config.QueryOptionsBuilder
-
Deprecated.
- NamespacesManager - Interface in com.marklogic.client.admin
-
The NamespacesManager provides access and editing for the namespaces defined on the server.
- near(StructuredQueryDefinition...) - Method in class com.marklogic.client.query.StructuredQueryBuilder
-
Defines a NEAR query over the list of query definitions
with default parameters.
- near(int, double, StructuredQueryBuilder.Ordering, StructuredQueryDefinition...) - Method in class com.marklogic.client.query.StructuredQueryBuilder
-
Defines a NEAR query over the list of query definitions
with specified parameters.
- newBatchRequest() - Method in class com.marklogic.client.example.extension.BatchManager
-
- newBinaryDocumentManager() - Method in interface com.marklogic.client.DatabaseClient
-
Creates a document manager for documents with a binary format such as images.
- newClient() - Method in class com.marklogic.client.DatabaseClientFactory.Bean
-
Creates a client for bean applications based on the properties.
- newClient(String, int) - Static method in class com.marklogic.client.DatabaseClientFactory
-
Creates a client to access the database by means of a REST server
without any authentication.
- newClient(String, int, String, String, DatabaseClientFactory.Authentication) - Static method in class com.marklogic.client.DatabaseClientFactory
-
Creates a client to access the database by means of a REST server.
- newClient(String, int, String, String, DatabaseClientFactory.Authentication, SSLContext) - Static method in class com.marklogic.client.DatabaseClientFactory
-
Creates a client to access the database by means of a REST server.
- newClient(String, int, String, String, DatabaseClientFactory.Authentication, SSLContext, DatabaseClientFactory.SSLHostnameVerifier) - Static method in class com.marklogic.client.DatabaseClientFactory
-
Creates a client to access the database by means of a REST server.
- newDeleteDefinition() - Method in interface com.marklogic.client.query.QueryManager
-
Creates a query definition for deleting documents.
- newDescriptor(String) - Method in interface com.marklogic.client.document.DocumentManager
-
Creates a document descriptor for identifying the uri of a document,
its format and mimetype, and its version.
- newDocumentManager() - Method in interface com.marklogic.client.DatabaseClient
-
Creates a document manager for documents with unknown or heterogeneous formats.
- newDocumentUriTemplate(String) - Method in interface com.marklogic.client.document.DocumentManager
-
Creates a document uri template for assigning a uri to a document.
- newElementLocator(QName) - Method in interface com.marklogic.client.query.QueryManager
-
Creates a locator for a key-value query based on an element name,
which may have namespace.
- newElementLocator(QName, QName) - Method in interface com.marklogic.client.query.QueryManager
-
Creates a locator for a key-value query based on an element name
and attribute name, either or both of which may have a namespace.
- newExtensionLibrariesManager() - Method in interface com.marklogic.client.admin.ServerConfigurationManager
-
Creates a manager for writing and reading assets in the REST
server's modules database.
- newFactory() - Static method in class com.marklogic.client.extra.dom4j.DOM4JHandle
-
Creates a factory to create a DOM4JHandle instance for a dom4j document.
- newFactory() - Static method in class com.marklogic.client.extra.gson.GSONHandle
-
Creates a factory to create a GSONHandle instance for a JsonElement node.
- newFactory() - Static method in class com.marklogic.client.extra.jackson.JacksonHandle
-
Creates a factory to create a JacksonHandle instance for a JSON node.
- newFactory() - Static method in class com.marklogic.client.extra.jdom.JDOMHandle
-
Creates a factory to create a JDOMHandle instance for a JDOM document.
- newFactory() - Static method in class com.marklogic.client.extra.xom.XOMHandle
-
Creates a factory to create a XOMHandle instance for a XOM document.
- newFactory() - Static method in class com.marklogic.client.io.BytesHandle
-
Creates a factory to create a BytesHandle instance for a byte[] array.
- newFactory() - Static method in class com.marklogic.client.io.DOMHandle
-
Creates a factory to create a DOMHandle instance for a DOM document.
- newFactory() - Static method in class com.marklogic.client.io.FileHandle
-
Creates a factory to create a FileHandle for a file.
- newFactory() - Static method in class com.marklogic.client.io.InputSourceHandle
-
Creates a factory to create a InputSourceHandle instance for a SAX InputSource.
- newFactory() - Static method in class com.marklogic.client.io.InputStreamHandle
-
Creates a factory to create an InputStreamHandle instance for an input stream.
- newFactory(Class<?>...) - Static method in class com.marklogic.client.io.JAXBHandle
-
Creates a factory to create a JAXBHandle instance for POJO instances
of the specified classes.
- newFactory(JAXBContext, Class<?>...) - Static method in class com.marklogic.client.io.JAXBHandle
-
Creates a factory to create a JAXBHandle instance for POJO instances
of the specified classes.
- newFactory() - Static method in class com.marklogic.client.io.ReaderHandle
-
Creates a factory to create a ReaderHandle instance for a Reader.
- newFactory() - Static method in class com.marklogic.client.io.SourceHandle
-
Creates a factory to create a SourceHandle instance for a Transformer Source.
- newFactory() - Static method in class com.marklogic.client.io.StringHandle
-
Creates a factory to create a StringHandle instance for a string.
- newFactory() - Static method in class com.marklogic.client.io.XMLEventReaderHandle
-
Creates a factory to create an XMLEventReaderHandle instance for a StAX event reader.
- newFactory() - Static method in class com.marklogic.client.io.XMLStreamReaderHandle
-
Creates a factory to create an XMLStreamReaderHandle instance for a StAX stream reader.
- newHandle(Class<C>) - Method in interface com.marklogic.client.io.marker.ContentHandleFactory
-
Instantiates a handle for an IO class recognized by the factory.
- newJSONDocumentManager() - Method in interface com.marklogic.client.DatabaseClient
-
Creates a document manager for documents containing a JSON structure.
- newKeyLocator(String) - Method in interface com.marklogic.client.query.QueryManager
-
Creates a locator for a key-value query based on a JSON key.
- newKeyValueDefinition() - Method in interface com.marklogic.client.query.QueryManager
-
Creates a query definition based on a locator such as a JSON key,
element name, or element and attribute name and the default query
options.
- newKeyValueDefinition(String) - Method in interface com.marklogic.client.query.QueryManager
-
Creates a query definition based on a locator and on named
query options saved previously.
- newLogger(OutputStream) - Method in interface com.marklogic.client.DatabaseClient
-
Creates a logger for document and query requests.
- newNamespacesManager() - Method in interface com.marklogic.client.admin.ServerConfigurationManager
-
Creates a manager for listing, reading, writing, and deleting
namespace bindings.
- newPatchBuilder(Format) - Method in interface com.marklogic.client.document.DocumentManager
-
Creates a builder for specifying changes to the metadata of a document.
- newPatchBuilder() - Method in interface com.marklogic.client.document.JSONDocumentManager
-
Creates a builder for specifying changes to the content and metadata
of a JSON document.
- newPatchBuilder() - Method in interface com.marklogic.client.document.XMLDocumentManager
-
Creates a builder for specifying changes to the content and metadata
of an XML document.
- newQueryManager() - Method in interface com.marklogic.client.DatabaseClient
-
Creates a manager for querying the database.
- newQueryOptionsManager() - Method in interface com.marklogic.client.admin.ServerConfigurationManager
-
Creates a manager for listing, reading, writing, and deleting query options.
- newRawCombinedQueryDefinition(StructureWriteHandle) - Method in interface com.marklogic.client.query.QueryManager
-
Defines a combined query from a JSON or XML representation.
- newRawCombinedQueryDefinition(StructureWriteHandle, String) - Method in interface com.marklogic.client.query.QueryManager
-
Defines a combined query from a JSON or XML representation.
- newRawCombinedQueryDefinitionAs(Format, Object) - Method in interface com.marklogic.client.query.QueryManager
-
Defines a combined query from a JSON or XML representation provided as an object of an IO class.
- newRawCombinedQueryDefinitionAs(Format, Object, String) - Method in interface com.marklogic.client.query.QueryManager
-
Defines a combined query from a JSON or XML representation provided as an object of an IO class.
- newRawQueryByExampleDefinition(StructureWriteHandle) - Method in interface com.marklogic.client.query.QueryManager
-
Defines a simple query by example from a JSON or XML representation.
- newRawQueryByExampleDefinition(StructureWriteHandle, String) - Method in interface com.marklogic.client.query.QueryManager
-
Defines a simple query by example from a JSON or XML representation.
- newRawQueryByExampleDefinitionAs(Format, Object) - Method in interface com.marklogic.client.query.QueryManager
-
Defines a simple query by example from a JSON or XML representation provided as an object of an IO class.
- newRawQueryByExampleDefinitionAs(Format, Object, String) - Method in interface com.marklogic.client.query.QueryManager
-
Defines a simple query by example from a JSON or XML representation provided as an object of an IO class.
- newRawStructuredQueryDefinition(StructureWriteHandle) - Method in interface com.marklogic.client.query.QueryManager
-
Defines a structured query from a JSON or XML representation.
- newRawStructuredQueryDefinition(StructureWriteHandle, String) - Method in interface com.marklogic.client.query.QueryManager
-
Defines a structured query from a JSON or XML representation.
- newRawStructuredQueryDefinitionAs(Format, Object) - Method in interface com.marklogic.client.query.QueryManager
-
Defines a structured query from a JSON or XML representation provided as an object of an IO class.
- newRawStructuredQueryDefinitionAs(Format, Object, String) - Method in interface com.marklogic.client.query.QueryManager
-
Defines a structured query from a JSON or XML representation provided as an object of an IO class.
- newResourceExtensionsManager() - Method in interface com.marklogic.client.admin.ServerConfigurationManager
-
Creates a manager for listing, reading, writing, and deleting
resource service extensions.
- newRuleManager() - Method in interface com.marklogic.client.DatabaseClient
-
Creates a manager for building rules and rules-matching applications.
- newServerConfigManager() - Method in interface com.marklogic.client.DatabaseClient
-
Creates a manager for configuring the REST server for the database.
- newStringDefinition() - Method in interface com.marklogic.client.query.QueryManager
-
Creates a query definition based on a string and the default
query options.
- newStringDefinition(String) - Method in interface com.marklogic.client.query.QueryManager
-
Creates a query definition based on a string and on named query options
saved previously.
- newStructuredQueryBuilder() - Method in interface com.marklogic.client.query.QueryManager
-
Creates a query definition based on a structure that identifies
clauses and conjunctions and the default query options.
- newStructuredQueryBuilder(String) - Method in interface com.marklogic.client.query.QueryManager
-
Creates a query definition based on a structure and on named
query options saved previously.
- newSuggestDefinition() - Method in interface com.marklogic.client.query.QueryManager
-
Creates a suggestion definition based on a single string for completion,
using the default options node.
- newSuggestDefinition(String) - Method in interface com.marklogic.client.query.QueryManager
-
Creates a suggestion definition based on a query options name.
- newSuggestDefinition(String, String) - Method in interface com.marklogic.client.query.QueryManager
-
Creates a suggestion definition based on a single string for completion,
using the default options node.
- newTextDocumentManager() - Method in interface com.marklogic.client.DatabaseClient
-
Creates a document manager for documents containing unstructured text.
- newTransformExtensionsManager() - Method in interface com.marklogic.client.admin.ServerConfigurationManager
-
Creates a manager for listing, reading, writing, and deleting
transform extensions.
- newValuesDefinition(String) - Method in interface com.marklogic.client.query.QueryManager
-
Creates a query definition for retrieving values based on
a named constraint on an index and the default query options.
- newValuesDefinition(String, String) - Method in interface com.marklogic.client.query.QueryManager
-
Creates a query definition for retrieving values based on
a named constraint and on named query options saved previously.
- newValuesListDefinition() - Method in interface com.marklogic.client.query.QueryManager
-
Creates a query definition for retrieving the list of available
named lexicon configurations from the default query options.
- newValuesListDefinition(String) - Method in interface com.marklogic.client.query.QueryManager
-
Creates a query definition for retrieving the list of available
named lexicon configurations from the named query options.
- newXMLDocumentManager() - Method in interface com.marklogic.client.DatabaseClient
-
Creates a document manager for documents containing XML.
- next() - Method in class com.marklogic.client.example.extension.BatchManager.BatchResponse
-
- next() - Method in class com.marklogic.client.example.extension.SearchCollector.CollectorResults
-
- next(R) - Method in class com.marklogic.client.example.extension.SearchCollector.CollectorResults
-
- NO_CONTENT - Static variable in interface com.marklogic.client.util.RequestLogger
-
Indicates that no content is copied to the log (the default).
- not(StructuredQueryDefinition) - Method in class com.marklogic.client.query.StructuredQueryBuilder
-
Defines a NOT query for a query definition.
- notIn(StructuredQueryDefinition, StructuredQueryDefinition) - Method in class com.marklogic.client.query.StructuredQueryBuilder
-
Defines a not-in query for the positive and negative query definitions.
- ns(String, String) - Method in class com.marklogic.client.admin.config.QueryOptionsBuilder
-
Deprecated.
Builds an object that binds a prefix to a namespace uri.
- QBE_NS - Static variable in interface com.marklogic.client.query.RawQueryByExampleDefinition
-
The namespace of the built-in vocabulary for an Query by Example
in XML format.
- qualityWeight(Double) - Method in class com.marklogic.client.admin.config.support.QueryOptionsConfiguration
-
- QueryDefinition - Interface in com.marklogic.client.query
-
A QueryDefinition represents the common parts of all kinds of searches that can be performed.
- QueryManager - Interface in com.marklogic.client.query
-
A Query Manager supports searching documents and retrieving values and
tuples from lexicons.
- QueryManager.QueryView - Enum in com.marklogic.client.query
-
The view produced by a query.
- QueryOptions - Class in com.marklogic.client.admin.config
-
Deprecated.
Use a JSON or XML
write handle
or
read handle
implementation instead of this class to write or read
query options. For instance:
String opts = new StringBuilder()
.append("<options xmlns=\"http://marklogic.com/appservices/search\">")
.append( "<debug>true</debug>")
.append("</options>")
.toString();
optsMgr.writeOptions("debug", new StringHandle(opts));
or
String opts = "{\"options\":{\"debug\":true}}";
optsMgr.writeOptions("debug", new StringHandle(opts).withFormat(Format.JSON));
- QueryOptions() - Constructor for class com.marklogic.client.admin.config.QueryOptions
-
Deprecated.
- QueryOptions - Class in com.marklogic.client.example.cookbook
-
QueryOptions illustrates writing, reading, and deleting query options.
- QueryOptions() - Constructor for class com.marklogic.client.example.cookbook.QueryOptions
-
- QueryOptions.Aggregate - Class in com.marklogic.client.admin.config
-
Deprecated.
Corresponds to aggregate element in Search API configuration.
- QueryOptions.Aggregate() - Constructor for class com.marklogic.client.admin.config.QueryOptions.Aggregate
-
Deprecated.
- QueryOptions.AttributeOrElementValue - Class in com.marklogic.client.admin.config
-
Deprecated.
Wraps access to attributes and elements in one superclass.
- QueryOptions.AttributeOrElementValue() - Constructor for class com.marklogic.client.admin.config.QueryOptions.AttributeOrElementValue
-
Deprecated.
- QueryOptions.AttributeValue - Class in com.marklogic.client.admin.config
-
Deprecated.
Models access to an attribute by QName for use in metadata extraction
- QueryOptions.AttributeValue() - Constructor for class com.marklogic.client.admin.config.QueryOptions.AttributeValue
-
Deprecated.
- QueryOptions.BaseConstraintItem - Class in com.marklogic.client.admin.config
-
Deprecated.
Partial implementation of A ConstraintSource.
- QueryOptions.BaseConstraintItem() - Constructor for class com.marklogic.client.admin.config.QueryOptions.BaseConstraintItem
-
Deprecated.
Construct a new BaseConstraintItem
- QueryOptions.ConstraintValue - Class in com.marklogic.client.admin.config
-
Deprecated.
Models access to values returned by a constraint, by constraint name.
- QueryOptions.ConstraintValue() - Constructor for class com.marklogic.client.admin.config.QueryOptions.ConstraintValue
-
Deprecated.
- QueryOptions.ConstraintValue(String) - Constructor for class com.marklogic.client.admin.config.QueryOptions.ConstraintValue
-
Deprecated.
- QueryOptions.DefaultTermSource - Class in com.marklogic.client.admin.config
-
Deprecated.
The source of data for a default term search.
- QueryOptions.DefaultTermSource() - Constructor for class com.marklogic.client.admin.config.QueryOptions.DefaultTermSource
-
Deprecated.
- QueryOptions.ElementValue - Class in com.marklogic.client.admin.config
-
Deprecated.
Models access to an element by QName for use in metadata extraction
- QueryOptions.ElementValue() - Constructor for class com.marklogic.client.admin.config.QueryOptions.ElementValue
-
Deprecated.
- QueryOptions.ExpressionNamespaceBinding - Class in com.marklogic.client.admin.config
-
Deprecated.
An encapsulation of a prefix and a namespace URI for use in xpath expression evaluation.
- QueryOptions.ExpressionNamespaceBinding() - Constructor for class com.marklogic.client.admin.config.QueryOptions.ExpressionNamespaceBinding
-
Deprecated.
- QueryOptions.ExpressionNamespaceBinding(String, String) - Constructor for class com.marklogic.client.admin.config.QueryOptions.ExpressionNamespaceBinding
-
Deprecated.
- QueryOptions.ExpressionNamespaceBindings - Class in com.marklogic.client.admin.config
-
Deprecated.
A list of ExpressionNamespaceBinding objects.
- QueryOptions.ExpressionNamespaceBindings() - Constructor for class com.marklogic.client.admin.config.QueryOptions.ExpressionNamespaceBindings
-
Deprecated.
- QueryOptions.FacetableConstraintConfiguration - Class in com.marklogic.client.admin.config
-
Deprecated.
Partial implementation of constraint sources that can have facets
- QueryOptions.FacetableConstraintConfiguration() - Constructor for class com.marklogic.client.admin.config.QueryOptions.FacetableConstraintConfiguration
-
Deprecated.
Zero-argument constructor.
- QueryOptions.Facets - Enum in com.marklogic.client.admin.config
-
Deprecated.
Two possible states for faceting.
- QueryOptions.Field - Class in com.marklogic.client.admin.config
-
Deprecated.
Models a field.
- QueryOptions.Field() - Constructor for class com.marklogic.client.admin.config.QueryOptions.Field
-
Deprecated.
Zero-argument constructor.
- QueryOptions.Field(String) - Constructor for class com.marklogic.client.admin.config.QueryOptions.Field
-
Deprecated.
Constructs the field with the name of the field.
- QueryOptions.FragmentScope - Enum in com.marklogic.client.admin.config
-
Deprecated.
Enumeration of the two possibilities for Fragment scope.
- QueryOptions.Heatmap - Class in com.marklogic.client.admin.config
-
Deprecated.
Models a two-dimensional grid used to categorize data along two dimensions.
- QueryOptions.Heatmap() - Constructor for class com.marklogic.client.admin.config.QueryOptions.Heatmap
-
Deprecated.
- QueryOptions.JsonKey - Class in com.marklogic.client.admin.config
-
Deprecated.
Models a JSON Key.
- QueryOptions.JsonKey() - Constructor for class com.marklogic.client.admin.config.QueryOptions.JsonKey
-
Deprecated.
Zero-argument constructor.
- QueryOptions.JsonKey(String) - Constructor for class com.marklogic.client.admin.config.QueryOptions.JsonKey
-
Deprecated.
Constructs the JSON key specifier with the key.
- QueryOptions.MarkLogicQName - Class in com.marklogic.client.admin.config
-
Deprecated.
Models a QName, as encoded with attributes for several parts of the Search API
- QueryOptions.MarkLogicQName() - Constructor for class com.marklogic.client.admin.config.QueryOptions.MarkLogicQName
-
Deprecated.
- QueryOptions.MarkLogicQName(String, String) - Constructor for class com.marklogic.client.admin.config.QueryOptions.MarkLogicQName
-
Deprecated.
- QueryOptions.PathIndex - Class in com.marklogic.client.admin.config
-
Deprecated.
Models a Path Index specification.
- QueryOptions.PathIndex() - Constructor for class com.marklogic.client.admin.config.QueryOptions.PathIndex
-
Deprecated.
Zero-argument constructor.
- QueryOptions.PathIndex(String) - Constructor for class com.marklogic.client.admin.config.QueryOptions.PathIndex
-
Deprecated.
- QueryOptions.PathIndex(String, QueryOptions.ExpressionNamespaceBinding...) - Constructor for class com.marklogic.client.admin.config.QueryOptions.PathIndex
-
Deprecated.
- QueryOptions.PreferredElements - Class in com.marklogic.client.admin.config
-
Deprecated.
Models preferred elements.
- QueryOptions.PreferredElements() - Constructor for class com.marklogic.client.admin.config.QueryOptions.PreferredElements
-
Deprecated.
- QueryOptions.QueryAdditionalQuery - Class in com.marklogic.client.admin.config
-
Deprecated.
Wraps a cts:query element to be used in addition to other
query configuration options, as an ANDed query.
- QueryOptions.QueryAdditionalQuery() - Constructor for class com.marklogic.client.admin.config.QueryOptions.QueryAdditionalQuery
-
Deprecated.
Construct a QueryAdditionalQuery.
- QueryOptions.QueryAdditionalQuery(Element) - Constructor for class com.marklogic.client.admin.config.QueryOptions.QueryAdditionalQuery
-
Deprecated.
Construct a QueryAdditionalQuery from an existing dom Element.
- QueryOptions.QueryAnnotation - Class in com.marklogic.client.admin.config
-
Deprecated.
Models annotations for search API documents
- QueryOptions.QueryAnnotation() - Constructor for class com.marklogic.client.admin.config.QueryOptions.QueryAnnotation
-
Deprecated.
- QueryOptions.QueryAnnotation(String) - Constructor for class com.marklogic.client.admin.config.QueryOptions.QueryAnnotation
-
Deprecated.
- QueryOptions.QueryCollection - Class in com.marklogic.client.admin.config
-
Deprecated.
Models a constraint on collection URIs.
- QueryOptions.QueryCollection() - Constructor for class com.marklogic.client.admin.config.QueryOptions.QueryCollection
-
Deprecated.
- QueryOptions.QueryConstraint - Class in com.marklogic.client.admin.config
-
Deprecated.
Models a constraint node in Search API configuration.
- QueryOptions.QueryConstraint() - Constructor for class com.marklogic.client.admin.config.QueryOptions.QueryConstraint
-
Deprecated.
Zero-argument constructor.
- QueryOptions.QueryConstraint(String) - Constructor for class com.marklogic.client.admin.config.QueryOptions.QueryConstraint
-
Deprecated.
Construct with the name of the constraint.
- QueryOptions.QueryCustom - Class in com.marklogic.client.admin.config
-
Deprecated.
A custom constraint.
- QueryOptions.QueryCustom(boolean) - Constructor for class com.marklogic.client.admin.config.QueryOptions.QueryCustom
-
Deprecated.
Constructor for the custom constraint.
- QueryOptions.QueryCustom(boolean, QueryOptions.XQueryExtension) - Constructor for class com.marklogic.client.admin.config.QueryOptions.QueryCustom
-
Deprecated.
Constructor for the custom constraint.
- QueryOptions.QueryDefaultSuggestionSource - Class in com.marklogic.client.admin.config
-
Deprecated.
Models the default source for calls to the search:suggest XQuery function.
- QueryOptions.QueryDefaultSuggestionSource() - Constructor for class com.marklogic.client.admin.config.QueryOptions.QueryDefaultSuggestionSource
-
Deprecated.
- QueryOptions.QueryElementQuery - Class in com.marklogic.client.admin.config
-
Deprecated.
Models an Element Query constraint
- QueryOptions.QueryElementQuery() - Constructor for class com.marklogic.client.admin.config.QueryOptions.QueryElementQuery
-
Deprecated.
- QueryOptions.QueryExtractMetadata - Class in com.marklogic.client.admin.config
-
Deprecated.
Models specification for extracting document metadata in search results.
- QueryOptions.QueryExtractMetadata() - Constructor for class com.marklogic.client.admin.config.QueryOptions.QueryExtractMetadata
-
Deprecated.
Zero-argument constructor.
- QueryOptions.QueryGeospatialAttributePair - Class in com.marklogic.client.admin.config
-
Deprecated.
Models a geospatial index with coordinates stored in a pair of attributes
- QueryOptions.QueryGeospatialAttributePair() - Constructor for class com.marklogic.client.admin.config.QueryOptions.QueryGeospatialAttributePair
-
Deprecated.
- QueryOptions.QueryGeospatialElement - Class in com.marklogic.client.admin.config
-
Deprecated.
Models a geospatial index with coordinates stored in a single element.
- QueryOptions.QueryGeospatialElement() - Constructor for class com.marklogic.client.admin.config.QueryOptions.QueryGeospatialElement
-
Deprecated.
- QueryOptions.QueryGeospatialElementPair - Class in com.marklogic.client.admin.config
-
Deprecated.
Models a geospatial index with coordinates stored in a pair of elements.
- QueryOptions.QueryGeospatialElementPair() - Constructor for class com.marklogic.client.admin.config.QueryOptions.QueryGeospatialElementPair
-
Deprecated.
- QueryOptions.QueryGrammar - Class in com.marklogic.client.admin.config
-
Deprecated.
Models an extension to the default grammar for search strings.
- QueryOptions.QueryGrammar() - Constructor for class com.marklogic.client.admin.config.QueryOptions.QueryGrammar
-
Deprecated.
- QueryOptions.QueryGrammar.QueryJoiner - Class in com.marklogic.client.admin.config
-
Deprecated.
A Query Joiner combines two terms as part of a query grammar.
- QueryOptions.QueryGrammar.QueryJoiner() - Constructor for class com.marklogic.client.admin.config.QueryOptions.QueryGrammar.QueryJoiner
-
Deprecated.
- QueryOptions.QueryGrammar.QueryJoiner(String) - Constructor for class com.marklogic.client.admin.config.QueryOptions.QueryGrammar.QueryJoiner
-
Deprecated.
- QueryOptions.QueryGrammar.QueryJoiner.Comparator - Enum in com.marklogic.client.admin.config
-
Deprecated.
A Comparator enumerates the possible binary relations
for constraining an index with a value.
- QueryOptions.QueryGrammar.QueryJoiner.JoinerApply - Enum in com.marklogic.client.admin.config
-
Deprecated.
A JoinerApply enumerates the built-in functions available
to join the terms.
- QueryOptions.QueryGrammar.QueryStarter - Class in com.marklogic.client.admin.config
-
Deprecated.
A Query Starter delimits a term as part of a query grammar.
- QueryOptions.QueryGrammar.QueryStarter() - Constructor for class com.marklogic.client.admin.config.QueryOptions.QueryGrammar.QueryStarter
-
Deprecated.
- QueryOptions.QueryGrammar.QueryStarter(String) - Constructor for class com.marklogic.client.admin.config.QueryOptions.QueryGrammar.QueryStarter
-
Deprecated.
- QueryOptions.QueryGrammar.QueryStarter.StarterApply - Enum in com.marklogic.client.admin.config
-
Deprecated.
A StarterApply enumerates the built-in functions available
to start terms.
- QueryOptions.QueryGrammar.Tokenize - Enum in com.marklogic.client.admin.config
-
Deprecated.
Tokenize enumerates how terms are distinguished for a joiner.
- QueryOptions.QueryOperator - Class in com.marklogic.client.admin.config
-
Deprecated.
Represents how query terms are to be combined.
- QueryOptions.QueryOperator() - Constructor for class com.marklogic.client.admin.config.QueryOptions.QueryOperator
-
Deprecated.
- QueryOptions.QueryProperties - Class in com.marklogic.client.admin.config
-
Deprecated.
Corresponds to the <properties> constraint type in the MarkLogic
Search API
- QueryOptions.QueryProperties() - Constructor for class com.marklogic.client.admin.config.QueryOptions.QueryProperties
-
Deprecated.
Zero-argument constructor.
- QueryOptions.QueryRange - Class in com.marklogic.client.admin.config
-
Deprecated.
Models a range constraint source.
- QueryOptions.QueryRange() - Constructor for class com.marklogic.client.admin.config.QueryOptions.QueryRange
-
Deprecated.
Zero-argument constructor.
- QueryOptions.QueryRange.Bucket - Class in com.marklogic.client.admin.config
-
Deprecated.
Configures a range, for use in grouping range index values in facets.
- QueryOptions.QueryRange.Bucket() - Constructor for class com.marklogic.client.admin.config.QueryOptions.QueryRange.Bucket
-
Deprecated.
- QueryOptions.QueryRange.ComputedBucket - Class in com.marklogic.client.admin.config
-
Deprecated.
Models a bucket on a range constraint whose values are anchored to
time, and computed based on the current time.
- QueryOptions.QueryRange.ComputedBucket() - Constructor for class com.marklogic.client.admin.config.QueryOptions.QueryRange.ComputedBucket
-
Deprecated.
- QueryOptions.QueryRange.ComputedBucket.AnchorValue - Enum in com.marklogic.client.admin.config
-
Deprecated.
Defines values for use in computed buckets anchored to time.
- QueryOptions.QuerySearchableExpression - Class in com.marklogic.client.admin.config
-
Deprecated.
Models a searchable expression.
- QueryOptions.QuerySearchableExpression() - Constructor for class com.marklogic.client.admin.config.QueryOptions.QuerySearchableExpression
-
Deprecated.
Construct a QuerySearchableExpression
- QueryOptions.QuerySearchableExpression(String, QueryOptions.ExpressionNamespaceBinding...) - Constructor for class com.marklogic.client.admin.config.QueryOptions.QuerySearchableExpression
-
Deprecated.
Construct a QuerySearchableExpression.
- QueryOptions.QuerySortOrder - Class in com.marklogic.client.admin.config
-
Deprecated.
Models criteria for sorting results.
- QueryOptions.QuerySortOrder() - Constructor for class com.marklogic.client.admin.config.QueryOptions.QuerySortOrder
-
Deprecated.
- QueryOptions.QuerySortOrder.Direction - Enum in com.marklogic.client.admin.config
-
Deprecated.
Direction enumerates the order for sorting values.
- QueryOptions.QuerySortOrder.Score - Enum in com.marklogic.client.admin.config
-
Deprecated.
Score enumerates whether or not the relevance score is used.
- QueryOptions.QueryState - Class in com.marklogic.client.admin.config
-
Deprecated.
Models a named state to be triggered by inclusion of this name in an operator search string
- QueryOptions.QueryState() - Constructor for class com.marklogic.client.admin.config.QueryOptions.QueryState
-
Deprecated.
- QueryOptions.QuerySuggestionSource - Class in com.marklogic.client.admin.config
-
Deprecated.
Models a source for calls to the search:suggest XQuery function.
- QueryOptions.QuerySuggestionSource() - Constructor for class com.marklogic.client.admin.config.QueryOptions.QuerySuggestionSource
-
Deprecated.
- QueryOptions.QueryTerm - Class in com.marklogic.client.admin.config
-
Deprecated.
Models configuration for a search API term.
- QueryOptions.QueryTerm() - Constructor for class com.marklogic.client.admin.config.QueryOptions.QueryTerm
-
Deprecated.
- QueryOptions.QueryTerm.TermApply - Enum in com.marklogic.client.admin.config
-
Deprecated.
The TermApply enumeration provides the special circumstances of an
empty search string.
- QueryOptions.QueryTransformResults - Class in com.marklogic.client.admin.config
-
Deprecated.
Models configurations that transform search results.
- QueryOptions.QueryTransformResults() - Constructor for class com.marklogic.client.admin.config.QueryOptions.QueryTransformResults
-
Deprecated.
- QueryOptions.QueryTuples - Class in com.marklogic.client.admin.config
-
Deprecated.
Models configurations that extract co-occurring values from lexicons
Use two or more sources to retrieve tuples from the database.
- QueryOptions.QueryTuples() - Constructor for class com.marklogic.client.admin.config.QueryOptions.QueryTuples
-
Deprecated.
- QueryOptions.QueryValue - Class in com.marklogic.client.admin.config
-
Deprecated.
Models a value constraint
- QueryOptions.QueryValue() - Constructor for class com.marklogic.client.admin.config.QueryOptions.QueryValue
-
Deprecated.
- QueryOptions.QueryValues - Class in com.marklogic.client.admin.config
-
Deprecated.
Models configurations that extract values from lexicons
- QueryOptions.QueryValues() - Constructor for class com.marklogic.client.admin.config.QueryOptions.QueryValues
-
Deprecated.
- QueryOptions.QueryValues(String) - Constructor for class com.marklogic.client.admin.config.QueryOptions.QueryValues
-
Deprecated.
- QueryOptions.QueryWord - Class in com.marklogic.client.admin.config
-
Deprecated.
Models a word constraint
- QueryOptions.QueryWord() - Constructor for class com.marklogic.client.admin.config.QueryOptions.QueryWord
-
Deprecated.
- QueryOptions.WordLexicon - Class in com.marklogic.client.admin.config
-
Deprecated.
Models the word lexicon, as a source of tems for suggestions.
- QueryOptions.WordLexicon() - Constructor for class com.marklogic.client.admin.config.QueryOptions.WordLexicon
-
Deprecated.
- QueryOptions.XQueryExtension - Class in com.marklogic.client.admin.config
-
Deprecated.
Models a method to locate XQuery functions with use of "ns", "apply"
and "at" attributes.
- QueryOptions.XQueryExtension() - Constructor for class com.marklogic.client.admin.config.QueryOptions.XQueryExtension
-
Deprecated.
- QueryOptions.XQueryExtension(String, String, String) - Constructor for class com.marklogic.client.admin.config.QueryOptions.XQueryExtension
-
Deprecated.
- QueryOptionsBuilder - Class in com.marklogic.client.admin.config
-
Deprecated.
Use a JSON or XML
write handle
or
read handle
implementation instead of this class to write or read
query options. For instance:
String opts = new StringBuilder()
.append("<options xmlns=\"http://marklogic.com/appservices/search\">")
.append( "<debug>true</debug>")
.append("</options>")
.toString();
optsMgr.writeOptions("debug", new StringHandle(opts));
or
String opts = "{\"options\":{\"debug\":true}}";
optsMgr.writeOptions("debug", new StringHandle(opts).withFormat(Format.JSON));
- QueryOptionsBuilder() - Constructor for class com.marklogic.client.admin.config.QueryOptionsBuilder
-
Deprecated.
- QueryOptionsConfiguration - Class in com.marklogic.client.admin.config.support
-
Interface that wraps building configuration options for a
QueryOptions
object.
- QueryOptionsConfiguration() - Constructor for class com.marklogic.client.admin.config.support.QueryOptionsConfiguration
-
- QueryOptionsHandle - Class in com.marklogic.client.io
-
Deprecated.
Use a JSON or XML
write handle
or
read handle
implementation instead of this class to write or read
query options. For instance:
String opts = new StringBuilder()
.append("<options xmlns=\"http://marklogic.com/appservices/search\">")
.append( "<debug>true</debug>")
.append("</options>")
.toString();
optsMgr.writeOptions("debug", new StringHandle(opts));
or
String opts = "{\"options\":{\"debug\":true}}";
optsMgr.writeOptions("debug", new StringHandle(opts).withFormat(Format.JSON));
- QueryOptionsHandle() - Constructor for class com.marklogic.client.io.QueryOptionsHandle
-
Deprecated.
Construct a new empty QueryOptionsHandle object.
- QueryOptionsListBuilder - Class in com.marklogic.client.query
-
This is an implementation class used to read the list of named query options from
the server.
- QueryOptionsListBuilder() - Constructor for class com.marklogic.client.query.QueryOptionsListBuilder
-
- QueryOptionsListBuilder.OptionsList - Class in com.marklogic.client.query
-
This is an implementation class that lists the named query options from
the server.
- QueryOptionsListBuilder.OptionsList() - Constructor for class com.marklogic.client.query.QueryOptionsListBuilder.OptionsList
-
- QueryOptionsListHandle - Class in com.marklogic.client.io
-
A QueryOptionsListHandle is used to access the list of named query options that exist on the server.
- QueryOptionsListHandle() - Constructor for class com.marklogic.client.io.QueryOptionsListHandle
-
The constructor.
- QueryOptionsListReadHandle - Interface in com.marklogic.client.io.marker
-
A QueryOptionsListReadHandle represents a list of query options read from the server configuration.
- QueryOptionsListResults - Interface in com.marklogic.client.query
-
This interface supports access to the list of named query options provided by the server.
- QueryOptionsManager - Interface in com.marklogic.client.admin
-
A QueryOptionsManager support database operations on QueryOptionsHandle instances.
- QueryOptionsReadHandle - Interface in com.marklogic.client.io.marker
-
A QueryOptionsReadHandle represents a query options node read from the server configuration.
- QueryOptionsWriteHandle - Interface in com.marklogic.client.io.marker
-
A QueryOptionsWriteHandle represents a query options node to be written to the server configuration.
- QueryUri - Enum in com.marklogic.client.admin.config.support
-
A special marker for indicating that the source of
tuples or values is the URI lexicon.
- range(RangeSpec) - Method in class com.marklogic.client.admin.config.QueryOptionsBuilder
-
Deprecated.
Builds a range index specification for use in a constraint, value, tuple or term configuration.
- range(RangeSpec, QueryOptions.Facets, QueryOptions.FragmentScope, List<Buckets>, String...) - Method in class com.marklogic.client.admin.config.QueryOptionsBuilder
-
Deprecated.
Builds a range index specification for use in a constraint, values, tuples or term configuration.
- range(StructuredQueryBuilder.RangeIndex, String, StructuredQueryBuilder.Operator, Object...) - Method in class com.marklogic.client.query.StructuredQueryBuilder
-
Matches an element, attribute, json key, field, or path
whose value that has the correct datatyped comparison with
one of the criteria values.
- range(StructuredQueryBuilder.RangeIndex, String, String, StructuredQueryBuilder.Operator, Object...) - Method in class com.marklogic.client.query.StructuredQueryBuilder
-
Matches an element, attribute, json key, field, or path
whose value that has the correct datatyped comparison with
one of the criteria values.
- range(StructuredQueryBuilder.RangeIndex, String, String, StructuredQueryBuilder.FragmentScope, StructuredQueryBuilder.Operator, Object...) - Method in class com.marklogic.client.query.StructuredQueryBuilder
-
Matches an element, attribute, json key, field, or path
whose value that has the correct datatyped comparison with
one of the criteria values.
- range(StructuredQueryBuilder.RangeIndex, String, String[], StructuredQueryBuilder.Operator, Object...) - Method in class com.marklogic.client.query.StructuredQueryBuilder
-
Matches an element, attribute, json key, field, or path
whose value that has the correct datatyped comparison with
one of the criteria values.
- range(StructuredQueryBuilder.RangeIndex, String, String, String[], StructuredQueryBuilder.Operator, Object...) - Method in class com.marklogic.client.query.StructuredQueryBuilder
-
Matches an element, attribute, json key, field, or path
whose value that has the correct datatyped comparison with
one of the criteria values.
- range(StructuredQueryBuilder.RangeIndex, String, String, StructuredQueryBuilder.FragmentScope, String[], StructuredQueryBuilder.Operator, Object...) - Method in class com.marklogic.client.query.StructuredQueryBuilder
-
Matches an element, attribute, json key, field, or path
whose value that has the correct datatyped comparison with
one of the criteria values.
- rangeConstraint(String, StructuredQueryBuilder.Operator, String...) - Method in class com.marklogic.client.query.StructuredQueryBuilder
-
Matches the container specified by the constraint
whose value that has the correct datatyped comparison with
one of the criteria values.
- RangeIndexed - Interface in com.marklogic.client.admin.config.support
-
Marks classes that carry type and collation attributes.
- RangeIndexType - Class in com.marklogic.client.admin.config.support
-
Used only in
QueryOptionsBuilder
.*RangeIndex(...) methods
to mark classes that are backed my range indexes.
- RangeIndexType(String) - Constructor for class com.marklogic.client.admin.config.support.RangeIndexType
-
- rangeOptions(String...) - Method in class com.marklogic.client.query.StructuredQueryBuilder
-
Converts the list of options used for a range query to an array
as a convenience.
- RangeSpec - Interface in com.marklogic.client.admin.config.support
-
Marks classes and defines methods for configuring a
range index description.
- rangeType(String) - Method in class com.marklogic.client.admin.config.QueryOptionsBuilder
-
Deprecated.
Builds a range index type for types other than xs:string.
- RawClientAlert - Class in com.marklogic.client.example.cookbook
-
RawClientAlert illustrates defining and finding rules that match documents.
- RawClientAlert() - Constructor for class com.marklogic.client.example.cookbook.RawClientAlert
-
- RawCombinedQueryDefinition - Interface in com.marklogic.client.query
-
A RawCombinedQueryDefinition provides access to a combined query
in a JSON or XML representation.
- RawCombinedSearch - Class in com.marklogic.client.example.cookbook
-
RawCombinedSearch illustrates searching for documents and iterating over results
by passing structured criteria and query options in a single request.
- RawCombinedSearch() - Constructor for class com.marklogic.client.example.cookbook.RawCombinedSearch
-
- RawQueryByExampleDefinition - Interface in com.marklogic.client.query
-
A RawQueryByExampleDefinition provides access to a simple
query by example in an JSON or XML representation.
- RawQueryDefinition - Interface in com.marklogic.client.query
-
A RawQueryDefinition provides access to a query
in a JSON or XML representation.
- rawResults() - Method in class com.marklogic.client.admin.config.QueryOptionsBuilder
-
Deprecated.
Configures search results to return raw XML documents
- RawStructuredQueryDefinition - Interface in com.marklogic.client.query
-
A RawStructuredQueryDefinition provides access to a structured query
in a JSON or XML representation.
- read(ExtensionLibraryDescriptor, Class<T>) - Method in interface com.marklogic.client.admin.ExtensionLibrariesManager
-
Reads the contents of a library asset as an object of an IO class.
- read(String, T) - Method in interface com.marklogic.client.admin.ExtensionLibrariesManager
-
Reads the contents of a library asset into a handle.
- read(ExtensionLibraryDescriptor, T) - Method in interface com.marklogic.client.admin.ExtensionLibrariesManager
-
Reads the contents of a library asset into a handle.
- read(String, T, long, long) - Method in interface com.marklogic.client.document.BinaryDocumentManager
-
Reads a range of bytes from the content of a binary database document in the representation provided by the handle
To call read(), an application must authenticate as rest-reader, rest-writer, or rest-admin.
- read(String, T, ServerTransform, long, long) - Method in interface com.marklogic.client.document.BinaryDocumentManager
-
Reads a range of bytes from the content of a binary database document as transformed on the server.
- read(DocumentDescriptor, T, long, long) - Method in interface com.marklogic.client.document.BinaryDocumentManager
-
Reads a range of bytes from the content of a binary database document in the representation provided by the handle
To call read(), an application must authenticate as rest-reader, rest-writer, or rest-admin.
- read(DocumentDescriptor, T, ServerTransform, long, long) - Method in interface com.marklogic.client.document.BinaryDocumentManager
-
Reads a range of bytes from the content of a binary database document as transformed on the server.
- read(String, DocumentMetadataReadHandle, T, long, long) - Method in interface com.marklogic.client.document.BinaryDocumentManager
-
Reads metadata and a range of bytes from the content of a binary database document in the representations provided by the handles
To call read(), an application must authenticate as rest-reader, rest-writer, or rest-admin.
- read(String, DocumentMetadataReadHandle, T, ServerTransform, long, long) - Method in interface com.marklogic.client.document.BinaryDocumentManager
-
Reads metadata and a range of bytes from the content of a binary database document as transformed on the server.
- read(DocumentDescriptor, DocumentMetadataReadHandle, T, long, long) - Method in interface com.marklogic.client.document.BinaryDocumentManager
-
Reads metadata and a range of bytes from the content of a binary database document in the representations provided by the handles
To call read(), an application must authenticate as rest-reader, rest-writer, or rest-admin.
- read(DocumentDescriptor, DocumentMetadataReadHandle, T, ServerTransform, long, long) - Method in interface com.marklogic.client.document.BinaryDocumentManager
-
Reads metadata and a range of bytes from the content of a binary database document as transformed on the server.
- read(String, T, long, long, Transaction) - Method in interface com.marklogic.client.document.BinaryDocumentManager
-
Reads a range of bytes from the content of a binary document for an open database transaction in the representation provided by the handle
To call read(), an application must authenticate as rest-reader, rest-writer, or rest-admin.
- read(String, T, ServerTransform, long, long, Transaction) - Method in interface com.marklogic.client.document.BinaryDocumentManager
-
Reads a range of bytes from the content of a binary document for an open database transaction as transformed on the server.
- read(DocumentDescriptor, T, long, long, Transaction) - Method in interface com.marklogic.client.document.BinaryDocumentManager
-
Reads a range of bytes from the content of a binary document for an open database transaction in the representation provided by the handle
To call read(), an application must authenticate as rest-reader, rest-writer, or rest-admin.
- read(DocumentDescriptor, T, ServerTransform, long, long, Transaction) - Method in interface com.marklogic.client.document.BinaryDocumentManager
-
Reads a range of bytes from the content of a binary document for an open database transaction as transformed on the server.
- read(String, DocumentMetadataReadHandle, T, long, long, Transaction) - Method in interface com.marklogic.client.document.BinaryDocumentManager
-
Reads metadata and a range of bytes from the content of a binary document for an open database transaction in the representations provided by the handles
To call read(), an application must authenticate as rest-reader, rest-writer, or rest-admin.
- read(String, DocumentMetadataReadHandle, T, ServerTransform, long, long, Transaction) - Method in interface com.marklogic.client.document.BinaryDocumentManager
-
Reads metadata and a range of bytes from the content of a binary document for an open database transaction as transformed on the server.
- read(DocumentDescriptor, DocumentMetadataReadHandle, T, long, long, Transaction) - Method in interface com.marklogic.client.document.BinaryDocumentManager
-
Reads metadata and a range of bytes from the content of a binary document for an open database transaction in the representations provided by the handles
To call read(), an application must authenticate as rest-reader, rest-writer, or rest-admin.
- read(DocumentDescriptor, DocumentMetadataReadHandle, T, ServerTransform, long, long, Transaction) - Method in interface com.marklogic.client.document.BinaryDocumentManager
-
Reads metadata and a range of bytes from the content of a binary document for an open database transaction as transformed on the server.
- read(String, T) - Method in interface com.marklogic.client.document.DocumentManager
-
Reads the document content from the database in the representation provided by the handle
To call read(), an application must authenticate as rest-reader, rest-writer, or rest-admin.
- read(String, T, ServerTransform) - Method in interface com.marklogic.client.document.DocumentManager
-
Reads the document content from the database as transformed on the server.
- read(DocumentDescriptor, T) - Method in interface com.marklogic.client.document.DocumentManager
-
Reads the document content from the database in the representations provided by the handles
To call read(), an application must authenticate as rest-reader, rest-writer, or rest-admin.
- read(DocumentDescriptor, T, ServerTransform) - Method in interface com.marklogic.client.document.DocumentManager
-
Reads the document content from the database as transformed on the server.
- read(String, DocumentMetadataReadHandle, T) - Method in interface com.marklogic.client.document.DocumentManager
-
Reads the document metadata and content from the database in the representations provided by the handles
To call read(), an application must authenticate as rest-reader, rest-writer, or rest-admin.
- read(String, DocumentMetadataReadHandle, T, ServerTransform) - Method in interface com.marklogic.client.document.DocumentManager
-
Reads the document metadata and content from the database as transformed on the server.
- read(DocumentDescriptor, DocumentMetadataReadHandle, T) - Method in interface com.marklogic.client.document.DocumentManager
-
Reads the document metadata and content from the database in the representations provided by the handles
To call read(), an application must authenticate as rest-reader, rest-writer, or rest-admin.
- read(DocumentDescriptor, DocumentMetadataReadHandle, T, ServerTransform) - Method in interface com.marklogic.client.document.DocumentManager
-
Reads the document metadata and content from the database as transformed on the server.
- read(String, T, Transaction) - Method in interface com.marklogic.client.document.DocumentManager
-
Reads the document content from an open database transaction in the representation provided by the handle
To call read(), an application must authenticate as rest-reader, rest-writer, or rest-admin.
- read(String, T, ServerTransform, Transaction) - Method in interface com.marklogic.client.document.DocumentManager
-
Reads the document content from an open database transaction as transformed on the server.
- read(DocumentDescriptor, T, Transaction) - Method in interface com.marklogic.client.document.DocumentManager
-
Reads the document content from an open database transaction in the representation provided by the handle
To call read(), an application must authenticate as rest-reader, rest-writer, or rest-admin.
- read(DocumentDescriptor, T, ServerTransform, Transaction) - Method in interface com.marklogic.client.document.DocumentManager
-
Reads the document content from an open database transaction as transformed on the server.
- read(String, DocumentMetadataReadHandle, T, Transaction) - Method in interface com.marklogic.client.document.DocumentManager
-
Reads the document metadata and content from an open database transaction in the representations provided by the handles
To call read(), an application must authenticate as rest-reader, rest-writer, or rest-admin.
- read(String, DocumentMetadataReadHandle, T, ServerTransform, Transaction) - Method in interface com.marklogic.client.document.DocumentManager
-
Reads the document metadata and content from an open database transaction as transformed on the server.
- read(DocumentDescriptor, DocumentMetadataReadHandle, T, Transaction) - Method in interface com.marklogic.client.document.DocumentManager
-
Reads the document metadata and content from an open database transaction in the representations provided by the handles
To call read(), an application must authenticate as rest-reader, rest-writer, or rest-admin.
- read(DocumentDescriptor, DocumentMetadataReadHandle, T, ServerTransform, Transaction) - Method in interface com.marklogic.client.document.DocumentManager
-
Reads the document metadata and content from an open database transaction as transformed on the server.
- read(GraphManager.GraphFormat, T) - Method in class com.marklogic.client.example.extension.GraphManager
-
Reads the default RDF graph from the server
- read(String, GraphManager.GraphFormat, T) - Method in class com.marklogic.client.example.extension.GraphManager
-
Reads a named graph from the server
- readAll() - Method in interface com.marklogic.client.admin.NamespacesManager
-
Reads all of the namespace bindings from the server.
- readAs(String, Class<T>) - Method in interface com.marklogic.client.admin.ExtensionLibrariesManager
-
Reads the contents of a library asset as an object of an IO class.
- readAs(String, Class<T>, long, long) - Method in interface com.marklogic.client.document.BinaryDocumentManager
-
Reads a range of bytes from the content of a binary database document in the representation specified by the IO class.
- readAs(String, DocumentMetadataReadHandle, Class<T>, long, long) - Method in interface com.marklogic.client.document.BinaryDocumentManager
-
Reads a range of bytes from the content of a binary database document in the representation specified by the IO class.
- readAs(String, Class<T>) - Method in interface com.marklogic.client.document.DocumentManager
-
Reads the document content from the database in the representation specified by the IO class.
- readAs(String, Class<T>, ServerTransform) - Method in interface com.marklogic.client.document.DocumentManager
-
Reads the document content from the database in the representation specified by the IO class.
- readAs(String, DocumentMetadataReadHandle, Class<T>) - Method in interface com.marklogic.client.document.DocumentManager
-
Reads the document metadata and content from the database in the representation specified by the IO class.
- readAs(String, DocumentMetadataReadHandle, Class<T>, ServerTransform) - Method in interface com.marklogic.client.document.DocumentManager
-
Reads the document metadata and content from the database in the representation specified by the IO class.
- readConfiguration() - Method in interface com.marklogic.client.admin.ServerConfigurationManager
-
Reads the values of the properties from the server into this object.
- readDocument(String, int, String, String, DatabaseClientFactory.Authentication) - Static method in class com.marklogic.client.example.cookbook.DocumentReadTransform
-
- ReaderHandle - Class in com.marklogic.client.io
-
A Reader Handle represents a character content as a reader
for reading to or writing from the database.
- ReaderHandle() - Constructor for class com.marklogic.client.io.ReaderHandle
-
Zero-argument constructor.
- ReaderHandle(Reader) - Constructor for class com.marklogic.client.io.ReaderHandle
-
Initializes the handle with a character reader for the content.
- readerPassword - Variable in class com.marklogic.client.example.cookbook.Util.ExampleProperties
-
- readerUser - Variable in class com.marklogic.client.example.cookbook.Util.ExampleProperties
-
- readMetadata(String, T) - Method in interface com.marklogic.client.document.DocumentManager
-
Reads the document metadata from the database in the representation provided by the handle
To call readMetadata(), an application must authenticate as rest-reader, rest-writer, or rest-admin.
- readMetadata(String, T, Transaction) - Method in interface com.marklogic.client.document.DocumentManager
-
Reads the document metadata from an open database transaction in the representation provided by the handle
To call readMetadata(), an application must authenticate as rest-reader, rest-writer, or rest-admin.
- readOptions(String, T) - Method in interface com.marklogic.client.admin.QueryOptionsManager
-
Fetch a query options configuration from the REST Server by name.
- readOptionsAs(String, Format, Class<T>) - Method in interface com.marklogic.client.admin.QueryOptionsManager
-
Fetch a query options configuration from the REST Server by name.
- readPrefix(String) - Method in interface com.marklogic.client.admin.NamespacesManager
-
Returns the namespace URI bound to the specified prefix on the server.
- readRule(String, T) - Method in interface com.marklogic.client.alerting.RuleManager
-
Reads a rule from the server into the provided handle.
- readRuleAs(String, Class<T>) - Method in interface com.marklogic.client.alerting.RuleManager
-
Reads a rule from the server in an XML representation provided
as an object of an IO class.
- readServices(String, T) - Method in interface com.marklogic.client.admin.ResourceExtensionsManager
-
Reads the XQuery implementation of the services for a resource.
- readServicesAs(String, Class<T>) - Method in interface com.marklogic.client.admin.ResourceExtensionsManager
-
Reads the XQuery implementation of the services for a resource
in a textual representation provided as an object of an IO class.
- readStatus(T) - Method in interface com.marklogic.client.Transaction
-
Reads the status for the transaction including whether the transaction
has timed out.
- readXQueryTransform(String, T) - Method in interface com.marklogic.client.admin.TransformExtensionsManager
-
Reads the source for a transform implemented in XQuery.
- readXQueryTransformAs(String, Class<T>) - Method in interface com.marklogic.client.admin.TransformExtensionsManager
-
Reads the source for a transform implemented in XQuery
in a textual representation provided as an object of an IO class.
- readXSLTransform(String, T) - Method in interface com.marklogic.client.admin.TransformExtensionsManager
-
Reads the source for a transform implemented in XSLT.
- readXSLTransformAs(String, Class<T>) - Method in interface com.marklogic.client.admin.TransformExtensionsManager
-
Reads the source for a transform implemented in XSLT
in an XML representation provided as an object of an IO class.
- register(ContentHandleFactory) - Method in interface com.marklogic.client.DatabaseClientFactory.HandleFactoryRegistry
-
Associates a factory for content handles with the classes
for IO representations known to the factory.
- register(ContentHandleFactory, Class<?>...) - Method in interface com.marklogic.client.DatabaseClientFactory.HandleFactoryRegistry
-
Associates a factory for content handles with the specified classes
for IO representations.
- registerDefaultHandles() - Method in class com.marklogic.client.DatabaseClientFactory.Bean
-
Initializes a handle registry with the default associations
between the content handles provided by the API and the supported
IO representation classes.
- registerDefaultHandles() - Static method in class com.marklogic.client.DatabaseClientFactory
-
Initializes a handle registry with the default associations
between the content handles provided by the API and the supported
IO representation classes.
- release() - Method in interface com.marklogic.client.DatabaseClient
-
Closes the database client and releases associated resources.
- remove() - Method in class com.marklogic.client.example.extension.BatchManager.BatchResponse
-
- remove() - Method in class com.marklogic.client.example.extension.SearchCollector.CollectorResults
-
- remove(Object) - Method in class com.marklogic.client.util.EditableNamespaceContext
-
Removes the namespace binding for a prefix.
- remove(String) - Method in interface com.marklogic.client.util.NameMap
-
Removes the key-value pair from the map.
- remove(Object) - Method in class com.marklogic.client.util.RequestParameters
-
Removes a parameter name, returning its values if any.
- replace(GraphManager.GraphFormat, GenericWriteHandle) - Method in class com.marklogic.client.example.extension.GraphManager
-
Replaces the default graph on the REST server/
- replace(String, GraphManager.GraphFormat, GenericWriteHandle) - Method in class com.marklogic.client.example.extension.GraphManager
-
Replaces a named graph on the REST server
- replaceApply(String, DocumentMetadataPatchBuilder.Call) - Method in interface com.marklogic.client.document.DocumentPatchBuilder
-
Specifies a replacement operation by applying a function to
an existing JSON or XML fragment.
- replaceApply(String, DocumentMetadataPatchBuilder.Cardinality, DocumentMetadataPatchBuilder.Call) - Method in interface com.marklogic.client.document.DocumentPatchBuilder
-
Specifies a replacement operation by applying a function to
an existing JSON or XML fragment.
- replaceCollection(String, String) - Method in interface com.marklogic.client.document.DocumentMetadataPatchBuilder
-
Replaces the specified collection.
- replaceFragment(String, Object) - Method in interface com.marklogic.client.document.DocumentPatchBuilder
-
Specifies a fragment to replace an existing JSON or XML fragment.
- replaceFragment(String, DocumentMetadataPatchBuilder.Cardinality, Object) - Method in interface com.marklogic.client.document.DocumentPatchBuilder
-
Specifies a fragment to replace an existing JSON or XML fragment.
- replaceInsertFragment(String, String, DocumentPatchBuilder.Position, Object) - Method in interface com.marklogic.client.document.DocumentPatchBuilder
-
Specifies a fragment to replace an existing JSON or XML fragment
or (if the existing fragment doesn't exist) to insert relative
to a different existing JSON or XML fragment.
- replaceInsertFragment(String, String, DocumentPatchBuilder.Position, DocumentMetadataPatchBuilder.Cardinality, Object) - Method in interface com.marklogic.client.document.DocumentPatchBuilder
-
Specifies a fragment to replace an existing JSON or XML fragment
or (if the existing fragment doesn't exist) to insert relative
to a different existing JSON or XML fragment.
- replacePermission(String, DocumentMetadataHandle.Capability...) - Method in interface com.marklogic.client.document.DocumentMetadataPatchBuilder
-
Replaces the existing capabilities of a role.
- replacePermission(String, String, DocumentMetadataHandle.Capability...) - Method in interface com.marklogic.client.document.DocumentMetadataPatchBuilder
-
Replaces an existing role with a new role.
- replacePropertyApply(String, DocumentMetadataPatchBuilder.Call) - Method in interface com.marklogic.client.document.DocumentMetadataPatchBuilder
-
Specifies a replacement operation by applying a function
to a metadata property having a simple name.
- replacePropertyApply(QName, DocumentMetadataPatchBuilder.Call) - Method in interface com.marklogic.client.document.DocumentMetadataPatchBuilder
-
Specifies a replacement operation by applying a function
to a metadata property having a namespaced name.
- replacePropertyValue(String, Object) - Method in interface com.marklogic.client.document.DocumentMetadataPatchBuilder
-
Replaces the existing value of a metadata property having a simple name.
- replacePropertyValue(QName, Object) - Method in interface com.marklogic.client.document.DocumentMetadataPatchBuilder
-
Replaces the existing value of a metadata property having a namespaced name.
- replacePropertyValue(String, String, Object) - Method in interface com.marklogic.client.document.DocumentMetadataPatchBuilder
-
Replaces an existing metadata property with a new property having a simple name.
- replacePropertyValue(QName, QName, Object) - Method in interface com.marklogic.client.document.DocumentMetadataPatchBuilder
-
Replaces an existing metadata property with a new property having a namespaced name.
- replaceRegex(String, String) - Method in interface com.marklogic.client.document.DocumentMetadataPatchBuilder.CallBuilder
-
Calls the built-in method to modify an existing string
with a regular expression
- replaceRegex(String, String, String) - Method in interface com.marklogic.client.document.DocumentMetadataPatchBuilder.CallBuilder
-
Calls the built-in method to modify an existing string
with a regular expression
- replaceValue(String, Object) - Method in interface com.marklogic.client.document.DocumentPatchBuilder
-
Specifies a value to replace the existing value of a JSON or XML node.
- replaceValue(String, DocumentMetadataPatchBuilder.Cardinality, Object) - Method in interface com.marklogic.client.document.DocumentPatchBuilder
-
Specifies a value to replace the existing value of a JSON or XML node.
- RequestConstants - Class in com.marklogic.client
-
The RequestConstants class provides constants for the common namespace
prefixes and URIs used in the Java API (similar to the XML constants
provided by the javax.xml.XMLConstants class).
- RequestConstants() - Constructor for class com.marklogic.client.RequestConstants
-
- RequestLogger - Interface in com.marklogic.client.util
-
Request Logger records the requests sent to the server.
- RequestParameters - Class in com.marklogic.client.util
-
RequestParameters supports a map with a string as the key and
a list of strings as the value, which can represent parameters
of an operation including parameters transported over HTTP.
- RequestParameters() - Constructor for class com.marklogic.client.util.RequestParameters
-
Zero-argument constructor.
- requireOptimisticLocking(String, int, String, String, DatabaseClientFactory.Authentication) - Static method in class com.marklogic.client.example.cookbook.OptimisticLocking
-
- ResourceExtension - Class in com.marklogic.client.example.cookbook
-
ResourceExtension installs an extension for managing spelling dictionary resources.
- ResourceExtension() - Constructor for class com.marklogic.client.example.cookbook.ResourceExtension
-
- ResourceExtension.DictionaryManager - Class in com.marklogic.client.example.cookbook
-
DictionaryManager provides an example of a class that implements
a resource extension client, exposing a method for each service.
- ResourceExtension.DictionaryManager(DatabaseClient) - Constructor for class com.marklogic.client.example.cookbook.ResourceExtension.DictionaryManager
-
- ResourceExtensionsManager - Interface in com.marklogic.client.admin
-
A Resource Extensions Manager supports writing, reading, and deleting
a Resource Services extension as well as listing the installed
Resource Services extensions.
- ResourceExtensionsManager.MethodParameters - Class in com.marklogic.client.admin
-
Method Parameters declare the parameters accepted
by the Resource Services extension.
- ResourceExtensionsManager.MethodParameters(MethodType) - Constructor for class com.marklogic.client.admin.ResourceExtensionsManager.MethodParameters
-
Declares the parameters for a method the provides services for a resource.
- ResourceManager - Class in com.marklogic.client.extensions
-
ResourceManager is the base class for a client interface
to resource services.
- ResourceNotFoundException - Exception in com.marklogic.client
-
Exception thrown when the server responds with HTTP status code 404.
- ResourceNotFoundException(String) - Constructor for exception com.marklogic.client.ResourceNotFoundException
-
- ResourceNotFoundException(String, FailedRequest) - Constructor for exception com.marklogic.client.ResourceNotFoundException
-
- ResourceNotResendableException - Exception in com.marklogic.client
-
Exception thrown when the server responds with HTTP status code 503
and a Retry-After header of 1 but the request is a PUT or POST
and the payload is streaming.
- ResourceNotResendableException(String) - Constructor for exception com.marklogic.client.ResourceNotResendableException
-
- ResourceServices - Interface in com.marklogic.client.extensions
-
A ResourceServices object supports calling the services for a resource.
- ResourceServices.ServiceResult - Interface in com.marklogic.client.extensions
-
ServiceResult provides one content response from a service.
- ResourceServices.ServiceResultIterator - Interface in com.marklogic.client.extensions
-
ServiceResultIterator provides an iterator over content responses
from the server.
- RESTAPI_NS - Static variable in class com.marklogic.client.example.extension.OpenCSVBatcher
-
- RESTAPI_NS - Static variable in class com.marklogic.client.RequestConstants
-
The namespace URI for vocabularies implemented by the REST API.
- RESTAPI_PREFIX - Static variable in class com.marklogic.client.example.extension.OpenCSVBatcher
-
- RESTAPI_PREFIX - Static variable in class com.marklogic.client.RequestConstants
-
The conventional namespace prefix for vocabularies implemented by the REST API.
- returnAggregates(Boolean) - Method in class com.marklogic.client.admin.config.support.QueryOptionsConfiguration
-
- returnConstraints(Boolean) - Method in class com.marklogic.client.admin.config.support.QueryOptionsConfiguration
-
- returnFacets(Boolean) - Method in class com.marklogic.client.admin.config.support.QueryOptionsConfiguration
-
- returnFrequencies(Boolean) - Method in class com.marklogic.client.admin.config.support.QueryOptionsConfiguration
-
- returnMetrics(Boolean) - Method in class com.marklogic.client.admin.config.support.QueryOptionsConfiguration
-
- returnPlan(Boolean) - Method in class com.marklogic.client.admin.config.support.QueryOptionsConfiguration
-
- returnQtext(Boolean) - Method in class com.marklogic.client.admin.config.support.QueryOptionsConfiguration
-
- returnQuery(Boolean) - Method in class com.marklogic.client.admin.config.support.QueryOptionsConfiguration
-
- returnResults(Boolean) - Method in class com.marklogic.client.admin.config.support.QueryOptionsConfiguration
-
- returnSimilar(Boolean) - Method in class com.marklogic.client.admin.config.support.QueryOptionsConfiguration
-
- returnValues(Boolean) - Method in class com.marklogic.client.admin.config.support.QueryOptionsConfiguration
-
- rollback() - Method in interface com.marklogic.client.Transaction
-
Cancels the transaction, reverting the database to its state prior to the writes and deletes
made in the transaction.
- RuleDefinition - Class in com.marklogic.client.alerting
-
A RuleDefinition represents a set of criteria that describe a named condition.
- RuleDefinition(String, String) - Constructor for class com.marklogic.client.alerting.RuleDefinition
-
Make a new rule definition
- RuleDefinition() - Constructor for class com.marklogic.client.alerting.RuleDefinition
-
Make a new rule definition, no argument constructor.
- RuleDefinition.RuleMetadata - Interface in com.marklogic.client.alerting
-
A RuleMetadata represents optional client-supplied metadata that is stored alongside a RuleDefinition.
- RuleDefinitionList - Class in com.marklogic.client.alerting
-
Models a list of RuleDefinitions.
- RuleDefinitionList() - Constructor for class com.marklogic.client.alerting.RuleDefinitionList
-
- RuleListReadHandle - Interface in com.marklogic.client.io.marker
-
- RuleManager - Interface in com.marklogic.client.alerting
-
Manages CRUD of rules for the REST API alerting capability, as well as match
operations against installed rules.
- RuleReadHandle - Interface in com.marklogic.client.io.marker
-
- RuleWriteHandle - Interface in com.marklogic.client.io.marker
-
- run(Util.ExampleProperties) - Static method in class com.marklogic.client.example.cookbook.ClientCreator
-
- run(Util.ExampleProperties) - Static method in class com.marklogic.client.example.cookbook.DocumentDelete
-
- run(Util.ExampleProperties) - Static method in class com.marklogic.client.example.cookbook.DocumentFormats
-
- run(Util.ExampleProperties) - Static method in class com.marklogic.client.example.cookbook.DocumentMetadataRead
-
- run(Util.ExampleProperties) - Static method in class com.marklogic.client.example.cookbook.DocumentMetadataWrite
-
- run(Util.ExampleProperties) - Static method in class com.marklogic.client.example.cookbook.DocumentOutputStream
-
- run(Util.ExampleProperties) - Static method in class com.marklogic.client.example.cookbook.DocumentRead
-
- run(Util.ExampleProperties) - Static method in class com.marklogic.client.example.cookbook.DocumentReadTransform
-
- run(Util.ExampleProperties) - Static method in class com.marklogic.client.example.cookbook.DocumentWrite
-
- run(Util.ExampleProperties) - Static method in class com.marklogic.client.example.cookbook.DocumentWriteServerURI
-
- run(Util.ExampleProperties) - Static method in class com.marklogic.client.example.cookbook.DocumentWriteTransform
-
- run(Util.ExampleProperties) - Static method in class com.marklogic.client.example.cookbook.JAXBDocument
-
- run(Util.ExampleProperties) - Static method in class com.marklogic.client.example.cookbook.KeyValueSearch
-
- run(Util.ExampleProperties) - Static method in class com.marklogic.client.example.cookbook.MultiStatementTransaction
-
- run(Util.ExampleProperties) - Static method in class com.marklogic.client.example.cookbook.OptimisticLocking
-
- run(Util.ExampleProperties) - Static method in class com.marklogic.client.example.cookbook.QueryOptions
-
- run(Util.ExampleProperties) - Static method in class com.marklogic.client.example.cookbook.RawClientAlert
-
- run(Util.ExampleProperties) - Static method in class com.marklogic.client.example.cookbook.RawCombinedSearch
-
- run(Util.ExampleProperties) - Static method in class com.marklogic.client.example.cookbook.ResourceExtension
-
- run(Util.ExampleProperties) - Static method in class com.marklogic.client.example.cookbook.SearchResponseTransform
-
- run(Util.ExampleProperties) - Static method in class com.marklogic.client.example.cookbook.SSLClientCreator
-
- run(Util.ExampleProperties) - Static method in class com.marklogic.client.example.cookbook.StringSearch
-
- run(Util.ExampleProperties) - Static method in class com.marklogic.client.example.cookbook.StructuredSearch
-
- run(Util.ExampleProperties) - Static method in class com.marklogic.client.example.cookbook.Suggest
-
- run(Util.ExampleProperties) - Static method in class com.marklogic.client.example.extension.BatchManagerExample
-
- run(Util.ExampleProperties) - Static method in class com.marklogic.client.example.extension.OpenCSVBatcherExample
-
- run(Util.ExampleProperties) - Static method in class com.marklogic.client.example.extension.SearchCollectorExample
-
- run(Util.ExampleProperties) - Static method in class com.marklogic.client.example.handle.DOM4JHandleExample
-
- run(Util.ExampleProperties) - Static method in class com.marklogic.client.example.handle.GSONHandleExample
-
- run(Util.ExampleProperties) - Static method in class com.marklogic.client.example.handle.HTMLCleanerHandleExample
-
- run(Util.ExampleProperties) - Static method in class com.marklogic.client.example.handle.JacksonHandleExample
-
- run(Util.ExampleProperties) - Static method in class com.marklogic.client.example.handle.JDOMHandleExample
-
- run(Util.ExampleProperties) - Static method in class com.marklogic.client.example.handle.URIHandleExample
-
- run(Util.ExampleProperties) - Static method in class com.marklogic.client.example.handle.XOMHandleExample
-
- runQuery(DatabaseClient) - Static method in class com.marklogic.client.example.extension.GraphSPARQLExample
-
- runShortcut(DatabaseClient) - Static method in class com.marklogic.client.example.cookbook.DocumentRead
-
- runShortcut(DatabaseClient) - Static method in class com.marklogic.client.example.cookbook.DocumentWrite
-
- runShortcut(Util.ExampleProperties) - Static method in class com.marklogic.client.example.cookbook.JAXBDocument
-
- runShortcut(DatabaseClient) - Static method in class com.marklogic.client.example.cookbook.QueryOptions
-
- runShortcut(Util.ExampleProperties) - Static method in class com.marklogic.client.example.handle.DOM4JHandleExample
-
- runShortcut(Util.ExampleProperties) - Static method in class com.marklogic.client.example.handle.GSONHandleExample
-
- runShortcut(Util.ExampleProperties) - Static method in class com.marklogic.client.example.handle.JacksonHandleExample
-
- runShortcut(Util.ExampleProperties) - Static method in class com.marklogic.client.example.handle.JDOMHandleExample
-
- runShortcut(Util.ExampleProperties) - Static method in class com.marklogic.client.example.handle.XOMHandleExample
-
- runStrongTyped(DatabaseClient) - Static method in class com.marklogic.client.example.cookbook.DocumentRead
-
- runStrongTyped(DatabaseClient) - Static method in class com.marklogic.client.example.cookbook.DocumentWrite
-
- runStrongTyped(Util.ExampleProperties) - Static method in class com.marklogic.client.example.cookbook.JAXBDocument
-
- runStrongTyped(DatabaseClient) - Static method in class com.marklogic.client.example.cookbook.QueryOptions
-
- runStrongTyped(Util.ExampleProperties) - Static method in class com.marklogic.client.example.handle.DOM4JHandleExample
-
- runStrongTyped(Util.ExampleProperties) - Static method in class com.marklogic.client.example.handle.GSONHandleExample
-
- runStrongTyped(Util.ExampleProperties) - Static method in class com.marklogic.client.example.handle.JacksonHandleExample
-
- runStrongTyped(Util.ExampleProperties) - Static method in class com.marklogic.client.example.handle.JDOMHandleExample
-
- runStrongTyped(Util.ExampleProperties) - Static method in class com.marklogic.client.example.handle.XOMHandleExample
-
- search(String, int, String, String, DatabaseClientFactory.Authentication) - Static method in class com.marklogic.client.example.cookbook.SearchResponseTransform
-
- search(String, int, String, String, DatabaseClientFactory.Authentication) - Static method in class com.marklogic.client.example.cookbook.StringSearch
-
- search(String, int, String, String, DatabaseClientFactory.Authentication) - Static method in class com.marklogic.client.example.cookbook.StructuredSearch
-
- search(XMLWriteHandle, SPARQLManager.QueryFormat, T) - Method in class com.marklogic.client.example.extension.SPARQLManager
-
- search(String, XMLWriteHandle, SPARQLManager.QueryFormat, T) - Method in class com.marklogic.client.example.extension.SPARQLManager
-
- search(String[], XMLWriteHandle, SPARQLManager.QueryFormat, T) - Method in class com.marklogic.client.example.extension.SPARQLManager
-
- search(String, String[], XMLWriteHandle, SPARQLManager.QueryFormat, T) - Method in class com.marklogic.client.example.extension.SPARQLManager
-
- search(QueryDefinition, T) - Method in interface com.marklogic.client.query.QueryManager
-
Searches documents based on query criteria and, potentially, previously
saved query options.
- search(QueryDefinition, T, long) - Method in interface com.marklogic.client.query.QueryManager
-
Searches documents based on query criteria and, potentially, previously
saved query options starting with the specified page listing
document results.
- search(QueryDefinition, T, Transaction) - Method in interface com.marklogic.client.query.QueryManager
-
Searches documents based on query criteria and, potentially, previously
saved query options.
- search(QueryDefinition, T, long, Transaction) - Method in interface com.marklogic.client.query.QueryManager
-
Searches documents based on query criteria and, potentially, previously
saved query options starting with the specified page listing
document results.
- SEARCH_NS - Static variable in class com.marklogic.client.admin.config.QueryOptions
-
Deprecated.
- SEARCH_NS - Static variable in class com.marklogic.client.RequestConstants
-
The namespace URI for vocabularies implemented by the Search API.
- SEARCH_PREFIX - Static variable in class com.marklogic.client.RequestConstants
-
The conventional namespace prefix for vocabularies implemented by the Search API.
- searchableExpression(String, QueryOptions.ExpressionNamespaceBinding...) - Method in class com.marklogic.client.admin.config.QueryOptionsBuilder
-
Deprecated.
Defines an XPath expression to be used as the context for all searches.
- SearchCollector - Class in com.marklogic.client.example.extension
-
SearchCollector provides an extension for collecting a set of database
documents based on a search.
- SearchCollector(DatabaseClient) - Constructor for class com.marklogic.client.example.extension.SearchCollector
-
- SearchCollector.CollectorResults - Class in com.marklogic.client.example.extension
-
- SearchCollectorExample - Class in com.marklogic.client.example.extension
-
SearchCollectorExample illustrates reading a page of documents
qualified by a query using the SearchCollector class example
of a Resource Extension.
- SearchCollectorExample() - Constructor for class com.marklogic.client.example.extension.SearchCollectorExample
-
- SearchHandle - Class in com.marklogic.client.io
-
A SearchHandle represents a set of search results returned by the server.
- SearchHandle() - Constructor for class com.marklogic.client.io.SearchHandle
-
- SearchHandle.Report - Class in com.marklogic.client.io
-
Represents a report message.
- SearchHandle.Warning - Class in com.marklogic.client.io
-
Represents a warning.
- SearchMetrics - Interface in com.marklogic.client.query
-
A SearchMetrics object represents the query metrics returned by a search.
- searchOptions(String...) - Method in class com.marklogic.client.admin.config.support.QueryOptionsConfiguration
-
- SearchReadHandle - Interface in com.marklogic.client.io.marker
-
A SearchReadHandle represents the results of a search performed over the database.
- SearchResponseTransform - Class in com.marklogic.client.example.cookbook
-
Search illustrates adding a result transformation to
a search.
- SearchResponseTransform() - Constructor for class com.marklogic.client.example.cookbook.SearchResponseTransform
-
- SearchResults - Interface in com.marklogic.client.query
-
The SearchResults represent the set of results returned by a search.
- serialize() - Method in interface com.marklogic.client.query.StructuredQueryBuilder.Region
-
Deprecated.
Returns the region as a partial string. This method will be removed in a future
release.
- serialize() - Method in interface com.marklogic.client.query.StructuredQueryDefinition
-
Returns the structured query definition as a serialized XML string.
- ServerConfigurationManager - Interface in com.marklogic.client.admin
-
The ServerConfigurationManager reads and writes the configurable properties
of the server.
- ServerConfigurationManager.Policy - Enum in com.marklogic.client.admin
-
Specifies the policy for use of a capability.
- ServerConfigurationManager.UpdatePolicy - Enum in com.marklogic.client.admin
-
Specifies the policy for updating documents in the database.
- ServerTransform - Class in com.marklogic.client.document
-
ServerTransform specifies the invocation of a transform on the server
including both the name of the transform and the parameters passed
to the transform.
- ServerTransform(String) - Constructor for class com.marklogic.client.document.ServerTransform
-
Specifies invocation of the named transform on the server.
- set(TagNode) - Method in class com.marklogic.client.example.handle.HTMLCleanerHandle
-
- set(File, String) - Method in class com.marklogic.client.example.handle.HTMLCleanerHandle
-
- set(InputStream, String) - Method in class com.marklogic.client.example.handle.HTMLCleanerHandle
-
- set(Reader) - Method in class com.marklogic.client.example.handle.HTMLCleanerHandle
-
- set(String) - Method in class com.marklogic.client.example.handle.HTMLCleanerHandle
-
- set(URI) - Method in class com.marklogic.client.example.handle.URIHandle
-
- set(String) - Method in class com.marklogic.client.example.handle.URIHandle
-
- set(Document) - Method in class com.marklogic.client.extra.dom4j.DOM4JHandle
-
Assigns an XML document structure as the content.
- set(JsonElement) - Method in class com.marklogic.client.extra.gson.GSONHandle
-
Assigns a JSON tree as the content.
- set(JsonNode) - Method in class com.marklogic.client.extra.jackson.JacksonHandle
-
Assigns a JSON tree as the content.
- set(Document) - Method in class com.marklogic.client.extra.jdom.JDOMHandle
-
Assigns an XML document structure as the content.
- set(Document) - Method in class com.marklogic.client.extra.xom.XOMHandle
-
Assigns an XML document structure as the content.
- set(byte[]) - Method in class com.marklogic.client.io.BytesHandle
-
Assigns a byte array as the content.
- set(Document) - Method in class com.marklogic.client.io.DOMHandle
-
Assigns a DOM document as the content.
- set(File) - Method in class com.marklogic.client.io.FileHandle
-
Assigns a file as the content.
- set(InputSource) - Method in class com.marklogic.client.io.InputSourceHandle
-
Assigns an input source as the content.
- set(InputStream) - Method in class com.marklogic.client.io.InputStreamHandle
-
Assigns an input stream as the content.
- set(C) - Method in class com.marklogic.client.io.JAXBHandle
-
Assigns the root object of the JAXB structure for the content.
- set(C) - Method in interface com.marklogic.client.io.marker.ContentHandle
-
Assigns the content.
- set(OutputStreamSender) - Method in class com.marklogic.client.io.OutputStreamHandle
-
Assigns an output stream sender providing the callback that writes
content to the database via an output stream.
- set(Reader) - Method in class com.marklogic.client.io.ReaderHandle
-
Assigns an character reader as the content.
- set(Source) - Method in class com.marklogic.client.io.SourceHandle
-
Assigns a transform source that produces the content.
- set(String) - Method in class com.marklogic.client.io.StringHandle
-
Assigns an string as the content.
- set(XMLEventReader) - Method in class com.marklogic.client.io.XMLEventReaderHandle
-
Assigns the event reader for the content.
- set(XMLStreamReader) - Method in class com.marklogic.client.io.XMLStreamReaderHandle
-
Assigns the stream reader for the content.
- setAdditionalQuery(Element) - Method in class com.marklogic.client.admin.config.QueryOptions
-
Deprecated.
- setAdditionalQuery(Element) - Method in class com.marklogic.client.io.QueryOptionsHandle
-
Deprecated.
Sets the ctsQuery element in the query options.
- setAggregate(QueryOptions.Aggregate) - Method in class com.marklogic.client.admin.config.QueryOptions.QueryTuples
-
Deprecated.
- setAggregate(QueryOptions.Aggregate) - Method in class com.marklogic.client.admin.config.QueryOptions.QueryValues
-
Deprecated.
- setAggregate(String...) - Method in interface com.marklogic.client.query.ValuesDefinition
-
Sets the name of the aggregate function to be applied as part of this values query.
- setAggregatePath(String) - Method in interface com.marklogic.client.query.ValuesDefinition
-
Sets the aggregate path.
- setAnchor(QueryOptions.QueryRange.ComputedBucket.AnchorValue) - Method in class com.marklogic.client.admin.config.QueryOptions.QueryRange.ComputedBucket
-
Deprecated.
Specifies a value for anchoring this computed bucket.
- setApply(String) - Method in class com.marklogic.client.admin.config.QueryOptions.Aggregate
-
Deprecated.
Sets the aggregate function name.
- setApply(QueryOptions.QueryGrammar.QueryJoiner.JoinerApply) - Method in class com.marklogic.client.admin.config.QueryOptions.QueryGrammar.QueryJoiner
-
Deprecated.
- setApply(String) - Method in class com.marklogic.client.admin.config.QueryOptions.QueryGrammar.QueryJoiner
-
Deprecated.
- setApply(QueryOptions.QueryGrammar.QueryStarter.StarterApply) - Method in class com.marklogic.client.admin.config.QueryOptions.QueryGrammar.QueryStarter
-
Deprecated.
- setApply(String) - Method in class com.marklogic.client.admin.config.QueryOptions.QueryGrammar.QueryStarter
-
Deprecated.
- setApply(String) - Method in class com.marklogic.client.admin.config.QueryOptions.QueryTransformResults
-
Deprecated.
- setApply(String) - Method in class com.marklogic.client.admin.config.QueryOptions.XQueryExtension
-
Deprecated.
- setAt(String) - Method in class com.marklogic.client.admin.config.QueryOptions.QueryTransformResults
-
Deprecated.
- setAt(String) - Method in class com.marklogic.client.admin.config.QueryOptions.XQueryExtension
-
Deprecated.
- setAttribute(QueryOptions.MarkLogicQName) - Method in class com.marklogic.client.admin.config.QueryOptions.BaseConstraintItem
-
Deprecated.
Sets an attribute QName to partially find an element-attribute index.
- setAttribute(QueryOptions.MarkLogicQName) - Method in class com.marklogic.client.admin.config.QueryOptions.QuerySortOrder
-
Deprecated.
- setAttribute(QueryOptions.MarkLogicQName) - Method in interface com.marklogic.client.admin.config.support.Indexed
-
- setAttribute(QName) - Method in interface com.marklogic.client.admin.config.support.IndexSpec
-
- setAttribute(QName) - Method in class com.marklogic.client.admin.config.support.IndexSpecImpl
-
- setAttribute(QName) - Method in interface com.marklogic.client.query.ElementLocator
-
Specifies the name of the attribute containing the value.
- setAttrName(String) - Method in class com.marklogic.client.admin.config.QueryOptions.AttributeOrElementValue
-
Deprecated.
- setAttrNs(String) - Method in class com.marklogic.client.admin.config.QueryOptions.AttributeOrElementValue
-
Deprecated.
- setAuthentication(DatabaseClientFactory.Authentication) - Method in class com.marklogic.client.DatabaseClientFactory.Bean
-
Specifies the authentication type for clients created with a
DatabaseClientFactory.Bean object.
- setAuthenticationValue(String) - Method in class com.marklogic.client.DatabaseClientFactory.Bean
-
Specifies the authentication type for clients created with a
DatabaseClientFactory.Bean object based on a string value.
- setBaseUri(URI) - Method in class com.marklogic.client.example.handle.URIHandle
-
- setBaseUri(String) - Method in class com.marklogic.client.example.handle.URIHandle
-
- setBatchSize(int) - Method in class com.marklogic.client.example.extension.OpenCSVBatcher
-
- setBuilder(SAXBuilder) - Method in class com.marklogic.client.extra.jdom.JDOMHandle
-
Specifies a JDOM structure builder for XML content.
- setBuilder(Builder) - Method in class com.marklogic.client.extra.xom.XOMHandle
-
Specifies a XOM structure builder for XML content.
- setByteLength(long) - Method in interface com.marklogic.client.document.ContentDescriptor
-
Specifies the length of the content in bytes or the UNKNOWN_LENGTH
constant if the length of the content is not known.
- setByteLength(long) - Method in class com.marklogic.client.io.BaseHandle
-
- setCapability(String) - Method in class com.marklogic.client.admin.ExtensionLibraryDescriptor.Permission
-
sets the capability for this permission
- setClient(HttpClient) - Method in class com.marklogic.client.example.handle.URIHandle
-
- setCollation(String) - Method in class com.marklogic.client.admin.config.QueryOptions.FacetableConstraintConfiguration
-
Deprecated.
Specifies the collation for the constraint.
- setCollation(String) - Method in class com.marklogic.client.admin.config.QueryOptions.QuerySortOrder
-
Deprecated.
- setCollation(String) - Method in class com.marklogic.client.admin.config.QueryOptions.WordLexicon
-
Deprecated.
- setCollation(String) - Method in interface com.marklogic.client.admin.config.support.RangeIndexed
-
- setCollation(String) - Method in class com.marklogic.client.admin.config.support.RangeIndexType
-
- setCollation(String) - Method in interface com.marklogic.client.admin.config.support.RangeSpec
-
- setCollection(QueryOptions.QueryCollection) - Method in class com.marklogic.client.admin.config.QueryOptions.QueryTuples
-
Deprecated.
- setCollection(QueryOptions.QueryCollection) - Method in class com.marklogic.client.admin.config.QueryOptions.QueryValues
-
Deprecated.
- setCollections(DocumentMetadataHandle.DocumentCollections) - Method in class com.marklogic.client.io.DocumentMetadataHandle
-
Locally assigns a container with document collections.
- setCollections(String...) - Method in interface com.marklogic.client.query.QueryDefinition
-
Sets the list of collections to which the query should be limited.
- setCompare(QueryOptions.QueryGrammar.QueryJoiner.Comparator) - Method in class com.marklogic.client.admin.config.QueryOptions.QueryGrammar.QueryJoiner
-
Deprecated.
- setConcurrencyLevel(Integer) - Method in class com.marklogic.client.admin.config.QueryOptions
-
Deprecated.
- setConcurrencyLevel(Integer) - Method in class com.marklogic.client.admin.config.support.QueryOptionsConfiguration
-
- setConcurrencyLevel(Integer) - Method in class com.marklogic.client.io.QueryOptionsHandle
-
Deprecated.
Sets the concurrency level in the query options.
- setConfiguration(CleanerProperties) - Method in class com.marklogic.client.example.handle.HTMLCleanerHandle
-
- setConstraints(List<QueryOptions.QueryConstraint>) - Method in class com.marklogic.client.admin.config.QueryOptions
-
Deprecated.
Sets the list of constraints, replacing existing ones.
- setConstraints(List<QueryOptions.QueryConstraint>) - Method in class com.marklogic.client.io.QueryOptionsHandle
-
Deprecated.
Set a List of constraints in the query options.
- setConsume(int) - Method in class com.marklogic.client.admin.config.QueryOptions.QueryGrammar.QueryJoiner
-
Deprecated.
- setContent(String) - Method in class com.marklogic.client.admin.config.QueryOptions.QueryRange.Bucket
-
Deprecated.
Specifies the textual label for the bucket.
- setContentMax(long) - Method in interface com.marklogic.client.util.RequestLogger
-
Controls how much content is copied to the log (defaulting to NO_CONTENT).
- setContentVersionRequests(ServerConfigurationManager.Policy) - Method in interface com.marklogic.client.admin.ServerConfigurationManager
-
- setContext(SSLContext) - Method in class com.marklogic.client.DatabaseClientFactory.Bean
-
Specifies the SSLContext for clients created with a
DatabaseClientFactory.Bean object that authenticate with SSL.
- setContext(HttpContext) - Method in class com.marklogic.client.example.handle.URIHandle
-
- setCriteria(String) - Method in interface com.marklogic.client.query.StringQueryDefinition
-
Sets the query criteria as a query string.
- setCursorPosition(Integer) - Method in interface com.marklogic.client.query.SuggestDefinition
-
Sets the cursor position to use in the suggest call.
- setDebug(Boolean) - Method in class com.marklogic.client.admin.config.QueryOptions.QueryState
-
Deprecated.
- setDebug(Boolean) - Method in class com.marklogic.client.admin.config.QueryOptions
-
Deprecated.
- setDebug(Boolean) - Method in class com.marklogic.client.admin.config.support.QueryOptionsConfiguration
-
- setDebug(Boolean) - Method in class com.marklogic.client.io.QueryOptionsHandle
-
Deprecated.
Sets the debug flag in the query options.
- setDefaultDocumentReadTransform(String) - Method in interface com.marklogic.client.admin.ServerConfigurationManager
-
Specifies the name of the default transform for reading documents.
- setDefaultDocumentReadTransformAll(Boolean) - Method in interface com.marklogic.client.admin.ServerConfigurationManager
-
Specifies whether the default transform for reading documents
applies to all users or only users with the rest-reader role.
- setDefaultNamespaceURI(String) - Method in class com.marklogic.client.util.EditableNamespaceContext
-
Specifies the namespace URI bound to the empty prefix.
- setDefaultSuggestionSource(QueryOptions.QueryDefaultSuggestionSource) - Method in class com.marklogic.client.admin.config.QueryOptions
-
Deprecated.
- setDefaultSuggestionSource(QueryOptions.QueryDefaultSuggestionSource) - Method in class com.marklogic.client.io.QueryOptionsHandle
-
Deprecated.
Sets the default suggestion source in the query options.
- setDefaultWriteSchema(Schema) - Method in class com.marklogic.client.io.InputSourceHandle
-
Specifies the default schema for validating the input source.
- setDelimiter(String) - Method in class com.marklogic.client.admin.config.QueryOptions.QueryGrammar.QueryStarter
-
Deprecated.
- setDescription(String) - Method in class com.marklogic.client.admin.ExtensionMetadata
-
Specifies the description of the extension.
- setDescription(String) - Method in class com.marklogic.client.alerting.RuleDefinition
-
Sets the description of the rule.
- setDescription(String) - Method in class com.marklogic.client.example.cookbook.JAXBDocument.Product
-
- setDirection(QueryOptions.QuerySortOrder.Direction) - Method in class com.marklogic.client.admin.config.QueryOptions.QuerySortOrder
-
Deprecated.
- setDirection(ValuesDefinition.Direction) - Method in interface com.marklogic.client.query.ValuesDefinition
-
Sets the direction of the results to use in this values query.
- setDirectory(String) - Method in interface com.marklogic.client.document.DocumentUriTemplate
-
Specifies the directory that should prefix the document uri.
- setDirectory(String) - Method in interface com.marklogic.client.query.QueryDefinition
-
Sets the directory to which the query should be limited.
- setDocumentRepair(XMLDocumentManager.DocumentRepair) - Method in interface com.marklogic.client.document.XMLDocumentManager
-
Specifies whether poorly formed XML documents written by the manager
should be repaired on the server.
- setDoFacets(boolean) - Method in class com.marklogic.client.admin.config.QueryOptions.FacetableConstraintConfiguration
-
Deprecated.
Specifies whether to configure this constraint for facets.
- setE(double) - Method in class com.marklogic.client.admin.config.QueryOptions.Heatmap
-
Deprecated.
Specifies the east longitude.
- setElement(QueryOptions.MarkLogicQName) - Method in class com.marklogic.client.admin.config.QueryOptions.BaseConstraintItem
-
Deprecated.
Sets an element QName to reference an element.
- setElement(String) - Method in class com.marklogic.client.admin.config.QueryOptions.QueryGrammar.QueryJoiner
-
Deprecated.
- setElement(String) - Method in class com.marklogic.client.admin.config.QueryOptions.QueryGrammar.QueryStarter
-
Deprecated.
- setElement(QueryOptions.MarkLogicQName) - Method in class com.marklogic.client.admin.config.QueryOptions.QuerySortOrder
-
Deprecated.
- setElement(QName) - Method in interface com.marklogic.client.admin.config.support.GeospatialSpec
-
- setElement(QueryOptions.MarkLogicQName) - Method in interface com.marklogic.client.admin.config.support.Indexed
-
- setElement(QName) - Method in interface com.marklogic.client.admin.config.support.IndexSpec
-
- setElement(QName) - Method in class com.marklogic.client.admin.config.support.IndexSpecImpl
-
- setElement(QName) - Method in interface com.marklogic.client.query.ElementLocator
-
Specifies the name of the element containing the attribute
(if also specified) or value.
- setElements(List<QueryOptions.MarkLogicQName>) - Method in class com.marklogic.client.admin.config.QueryOptions.PreferredElements
-
Deprecated.
- setElemName(String) - Method in class com.marklogic.client.admin.config.QueryOptions.AttributeOrElementValue
-
Deprecated.
- setElemNs(String) - Method in class com.marklogic.client.admin.config.QueryOptions.AttributeOrElementValue
-
Deprecated.
- setEmptyApply(QueryOptions.QueryTerm.TermApply) - Method in class com.marklogic.client.admin.config.QueryOptions.QueryTerm
-
Deprecated.
- setEnabled(boolean) - Method in interface com.marklogic.client.util.RequestLogger
-
Suspend or resume logging.
- setErrorFormat(Format) - Method in interface com.marklogic.client.admin.ServerConfigurationManager
-
Sets the serialization format of MarkLogic errors.
- setErrorHandler(ErrorHandler) - Method in class com.marklogic.client.io.InputSourceHandle
-
Specifies the error handler for errors discovered while parsing
the input source.
- setExtension(String) - Method in interface com.marklogic.client.document.DocumentUriTemplate
-
Specifies the extension that should suffix the document uri.
- setExtractMetadata(QueryOptions.QueryExtractMetadata) - Method in class com.marklogic.client.admin.config.QueryOptions
-
Deprecated.
- setExtractMetadata(QueryOptions.QueryExtractMetadata) - Method in class com.marklogic.client.io.QueryOptionsHandle
-
Deprecated.
Sets the extract metadata setting in the options node.
- setFacetOptions(List<String>) - Method in class com.marklogic.client.admin.config.QueryOptions.FacetableConstraintConfiguration
-
Deprecated.
Specifies the list of facet options.
- setFacetOptions(List<String>) - Method in class com.marklogic.client.admin.config.support.HeatmapAndOptions
-
- setFactory(DocumentBuilderFactory) - Method in class com.marklogic.client.io.DOMHandle
-
Specifies the factory for building DOM documents.
- setFactory(SAXParserFactory) - Method in class com.marklogic.client.io.InputSourceHandle
-
Specifies the factory for parsing SAX events.
- setFactory(XMLInputFactory) - Method in class com.marklogic.client.io.XMLEventReaderHandle
-
Specifies the factory for parsing StAX events.
- setFactory(XMLInputFactory) - Method in class com.marklogic.client.io.XMLStreamReaderHandle
-
Specifies the factory for parsing StAX streams.
- setField(QueryOptions.Field) - Method in class com.marklogic.client.admin.config.QueryOptions.BaseConstraintItem
-
Deprecated.
Sets a field to back this constraint source.
- setField(QueryOptions.Field) - Method in class com.marklogic.client.admin.config.QueryOptions.QuerySortOrder
-
Deprecated.
- setField(QueryOptions.Field) - Method in class com.marklogic.client.admin.config.QueryOptions.QueryValues
-
Deprecated.
- setField(QueryOptions.Field) - Method in interface com.marklogic.client.admin.config.support.Indexed
-
- setField(String) - Method in interface com.marklogic.client.admin.config.support.IndexSpec
-
- setField(String) - Method in class com.marklogic.client.admin.config.support.IndexSpecImpl
-
- setFinishFacet(QueryOptions.XQueryExtension) - Method in class com.marklogic.client.admin.config.QueryOptions.QueryCustom
-
Deprecated.
Specifies an XQuery function called to finish the facet.
- setForceDOM(boolean) - Method in class com.marklogic.client.io.SearchHandle
-
Deprecated.
- setForestName(String) - Method in interface com.marklogic.client.document.DocumentManager
-
Specifies the name of the forest that should store written documents.
- setForests(List<Long>) - Method in class com.marklogic.client.admin.config.QueryOptions
-
Deprecated.
- setForests(List<Long>) - Method in class com.marklogic.client.admin.config.support.QueryOptionsConfiguration
-
- setForests(List<Long>) - Method in class com.marklogic.client.io.QueryOptionsHandle
-
Deprecated.
Sets a List of forests constraints in the query options.
- setFormat(Format) - Method in interface com.marklogic.client.document.ContentDescriptor
-
Specifies the format of the content as binary, JSON, text, or XML.
- setFormat(Format) - Method in class com.marklogic.client.example.handle.HTMLCleanerHandle
-
- setFormat(Format) - Method in class com.marklogic.client.extra.dom4j.DOM4JHandle
-
Restricts the format to XML.
- setFormat(Format) - Method in class com.marklogic.client.extra.gson.GSONHandle
-
Restricts the format to JSON.
- setFormat(Format) - Method in class com.marklogic.client.extra.jackson.JacksonHandle
-
Restricts the format to JSON.
- setFormat(Format) - Method in class com.marklogic.client.extra.jdom.JDOMHandle
-
Restricts the format to XML.
- setFormat(Format) - Method in class com.marklogic.client.extra.xom.XOMHandle
-
Restricts the format to XML.
- setFormat(Format) - Method in class com.marklogic.client.io.BaseHandle
-
- setFormat(Format) - Method in class com.marklogic.client.io.DocumentMetadataHandle
-
Restricts the format used parsing and serializing the metadata.
- setFormat(Format) - Method in class com.marklogic.client.io.DOMHandle
-
Restricts the format to XML.
- setFormat(Format) - Method in class com.marklogic.client.io.InputSourceHandle
-
Restricts the format to XML.
- setFormat(Format) - Method in class com.marklogic.client.io.JAXBHandle
-
Restricts the format to XML.
- setFormat(Format) - Method in class com.marklogic.client.io.QueryOptionsHandle
-
Deprecated.
Set the format accepted by this handle.
- setFormat(Format) - Method in class com.marklogic.client.io.QueryOptionsListHandle
-
Sets the format associated with this handle.
- setFormat(Format) - Method in class com.marklogic.client.io.SearchHandle
-
Sets the format associated with this handle.
- setFormat(Format) - Method in class com.marklogic.client.io.SourceHandle
-
Restricts the format to XML.
- setFormat(Format) - Method in class com.marklogic.client.io.TuplesHandle
-
Sets the format associated with this handle.
- setFormat(Format) - Method in class com.marklogic.client.io.ValuesHandle
-
Sets the format associated with this handle.
- setFormat(Format) - Method in class com.marklogic.client.io.ValuesListHandle
-
Sets the format associated with this handle.
- setFormat(Format) - Method in class com.marklogic.client.io.XMLEventReaderHandle
-
Restricts the format to XML.
- setFormat(Format) - Method in class com.marklogic.client.io.XMLStreamReaderHandle
-
Restricts the format to XML.
- setFragmentScope(QueryOptions.FragmentScope) - Method in class com.marklogic.client.admin.config.QueryOptions.BaseConstraintItem
-
Deprecated.
Sets a fragment scope for this constraint source.
- setFragmentScope(QueryOptions.FragmentScope) - Method in class com.marklogic.client.admin.config.QueryOptions
-
Deprecated.
- setFragmentScope(QueryOptions.FragmentScope) - Method in class com.marklogic.client.admin.config.QueryOptions.WordLexicon
-
Deprecated.
- setFragmentScope(QueryOptions.FragmentScope) - Method in class com.marklogic.client.admin.config.support.QueryOptionsConfiguration
-
- setFragmentScope(QueryOptions.FragmentScope) - Method in class com.marklogic.client.io.QueryOptionsHandle
-
Deprecated.
Sets the fragment scope in the query options.
- setFrequency(ValuesDefinition.Frequency) - Method in interface com.marklogic.client.query.ValuesDefinition
-
Sets the frequency to be used in this values query.
- setGe(String) - Method in class com.marklogic.client.admin.config.QueryOptions.QueryRange.Bucket
-
Deprecated.
Specifies the low end of the bucket's range.
- setGe(String) - Method in class com.marklogic.client.admin.config.QueryOptions.QueryRange.ComputedBucket
-
Deprecated.
Specifies the low end of the bucket's range.
- setGeospatialIndexType(GeospatialIndexType) - Method in interface com.marklogic.client.admin.config.support.GeospatialSpec
-
- setGrammar(QueryOptions.QueryGrammar) - Method in class com.marklogic.client.admin.config.QueryOptions
-
Deprecated.
- setGrammar(QueryOptions.QueryGrammar) - Method in class com.marklogic.client.io.QueryOptionsHandle
-
Deprecated.
Sets the grammar in the query options.
- setHandle(StructureWriteHandle) - Method in interface com.marklogic.client.query.RawQueryDefinition
-
Specifies the handle for the JSON or XML representation of the query.
- setHandleRegistry(DatabaseClientFactory.HandleFactoryRegistry) - Method in class com.marklogic.client.io.SearchHandle
-
Makes the handle registry for this database client available
to this SearchHandle during processing of the search response.
- setHasHeader(boolean) - Method in class com.marklogic.client.example.extension.OpenCSVBatcher
-
- setHeatmap(QueryOptions.Heatmap) - Method in class com.marklogic.client.admin.config.support.HeatmapAndOptions
-
- setHost(String) - Method in class com.marklogic.client.DatabaseClientFactory.Bean
-
Specifies the host for clients created from a
DatabaseClientFactory.Bean object.
- setImplementation(T) - Method in class com.marklogic.client.admin.config.QueryOptions.QuerySuggestionSource
-
Deprecated.
- setImplicit(Element) - Method in class com.marklogic.client.admin.config.QueryOptions.QueryGrammar
-
Deprecated.
- setIndustry(String) - Method in class com.marklogic.client.example.cookbook.JAXBDocument.Product
-
- setJoiners(List<QueryOptions.QueryGrammar.QueryJoiner>) - Method in class com.marklogic.client.admin.config.QueryOptions.QueryGrammar
-
Deprecated.
- setJsonKey(QueryOptions.JsonKey) - Method in class com.marklogic.client.admin.config.QueryOptions.BaseConstraintItem
-
Deprecated.
Sets a json key index specification for this constraint source.
- setJsonKey(QueryOptions.JsonKey) - Method in class com.marklogic.client.admin.config.QueryOptions.QuerySortOrder
-
Deprecated.
- setJsonKey(QueryOptions.JsonKey) - Method in class com.marklogic.client.admin.config.QueryOptions.QueryValues
-
Deprecated.
- setJsonKey(QueryOptions.JsonKey) - Method in interface com.marklogic.client.admin.config.support.Indexed
-
- setJsonKey(String) - Method in interface com.marklogic.client.admin.config.support.IndexSpec
-
- setJsonKey(String) - Method in class com.marklogic.client.admin.config.support.IndexSpecImpl
-
- setKey(String) - Method in interface com.marklogic.client.query.KeyLocator
-
Specifies the JSON key.
- setLabel(String) - Method in class com.marklogic.client.admin.config.QueryOptions.QueryRange.ComputedBucket
-
Deprecated.
Specifies the textual label for the bucket.
- setLanguage(String) - Method in interface com.marklogic.client.document.JSONDocumentManager
-
Specifies the language code for JSON documents written by the manager.
- setLatdivs(int) - Method in class com.marklogic.client.admin.config.QueryOptions.Heatmap
-
Deprecated.
Specifies the number of latitudinal divisions.
- setLatitude(QName) - Method in interface com.marklogic.client.admin.config.support.GeospatialSpec
-
- setLimit(Integer) - Method in interface com.marklogic.client.query.SuggestDefinition
-
Sets a limit for a suggest call.
- setLondivs(int) - Method in class com.marklogic.client.admin.config.QueryOptions.Heatmap
-
Deprecated.
Specifies the number of longitudinal divisions.
- setLongitude(QName) - Method in interface com.marklogic.client.admin.config.support.GeospatialSpec
-
- setLt(String) - Method in class com.marklogic.client.admin.config.QueryOptions.QueryRange.Bucket
-
Deprecated.
Specifies the high end of the bucket's range.
- setLt(String) - Method in class com.marklogic.client.admin.config.QueryOptions.QueryRange.ComputedBucket
-
Deprecated.
Specifies the high end of the bucket's range.
- setMaxMatches(Integer) - Method in class com.marklogic.client.admin.config.QueryOptions.QueryTransformResults
-
Deprecated.
- setMaxSnippetChars(Integer) - Method in class com.marklogic.client.admin.config.QueryOptions.QueryTransformResults
-
Deprecated.
- setMetadata(RuleDefinition.RuleMetadata) - Method in class com.marklogic.client.alerting.RuleDefinition
-
Sets the metadata object for this rule.
- setMetadataCategories(Set<DocumentManager.Metadata>) - Method in interface com.marklogic.client.document.DocumentManager
-
Specifies the categories of metadata to read, write, or patch.
- setMetadataCategories(DocumentManager.Metadata...) - Method in interface com.marklogic.client.document.DocumentManager
-
Specifies the categories of metadata to read, write, or patch.
- setMetadataExtraction(BinaryDocumentManager.MetadataExtraction) - Method in interface com.marklogic.client.document.BinaryDocumentManager
-
Specifies the metadata extraction policy for binary documents.
- setMimetype(String) - Method in interface com.marklogic.client.document.ContentDescriptor
-
Specifies the mimetype of the content such as application/json,
text/plain, or application/xml.
- setMimetype(String) - Method in class com.marklogic.client.io.BaseHandle
-
- setN(double) - Method in class com.marklogic.client.admin.config.QueryOptions.Heatmap
-
Deprecated.
Specifies the north latitude.
- setName(String) - Method in class com.marklogic.client.admin.config.QueryOptions.Field
-
Deprecated.
Specifies the name of the field.
- setName(String) - Method in class com.marklogic.client.admin.config.QueryOptions.QueryConstraint
-
Deprecated.
Specifies the name of the constraint.
- setName(String) - Method in class com.marklogic.client.admin.config.QueryOptions.QueryElementQuery
-
Deprecated.
Specifies the local name of the element.
- setName(String) - Method in class com.marklogic.client.admin.config.QueryOptions.QueryOperator
-
Deprecated.
- setName(String) - Method in class com.marklogic.client.admin.config.QueryOptions.QueryRange.Bucket
-
Deprecated.
Specifies a unique name to reference this bucket.
- setName(String) - Method in class com.marklogic.client.admin.config.QueryOptions.QueryRange.ComputedBucket
-
Deprecated.
Specifies unique name to reference this bucket.
- setName(String) - Method in class com.marklogic.client.admin.config.QueryOptions.QueryState
-
Deprecated.
- setName(String) - Method in class com.marklogic.client.admin.config.QueryOptions.QueryTuples
-
Deprecated.
- setName(String) - Method in class com.marklogic.client.admin.config.QueryOptions.QueryValues
-
Deprecated.
- setName(String) - Method in class com.marklogic.client.alerting.RuleDefinition
-
Sets the name of the rule.
- setName(String) - Method in class com.marklogic.client.example.cookbook.JAXBDocument.Product
-
- setName(String) - Method in interface com.marklogic.client.query.ValuesDefinition
-
Sets the name of the values constraint.
- setNamespaceContext(NamespaceContext) - Method in interface com.marklogic.client.util.NameMap
-
Specifies a namespace context that declares the
namespace bindings used to convert prefixed string names
into QNames.
- setNamespaces(IterableNamespaceContext) - Method in interface com.marklogic.client.document.DocumentMetadataPatchBuilder
-
Declares the namespaces available for the paths
of a patch against XML documents.
- setNamespaces(IterableNamespaceContext) - Method in class com.marklogic.client.query.StructuredQueryBuilder
-
Specifies the namespace bindings used for the query.
- setNamespaceURI(String, String) - Method in class com.marklogic.client.util.EditableNamespaceContext
-
Specifies a binding between a prefix and a namespace URI.
- setNs(String) - Method in class com.marklogic.client.admin.config.QueryOptions.QueryElementQuery
-
Deprecated.
Specifies the namespace URI for the element.
- setNs(String) - Method in class com.marklogic.client.admin.config.QueryOptions.QueryTransformResults
-
Deprecated.
- setNs(String) - Method in class com.marklogic.client.admin.config.QueryOptions.XQueryExtension
-
Deprecated.
- setOperators(List<QueryOptions.QueryOperator>) - Method in class com.marklogic.client.admin.config.QueryOptions
-
Deprecated.
- setOperators(List<QueryOptions.QueryOperator>) - Method in class com.marklogic.client.io.QueryOptionsHandle
-
Deprecated.
Sets a List of operators in the query options.
- setOptions(String) - Method in class com.marklogic.client.admin.config.QueryOptions.QueryGrammar.QueryStarter
-
Deprecated.
- setOptionsName(String) - Method in class com.marklogic.client.io.ValuesListHandle
-
Sets the name of the query options to be used for this query.
- setOptionsName(String) - Method in interface com.marklogic.client.query.QueryDefinition
-
Sets the name of the query options to be used for this query.
- setOptionsName(String) - Method in interface com.marklogic.client.query.SuggestDefinition
-
Sets the name of the query options to be used for this query.
- setOptionsName(String) - Method in interface com.marklogic.client.query.ValuesDefinition
-
Set the name of the options node to use for this values query.
- setOptionsName(String) - Method in interface com.marklogic.client.query.ValuesListDefinition
-
Set the name of the options node to be used for this query.
- setOutputFormat(OutputFormat) - Method in class com.marklogic.client.extra.dom4j.DOM4JHandle
-
Specifies the dom4j output format for serializing XML content.
- setOutputter(XMLOutputter) - Method in class com.marklogic.client.extra.jdom.JDOMHandle
-
Specifies a JDOM serializer for XML content.
- setPageLength(Long) - Method in class com.marklogic.client.admin.config.QueryOptions
-
Deprecated.
- setPageLength(Long) - Method in class com.marklogic.client.admin.config.support.QueryOptionsConfiguration
-
- setPageLength(long) - Method in class com.marklogic.client.example.extension.SearchCollector
-
- setPageLength(Long) - Method in class com.marklogic.client.io.QueryOptionsHandle
-
Deprecated.
Sets the page length in the query options.
- setPageLength(long) - Method in interface com.marklogic.client.query.QueryManager
-
Specifies the maximum number of documents that can appear in any page of the query results,
overriding any maximum specified in the query options.
- setParent(QName) - Method in interface com.marklogic.client.admin.config.support.GeospatialSpec
-
- setParse(QueryOptions.XQueryExtension) - Method in class com.marklogic.client.admin.config.QueryOptions.QueryCustom
-
Deprecated.
Specifies an XQuery function called to implement the custom constraint.
- setParser(HtmlCleaner) - Method in class com.marklogic.client.example.handle.HTMLCleanerHandle
-
- setPassword(String) - Method in class com.marklogic.client.DatabaseClientFactory.Bean
-
Specifies the password authentication for clients created with a
DatabaseClientFactory.Bean object.
- setPath(QueryOptions.PathIndex) - Method in class com.marklogic.client.admin.config.QueryOptions.BaseConstraintItem
-
Deprecated.
Sets a path index specification for this constraint source.
- setPath(QueryOptions.PathIndex) - Method in class com.marklogic.client.admin.config.QueryOptions.QuerySortOrder
-
Deprecated.
- setPath(QueryOptions.PathIndex) - Method in interface com.marklogic.client.admin.config.support.Indexed
-
- setPath(String) - Method in class com.marklogic.client.admin.ExtensionLibraryDescriptor
-
Sets the path for this module descriptor.
- setPathIndex(QueryOptions.PathIndex) - Method in interface com.marklogic.client.admin.config.support.IndexSpec
-
- setPathIndex(QueryOptions.PathIndex) - Method in class com.marklogic.client.admin.config.support.IndexSpecImpl
-
- setPerMatchTokens(Integer) - Method in class com.marklogic.client.admin.config.QueryOptions.QueryTransformResults
-
Deprecated.
- setPermissions(DocumentMetadataHandle.DocumentPermissions) - Method in class com.marklogic.client.io.DocumentMetadataHandle
-
Locally assigns a container with document permissions.
- setPort(int) - Method in class com.marklogic.client.DatabaseClientFactory.Bean
-
Specifies the port for clients created with a
DatabaseClientFactory.Bean object.
- setPreferredElements(List<QueryOptions.MarkLogicQName>) - Method in class com.marklogic.client.admin.config.QueryOptions.QueryTransformResults
-
Deprecated.
- setPrefix(String) - Method in class com.marklogic.client.admin.config.QueryOptions.QueryCollection
-
Deprecated.
Set the collectionOption prefix, returning the modified
CollectionOption object.
- setProperties(DocumentMetadataHandle.DocumentProperties) - Method in class com.marklogic.client.io.DocumentMetadataHandle
-
Locally assigns a container with document properties.
- setProvider(String) - Method in class com.marklogic.client.admin.ExtensionMetadata
-
Specifies the name of the organization providing the extension.
- setQuality(int) - Method in interface com.marklogic.client.document.DocumentMetadataPatchBuilder
-
Sets the search quality of the document.
- setQuality(int) - Method in class com.marklogic.client.io.DocumentMetadataHandle
-
Specifies the quality of the document, which affects search weighting.
- setQualityWeight(Double) - Method in class com.marklogic.client.admin.config.QueryOptions
-
Deprecated.
- setQualityWeight(Double) - Method in class com.marklogic.client.io.QueryOptionsHandle
-
Deprecated.
Sets the quality weight in the search options.
- setQueryCriteria(QueryDefinition) - Method in class com.marklogic.client.io.SearchHandle
-
Sets the query definition used in the search.
- setQueryCriteria(ValuesDefinition) - Method in class com.marklogic.client.io.TuplesHandle
-
Specifies the tuples query definition used to identify this set of tuples.
- setQueryCriteria(ValuesDefinition) - Method in class com.marklogic.client.io.ValuesHandle
-
Sets the query definition used when retrieving values.
- setQueryDefinition(ValueQueryDefinition) - Method in interface com.marklogic.client.query.ValuesDefinition
-
Set the query definition associated with this values query.
- setQueryOptionValidation(Boolean) - Method in interface com.marklogic.client.admin.ServerConfigurationManager
-
Specifies whether the server validates query options before storing them.
- setQueryStrings(String...) - Method in interface com.marklogic.client.query.SuggestDefinition
-
Sets zero or more search strings to AND with the suggestion call.
- setQueryTuples(List<QueryOptions.QueryTuples>) - Method in class com.marklogic.client.admin.config.QueryOptions
-
Deprecated.
- setQueryValidation(Boolean) - Method in interface com.marklogic.client.admin.ServerConfigurationManager
-
Specifies whether the server validates queries before running them.
- setQueryValues(List<QueryOptions.QueryValues>) - Method in class com.marklogic.client.admin.config.QueryOptions
-
Deprecated.
- setQuotation(String) - Method in class com.marklogic.client.admin.config.QueryOptions.QueryGrammar
-
Deprecated.
- setRange(QueryOptions.QueryRange) - Method in class com.marklogic.client.admin.config.QueryOptions.QueryValues
-
Deprecated.
- setReader(SAXReader) - Method in class com.marklogic.client.extra.dom4j.DOM4JHandle
-
Specifies a dom4j reader for XML content.
- setReadTransform(ServerTransform) - Method in interface com.marklogic.client.document.DocumentManager
-
Specifies a transform for read requests that don't specify a transform.
- setRef(String) - Method in class com.marklogic.client.admin.config.QueryOptions.ConstraintValue
-
Deprecated.
- setRef(String) - Method in class com.marklogic.client.admin.config.QueryOptions.DefaultTermSource
-
Deprecated.
- setRef(String) - Method in class com.marklogic.client.admin.config.QueryOptions.QuerySuggestionSource
-
Deprecated.
- setRef(String) - Method in class com.marklogic.client.admin.config.QueryOptions.QueryTerm
-
Deprecated.
- setResendable(boolean) - Method in class com.marklogic.client.io.OutputStreamHandle
-
Specifies whether the content can be resent to the output stream
if the request must be retried.
- setResolver(LSResourceResolver) - Method in class com.marklogic.client.io.DOMHandle
-
Specifies the resolver for resolving references while parsing the document.
- setResolver(EntityResolver) - Method in class com.marklogic.client.io.InputSourceHandle
-
Specifies the resolver for resolving references while parsing
the input source.
- setResolver(XMLResolver) - Method in class com.marklogic.client.io.XMLEventReaderHandle
-
Specifies the resolver for resolving references while parsing
the event reader source.
- setResolver(XMLResolver) - Method in class com.marklogic.client.io.XMLStreamReaderHandle
-
Specifies the resolver for resolving references while parsing
the event reader source.
- setResponseTransform(ServerTransform) - Method in interface com.marklogic.client.query.QueryDefinition
-
Specifies a transform that modifies responses to this query
on the server.
- setReturnAggregates(Boolean) - Method in class com.marklogic.client.admin.config.QueryOptions
-
Deprecated.
- setReturnAggregates(Boolean) - Method in class com.marklogic.client.admin.config.support.QueryOptionsConfiguration
-
- setReturnAggregates(Boolean) - Method in class com.marklogic.client.io.QueryOptionsHandle
-
Deprecated.
Sets the return aggregates option in the query options.
- setReturnConstraints(Boolean) - Method in class com.marklogic.client.admin.config.QueryOptions
-
Deprecated.
- setReturnConstraints(Boolean) - Method in class com.marklogic.client.admin.config.support.QueryOptionsConfiguration
-
- setReturnConstraints(Boolean) - Method in class com.marklogic.client.io.QueryOptionsHandle
-
Deprecated.
Sets the return constraints option in the query options.
- setReturnFacets(Boolean) - Method in class com.marklogic.client.admin.config.QueryOptions
-
Deprecated.
- setReturnFacets(Boolean) - Method in class com.marklogic.client.admin.config.support.QueryOptionsConfiguration
-
- setReturnFacets(Boolean) - Method in class com.marklogic.client.io.QueryOptionsHandle
-
Deprecated.
Sets the return facets option in the query options.
- setReturnFrequencies(Boolean) - Method in class com.marklogic.client.admin.config.QueryOptions
-
Deprecated.
- setReturnFrequencies(Boolean) - Method in class com.marklogic.client.admin.config.support.QueryOptionsConfiguration
-
- setReturnFrequencies(Boolean) - Method in class com.marklogic.client.io.QueryOptionsHandle
-
Deprecated.
Sets the return frequencies option in the query options.
- setReturnMetrics(Boolean) - Method in class com.marklogic.client.admin.config.QueryOptions
-
Deprecated.
- setReturnMetrics(Boolean) - Method in class com.marklogic.client.admin.config.support.QueryOptionsConfiguration
-
- setReturnMetrics(Boolean) - Method in class com.marklogic.client.io.QueryOptionsHandle
-
Deprecated.
Sets the return metric option in the query options.
- setReturnPlan(Boolean) - Method in class com.marklogic.client.admin.config.QueryOptions
-
Deprecated.
- setReturnPlan(Boolean) - Method in class com.marklogic.client.admin.config.support.QueryOptionsConfiguration
-
- setReturnPlan(Boolean) - Method in class com.marklogic.client.io.QueryOptionsHandle
-
Deprecated.
Sets the return query plan option in the query options.
- setReturnQtext(Boolean) - Method in class com.marklogic.client.admin.config.QueryOptions
-
Deprecated.
- setReturnQtext(Boolean) - Method in class com.marklogic.client.admin.config.support.QueryOptionsConfiguration
-
- setReturnQtext(Boolean) - Method in class com.marklogic.client.io.QueryOptionsHandle
-
Deprecated.
Sets the return query text option in the query options.
- setReturnQuery(Boolean) - Method in class com.marklogic.client.admin.config.QueryOptions
-
Deprecated.
- setReturnQuery(Boolean) - Method in class com.marklogic.client.admin.config.support.QueryOptionsConfiguration
-
- setReturnQuery(Boolean) - Method in class com.marklogic.client.io.QueryOptionsHandle
-
Deprecated.
Sets the return query option in the query options.
- setReturnResults(Boolean) - Method in class com.marklogic.client.admin.config.QueryOptions
-
Deprecated.
- setReturnResults(Boolean) - Method in class com.marklogic.client.admin.config.support.QueryOptionsConfiguration
-
- setReturnResults(Boolean) - Method in class com.marklogic.client.io.QueryOptionsHandle
-
Deprecated.
Sets the return results option in the query options.
- setReturnSimilar(Boolean) - Method in class com.marklogic.client.admin.config.QueryOptions
-
Deprecated.
- setReturnSimilar(Boolean) - Method in class com.marklogic.client.admin.config.support.QueryOptionsConfiguration
-
- setReturnSimilar(Boolean) - Method in class com.marklogic.client.io.QueryOptionsHandle
-
Deprecated.
Sets the return similar option in the query options.
- setReturnValues(Boolean) - Method in class com.marklogic.client.admin.config.QueryOptions
-
Deprecated.
- setReturnValues(Boolean) - Method in class com.marklogic.client.admin.config.support.QueryOptionsConfiguration
-
- setReturnValues(Boolean) - Method in class com.marklogic.client.io.QueryOptionsHandle
-
Deprecated.
Sets the return values option in the query options.
- setRoleName(String) - Method in class com.marklogic.client.admin.ExtensionLibraryDescriptor.Permission
-
sets the role name for this permission
- setRulesProvider(ITagInfoProvider) - Method in class com.marklogic.client.example.handle.HTMLCleanerHandle
-
- setS(double) - Method in class com.marklogic.client.admin.config.QueryOptions.Heatmap
-
Deprecated.
Specifies the south latitude.
- setScore() - Method in class com.marklogic.client.admin.config.QueryOptions.QuerySortOrder
-
Deprecated.
- setSearchableExpression(QueryOptions.QuerySearchableExpression) - Method in class com.marklogic.client.admin.config.QueryOptions
-
Deprecated.
- setSearchableExpression(String) - Method in class com.marklogic.client.io.QueryOptionsHandle
-
Deprecated.
Sets the searchable expression in the query options.
- setSearchableExpressionNamespaceContext(QueryOptions.ExpressionNamespaceBinding[]) - Method in class com.marklogic.client.admin.config.QueryOptions
-
Deprecated.
- setSearchableExpressionNamespaceContext(EditableNamespaceContext) - Method in class com.marklogic.client.admin.config.QueryOptions
-
Deprecated.
- setSearchableExpressionNamespaceContext(EditableNamespaceContext) - Method in class com.marklogic.client.io.QueryOptionsHandle
-
Deprecated.
Sets the namespace context to be associated with the searchable expression.
- setSearchOptions(List<String>) - Method in class com.marklogic.client.admin.config.QueryOptions
-
Deprecated.
- setSearchOptions(List<String>) - Method in class com.marklogic.client.admin.config.support.QueryOptionsConfiguration
-
- setSearchOptions(List<String>) - Method in class com.marklogic.client.io.QueryOptionsHandle
-
Deprecated.
Set a List of search options in the query options.
- setSerializer(XmlSerializer) - Method in class com.marklogic.client.example.handle.HTMLCleanerHandle
-
- setServerRequestLogging(Boolean) - Method in interface com.marklogic.client.admin.ServerConfigurationManager
-
Specifies whether the server logs requests to the error log on the server.
- setSortOrders(List<QueryOptions.QuerySortOrder>) - Method in class com.marklogic.client.admin.config.QueryOptions
-
Deprecated.
- setSortOrders(List<QueryOptions.QuerySortOrder>) - Method in class com.marklogic.client.io.QueryOptionsHandle
-
Deprecated.
Set a List of sort orders in the query options.
- setSource(TermSource) - Method in class com.marklogic.client.admin.config.QueryOptions.DefaultTermSource
-
Deprecated.
- setSource(ConstraintSource) - Method in class com.marklogic.client.admin.config.QueryOptions.QueryConstraint
-
Deprecated.
Specifies the constrained index.
- setSource(TermSource) - Method in class com.marklogic.client.admin.config.QueryOptions.QueryTerm
-
Deprecated.
Sets the source of data that backs default (unprefixed) search terms.
- setStarters(List<QueryOptions.QueryGrammar.QueryStarter>) - Method in class com.marklogic.client.admin.config.QueryOptions.QueryGrammar
-
Deprecated.
- setStarterText(String) - Method in class com.marklogic.client.admin.config.QueryOptions.QueryGrammar.QueryStarter
-
Deprecated.
- setStartFacet(QueryOptions.XQueryExtension) - Method in class com.marklogic.client.admin.config.QueryOptions.QueryCustom
-
Deprecated.
Specifies an XQuery function called to start the facet.
- setStrength(int) - Method in class com.marklogic.client.admin.config.QueryOptions.QueryGrammar.QueryJoiner
-
Deprecated.
- setStrength(int) - Method in class com.marklogic.client.admin.config.QueryOptions.QueryGrammar.QueryStarter
-
Deprecated.
- setStringCriteria(String) - Method in interface com.marklogic.client.query.SuggestDefinition
-
Sets one or more criteria for the suggestion call.
- setSuggestionSources(List<QueryOptions.QuerySuggestionSource>) - Method in class com.marklogic.client.admin.config.QueryOptions
-
Deprecated.
- setSuggestionSources(List<QueryOptions.QuerySuggestionSource>) - Method in class com.marklogic.client.io.QueryOptionsHandle
-
Deprecated.
Set a List of suggestion sources in the query options.
- setTerm(QueryOptions.QueryTerm) - Method in class com.marklogic.client.admin.config.QueryOptions
-
Deprecated.
- setTerm(QueryOptions.QueryTerm) - Method in class com.marklogic.client.io.QueryOptionsHandle
-
Deprecated.
Set the term configuration in the query options.
- setTermFunction(QueryOptions.XQueryExtension) - Method in class com.marklogic.client.admin.config.QueryOptions.QueryTerm
-
Deprecated.
- setTermOptions(List<String>) - Method in class com.marklogic.client.admin.config.QueryOptions.BaseConstraintItem
-
Deprecated.
Sets the term options for this constraint source.
- setTermOptions(List<String>) - Method in class com.marklogic.client.admin.config.QueryOptions.QueryTerm
-
Deprecated.
- setTermOptions(List<String>) - Method in interface com.marklogic.client.admin.config.support.TermOptions
-
- setTitle(String) - Method in class com.marklogic.client.admin.ExtensionMetadata
-
Specifies the title of the extension.
- setTokenize(QueryOptions.QueryGrammar.Tokenize) - Method in class com.marklogic.client.admin.config.QueryOptions.QueryGrammar.QueryJoiner
-
Deprecated.
- setTokenize(String) - Method in class com.marklogic.client.admin.config.QueryOptions.QueryGrammar.QueryStarter
-
Deprecated.
- setTransformer(Transformer) - Method in class com.marklogic.client.io.SourceHandle
-
Specifies a transformer for modifying the content.
- setTransformResults(QueryOptions.QueryTransformResults) - Method in class com.marklogic.client.admin.config.QueryOptions
-
Deprecated.
- setTransformResults(QueryOptions.QueryTransformResults) - Method in class com.marklogic.client.io.QueryOptionsHandle
-
Deprecated.
Set the transform results in the query options.
- setTuples(List<QueryOptions.QueryTuples>) - Method in class com.marklogic.client.io.QueryOptionsHandle
-
Deprecated.
Sets a List of tuples in the query options.
- setType(String) - Method in class com.marklogic.client.admin.config.QueryOptions.FacetableConstraintConfiguration
-
Deprecated.
Specifies the datatype for the constraint.
- setType(String) - Method in class com.marklogic.client.admin.config.QueryOptions.QuerySortOrder
-
Deprecated.
- setType(String) - Method in interface com.marklogic.client.admin.config.support.RangeIndexed
-
- setType(String) - Method in interface com.marklogic.client.admin.config.support.RangeSpec
-
- setUdf(String) - Method in class com.marklogic.client.admin.config.QueryOptions.Aggregate
-
Deprecated.
Sets the user-defined function plugin.
- setUpdatePolicy(ServerConfigurationManager.UpdatePolicy) - Method in interface com.marklogic.client.admin.ServerConfigurationManager
-
Specifies the policy for updating or deleting documents in the database.
- setUpExample(XMLDocumentManager, String, String) - Static method in class com.marklogic.client.example.cookbook.DocumentDelete
-
- setUpExample(XMLDocumentManager, String, String) - Static method in class com.marklogic.client.example.cookbook.DocumentMetadataRead
-
- setUpExample(DatabaseClient) - Static method in class com.marklogic.client.example.cookbook.DocumentRead
-
- setUpExample(DatabaseClient, String, String) - Static method in class com.marklogic.client.example.cookbook.DocumentReadTransform
-
- setUpExample(DatabaseClient) - Static method in class com.marklogic.client.example.cookbook.KeyValueSearch
-
- setUpExample(XMLDocumentManager, String, String) - Static method in class com.marklogic.client.example.cookbook.MultiStatementTransaction
-
- setUpExample(DatabaseClient) - Static method in class com.marklogic.client.example.cookbook.RawClientAlert
-
- setUpExample(DatabaseClient) - Static method in class com.marklogic.client.example.cookbook.RawCombinedSearch
-
- setUpExample(DatabaseClient) - Static method in class com.marklogic.client.example.cookbook.SearchResponseTransform
-
- setUpExample(DatabaseClient) - Static method in class com.marklogic.client.example.cookbook.StringSearch
-
- setUpExample(DatabaseClient) - Static method in class com.marklogic.client.example.cookbook.StructuredSearch
-
- setUpExample(DatabaseClient) - Static method in class com.marklogic.client.example.cookbook.Suggest
-
- setUpExample(DatabaseClient) - Static method in class com.marklogic.client.example.extension.BatchManagerExample
-
- setUpExample(DatabaseClient) - Static method in class com.marklogic.client.example.extension.SearchCollectorExample
-
- setUpExample(XMLDocumentManager, String, String) - Static method in class com.marklogic.client.example.handle.URIHandleExample
-
- setUri() - Method in class com.marklogic.client.admin.config.QueryOptions.QueryTuples
-
Deprecated.
- setUri() - Method in class com.marklogic.client.admin.config.QueryOptions.QueryValues
-
Deprecated.
- setUri(String) - Method in interface com.marklogic.client.document.DocumentDescriptor
-
Specifies the URI identifier for a database document.
- setUsePut(boolean) - Method in class com.marklogic.client.example.handle.URIHandle
-
- setUser(String) - Method in class com.marklogic.client.DatabaseClientFactory.Bean
-
Specifies the user authentication for clients created with a
DatabaseClientFactory.Bean object.
- setValues(List<QueryOptions.QueryValues>) - Method in class com.marklogic.client.io.QueryOptionsHandle
-
Deprecated.
Sets a List of values in the query options.
- setValuesOptions(List<String>) - Method in class com.marklogic.client.admin.config.QueryOptions.QueryTuples
-
Deprecated.
- setValuesOptions(List<String>) - Method in class com.marklogic.client.admin.config.QueryOptions.QueryValues
-
Deprecated.
- setVerifier(DatabaseClientFactory.SSLHostnameVerifier) - Method in class com.marklogic.client.DatabaseClientFactory.Bean
-
Specifies the host verifier for clients created with a
DatabaseClientFactory.Bean object that verify hosts for
additional security.
- setVersion(String) - Method in class com.marklogic.client.admin.ExtensionMetadata
-
Specifies the version identifier for the extension implementation.
- setVersion(long) - Method in interface com.marklogic.client.document.DocumentDescriptor
-
Specifies the document version.
- setView(QueryManager.QueryView) - Method in interface com.marklogic.client.query.QueryManager
-
Specifies the type of view results produced by queries.
- setView(String) - Method in interface com.marklogic.client.query.ValuesDefinition
-
Sets the view for this values query.
- setW(double) - Method in class com.marklogic.client.admin.config.QueryOptions.Heatmap
-
Deprecated.
Specifies the west longitude.
- setWeight(Double) - Method in class com.marklogic.client.admin.config.QueryOptions.BaseConstraintItem
-
Deprecated.
Sets the relative weight for this constraint source.
- setWeight(Double) - Method in class com.marklogic.client.admin.config.QueryOptions.QueryTerm
-
Deprecated.
- setWeight(Double) - Method in interface com.marklogic.client.admin.config.support.TermOptions
-
- setWordLexicon(QueryOptions.WordLexicon) - Method in class com.marklogic.client.admin.config.QueryOptions.QuerySuggestionSource
-
Deprecated.
- setWriteTransform(ServerTransform) - Method in interface com.marklogic.client.document.DocumentManager
-
Specifies a transform for write requests that don't specify a transform.
- setXPathProcessor(XPath) - Method in class com.marklogic.client.io.DOMHandle
-
Specifies the processor used to evaluate XPath expressions against
the document.
- size() - Method in class com.marklogic.client.alerting.RuleDefinitionList
-
gets the number of rules in the list.
- size() - Method in class com.marklogic.client.util.EditableNamespaceContext
-
Returns the number of namespace bindings.
- size() - Method in class com.marklogic.client.util.RequestParameters
-
Returns the number of request parameters.
- snippetTransform(Integer, Integer, Integer, QName...) - Method in class com.marklogic.client.admin.config.QueryOptionsBuilder
-
Deprecated.
Configures the way default snippets look in search results.
- sortByScore(QueryOptions.QuerySortOrder.Direction) - Method in class com.marklogic.client.admin.config.QueryOptionsBuilder
-
Deprecated.
Builds a QuerySortOrder for sorting by search relevance score, and a
Direction.
- sortOrder(TermSpec) - Method in class com.marklogic.client.admin.config.QueryOptionsBuilder
-
Deprecated.
Builds a QuerySortOrder configuration from a TermSpec.
- sortOrder(RangeSpec, QueryOptions.QuerySortOrder.Direction) - Method in class com.marklogic.client.admin.config.QueryOptionsBuilder
-
Deprecated.
Builds a QuerySortOrder configuration from a RangeSpec, and a Direction.
- sortOrders(QueryOptions.QuerySortOrder...) - Method in class com.marklogic.client.admin.config.QueryOptionsBuilder
-
Deprecated.
Builds a list of sort orders.
- SourceHandle - Class in com.marklogic.client.io
-
A Source Handle represents XML content as a transform source for reading
or transforms a source into a result for writing.
- SourceHandle() - Constructor for class com.marklogic.client.io.SourceHandle
-
Zero-argument constructor.
- SourceHandle(Source) - Constructor for class com.marklogic.client.io.SourceHandle
-
Initializes the handle with a transform source for the content.
- SPARQLManager - Class in com.marklogic.client.example.extension
-
- SPARQLManager(DatabaseClient) - Constructor for class com.marklogic.client.example.extension.SPARQLManager
-
- split(XMLWriteHandle) - Method in class com.marklogic.client.example.extension.DocumentSplitter
-
- SSLClientCreator - Class in com.marklogic.client.example.cookbook
-
SSLClientCreator illustrates the basic approach for creating a client using SSL for database access.
- SSLClientCreator() - Constructor for class com.marklogic.client.example.cookbook.SSLClientCreator
-
- START - Static variable in interface com.marklogic.client.query.QueryManager
-
The offset of the first result in the default page.
- starterGrouping(String, int, String) - Method in class com.marklogic.client.admin.config.QueryOptionsBuilder
-
Deprecated.
Builds a starter used for grouping terms.
- starterPrefix(String, int, String) - Method in class com.marklogic.client.admin.config.QueryOptionsBuilder
-
Deprecated.
Builds a starter used for prefixing terms.
- starters(QueryOptions.QueryGrammar.QueryStarter...) - Method in class com.marklogic.client.admin.config.QueryOptionsBuilder
-
Deprecated.
Builds a list of starters for use in grammars.
- startLogging(RequestLogger) - Method in interface com.marklogic.client.admin.NamespacesManager
-
Starts debugging client requests.
- startLogging(RequestLogger) - Method in interface com.marklogic.client.admin.ResourceExtensionsManager
-
Starts debugging client requests.
- startLogging(RequestLogger) - Method in interface com.marklogic.client.admin.TransformExtensionsManager
-
Starts debugging client requests.
- startLogging(RequestLogger) - Method in interface com.marklogic.client.document.DocumentManager
-
Starts debugging client requests.
- startLogging(RequestLogger) - Method in class com.marklogic.client.extensions.ResourceManager
-
Starts debugging client requests.
- startLogging(RequestLogger) - Method in interface com.marklogic.client.extensions.ResourceServices
-
Starts debugging client requests.
- startLogging(RequestLogger) - Method in interface com.marklogic.client.query.QueryManager
-
Starts debugging client requests.
- state(String) - Method in class com.marklogic.client.admin.config.QueryOptionsBuilder
-
Deprecated.
Builds an empty QueryState object with the provided name.
- stopLogging() - Method in interface com.marklogic.client.admin.NamespacesManager
-
Stops debugging client requests.
- stopLogging() - Method in interface com.marklogic.client.admin.ResourceExtensionsManager
-
Stops debugging client requests.
- stopLogging() - Method in interface com.marklogic.client.admin.TransformExtensionsManager
-
Stops debugging client requests.
- stopLogging() - Method in interface com.marklogic.client.document.DocumentManager
-
Stops debugging client requests.
- stopLogging() - Method in class com.marklogic.client.extensions.ResourceManager
-
Stops debugging client requests.
- stopLogging() - Method in interface com.marklogic.client.extensions.ResourceServices
-
Stops debugging client requests.
- stopLogging() - Method in interface com.marklogic.client.query.QueryManager
-
Stops debugging client requests.
- STRICT - Static variable in interface com.marklogic.client.DatabaseClientFactory.SSLHostnameVerifier
-
The STRICT SSLHostnameVerifier applies strict rules
for checking hostnames during SSL authentication (similar
to org.apache.http.conn.ssl.StrictHostnameVerifier).
- StringHandle - Class in com.marklogic.client.io
-
A String Handle represents document content as a string for reading or writing.
- StringHandle() - Constructor for class com.marklogic.client.io.StringHandle
-
Zero-argument constructor.
- StringHandle(String) - Constructor for class com.marklogic.client.io.StringHandle
-
Initializes the handle with a string for the content.
- StringQueryDefinition - Interface in com.marklogic.client.query
-
A StringQueryDefinition represents the criteria associated with a simple string query.
- stringRangeType(String) - Method in class com.marklogic.client.admin.config.QueryOptionsBuilder
-
Deprecated.
Builds a range index type for strings.
- StringSearch - Class in com.marklogic.client.example.cookbook
-
StringSearch illustrates searching for documents and iterating over results
with string criteria referencing a constraint defined by options.
- StringSearch() - Constructor for class com.marklogic.client.example.cookbook.StringSearch
-
- StructuredQueryBuilder - Class in com.marklogic.client.query
-
StructuredQueryBuilder builds a query for documents in the database.
- StructuredQueryBuilder() - Constructor for class com.marklogic.client.query.StructuredQueryBuilder
-
Zero-argument constructor.
- StructuredQueryBuilder(String) - Constructor for class com.marklogic.client.query.StructuredQueryBuilder
-
Constructs a query builder for queries against the options
persisted with the specified name.
- StructuredQueryBuilder(IterableNamespaceContext) - Constructor for class com.marklogic.client.query.StructuredQueryBuilder
-
Constructs a query builder for queries using the specified
namespace bindings.
- StructuredQueryBuilder(String, IterableNamespaceContext) - Constructor for class com.marklogic.client.query.StructuredQueryBuilder
-
Constructs a query builder for queries against the options
persisted with the specified name using the specified
namespace bindings.
- StructuredQueryBuilder.AndNotQuery - Class in com.marklogic.client.query
-
- StructuredQueryBuilder.AndNotQuery(StructuredQueryDefinition, StructuredQueryDefinition) - Constructor for class com.marklogic.client.query.StructuredQueryBuilder.AndNotQuery
-
Deprecated.
Use the andNot() builder method of StructuredQueryBuilder
and type the object as an instance of the StructuredQueryDefinition interface.
- StructuredQueryBuilder.AndQuery - Class in com.marklogic.client.query
-
- StructuredQueryBuilder.AndQuery(StructuredQueryDefinition...) - Constructor for class com.marklogic.client.query.StructuredQueryBuilder.AndQuery
-
Deprecated.
Use the and() builder method of StructuredQueryBuilder
and type the object as an instance of the StructuredQueryDefinition interface.
- StructuredQueryBuilder.Attribute - Interface in com.marklogic.client.query
-
An Attribute represents an attribute in database documents.
- StructuredQueryBuilder.Box - Class in com.marklogic.client.query
-
Deprecated.
Use the Region interface as the type for instances of Box.
- StructuredQueryBuilder.Box(double, double, double, double) - Constructor for class com.marklogic.client.query.StructuredQueryBuilder.Box
-
Deprecated.
Use the box() builder method of StructuredQueryBuilder
and type the object as an instance of the Region interface.
- StructuredQueryBuilder.Circle - Class in com.marklogic.client.query
-
Deprecated.
Use the Region interface as the type for instances of Circle.
- StructuredQueryBuilder.Circle(double, double, double) - Constructor for class com.marklogic.client.query.StructuredQueryBuilder.Circle
-
Deprecated.
Use the circle() builder method of StructuredQueryBuilder
and type the object as an instance of the Region interface.
- StructuredQueryBuilder.CollectionConstraintQuery - Class in com.marklogic.client.query
-
- StructuredQueryBuilder.CollectionConstraintQuery(String, String...) - Constructor for class com.marklogic.client.query.StructuredQueryBuilder.CollectionConstraintQuery
-
Deprecated.
Use the collectionConstraint() builder method of StructuredQueryBuilder
and type the object as an instance of the StructuredQueryDefinition interface.
- StructuredQueryBuilder.CollectionQuery - Class in com.marklogic.client.query
-
- StructuredQueryBuilder.CollectionQuery(String...) - Constructor for class com.marklogic.client.query.StructuredQueryBuilder.CollectionQuery
-
Deprecated.
Use the collection() builder method of StructuredQueryBuilder
and type the object as an instance of the StructuredQueryDefinition interface.
- StructuredQueryBuilder.ContainerIndex - Interface in com.marklogic.client.query
-
A ContainerIndex can be used for container queries.
- StructuredQueryBuilder.CustomConstraintQuery - Class in com.marklogic.client.query
-
- StructuredQueryBuilder.CustomConstraintQuery(String, String...) - Constructor for class com.marklogic.client.query.StructuredQueryBuilder.CustomConstraintQuery
-
Deprecated.
Use the customConstraint() builder method of StructuredQueryBuilder
and type the object as an instance of the StructuredQueryDefinition interface.
- StructuredQueryBuilder.DirectoryQuery - Class in com.marklogic.client.query
-
- StructuredQueryBuilder.DirectoryQuery(Boolean, String...) - Constructor for class com.marklogic.client.query.StructuredQueryBuilder.DirectoryQuery
-
Deprecated.
Use the directory() builder method of StructuredQueryBuilder
and type the object as an instance of the StructuredQueryDefinition interface.
- StructuredQueryBuilder.DocumentFragmentQuery - Class in com.marklogic.client.query
-
- StructuredQueryBuilder.DocumentFragmentQuery(StructuredQueryDefinition) - Constructor for class com.marklogic.client.query.StructuredQueryBuilder.DocumentFragmentQuery
-
Deprecated.
Use the documentFragment() builder method of StructuredQueryBuilder
and type the object as an instance of the StructuredQueryDefinition interface.
- StructuredQueryBuilder.DocumentQuery - Class in com.marklogic.client.query
-
- StructuredQueryBuilder.DocumentQuery(String...) - Constructor for class com.marklogic.client.query.StructuredQueryBuilder.DocumentQuery
-
Deprecated.
Use the document() builder method of StructuredQueryBuilder
and type the object as an instance of the StructuredQueryDefinition interface.
- StructuredQueryBuilder.Element - Interface in com.marklogic.client.query
-
An Element represents an element in database documents.
- StructuredQueryBuilder.ElementAttribute - Interface in com.marklogic.client.query
-
An ElementAttribute represents an attribute on an element
in database documents.
- StructuredQueryBuilder.ElementConstraintQuery - Class in com.marklogic.client.query
-
- StructuredQueryBuilder.ElementConstraintQuery(String, StructuredQueryDefinition) - Constructor for class com.marklogic.client.query.StructuredQueryBuilder.ElementConstraintQuery
-
Deprecated.
Use the elementConstraint() builder method of StructuredQueryBuilder
and type the object as an instance of the StructuredQueryDefinition interface.
- StructuredQueryBuilder.Field - Interface in com.marklogic.client.query
-
A Field represents a field defined in the database configuration.
- StructuredQueryBuilder.FragmentScope - Enum in com.marklogic.client.query
-
Whether a query should search the document or its associated properties.
- StructuredQueryBuilder.GeospatialConstraintQuery - Class in com.marklogic.client.query
-
- StructuredQueryBuilder.GeospatialConstraintQuery(String, StructuredQueryBuilder.Region...) - Constructor for class com.marklogic.client.query.StructuredQueryBuilder.GeospatialConstraintQuery
-
Deprecated.
Use the geospatialConstraint() builder method of StructuredQueryBuilder
and type the object as an instance of the StructuredQueryDefinition interface.
- StructuredQueryBuilder.GeospatialIndex - Interface in com.marklogic.client.query
-
A GeospatialIndex can be used for geospatial queries.
- StructuredQueryBuilder.JSONKey - Interface in com.marklogic.client.query
-
A JSONKey represents a key in JSON database documents.
- StructuredQueryBuilder.LocksQuery - Class in com.marklogic.client.query
-
- StructuredQueryBuilder.LocksQuery(StructuredQueryDefinition) - Constructor for class com.marklogic.client.query.StructuredQueryBuilder.LocksQuery
-
Deprecated.
Use the locks() builder method of StructuredQueryBuilder
and type the object as an instance of the StructuredQueryDefinition interface.
- StructuredQueryBuilder.NearQuery - Class in com.marklogic.client.query
-
- StructuredQueryBuilder.NearQuery(StructuredQueryDefinition...) - Constructor for class com.marklogic.client.query.StructuredQueryBuilder.NearQuery
-
Deprecated.
Use the near() builder method of StructuredQueryBuilder
and type the object as an instance of the StructuredQueryDefinition interface.
- StructuredQueryBuilder.NearQuery(Integer, Double, StructuredQueryBuilder.Ordering, StructuredQueryDefinition...) - Constructor for class com.marklogic.client.query.StructuredQueryBuilder.NearQuery
-
Deprecated.
- StructuredQueryBuilder.NotQuery - Class in com.marklogic.client.query
-
- StructuredQueryBuilder.NotQuery(StructuredQueryDefinition) - Constructor for class com.marklogic.client.query.StructuredQueryBuilder.NotQuery
-
Deprecated.
Use the not() builder method of StructuredQueryBuilder
and type the object as an instance of the StructuredQueryDefinition interface.
- StructuredQueryBuilder.Operator - Enum in com.marklogic.client.query
-
A comparison operator for use in range queries.
- StructuredQueryBuilder.Ordering - Enum in com.marklogic.client.query
-
Control over ordering for use in near queries.
- StructuredQueryBuilder.OrQuery - Class in com.marklogic.client.query
-
- StructuredQueryBuilder.OrQuery(StructuredQueryDefinition...) - Constructor for class com.marklogic.client.query.StructuredQueryBuilder.OrQuery
-
Deprecated.
Use the or() builder method of StructuredQueryBuilder
and type the object as an instance of the StructuredQueryDefinition interface.
- StructuredQueryBuilder.PathIndex - Interface in com.marklogic.client.query
-
A PathIndex represents an index defined with an XPath
in the database configuration.
- StructuredQueryBuilder.Point - Class in com.marklogic.client.query
-
Deprecated.
Treat the Point class as an interface that extends Region.
- StructuredQueryBuilder.Point(double, double) - Constructor for class com.marklogic.client.query.StructuredQueryBuilder.Point
-
Deprecated.
Use the point() builder method of StructuredQueryBuilder.
- StructuredQueryBuilder.Polygon - Class in com.marklogic.client.query
-
Deprecated.
Use the Region interface as the type for instances of Polygon.
- StructuredQueryBuilder.Polygon(StructuredQueryBuilder.Point...) - Constructor for class com.marklogic.client.query.StructuredQueryBuilder.Polygon
-
Deprecated.
Use the polygon() builder method of StructuredQueryBuilder
and type the object as an instance of the Region interface.
- StructuredQueryBuilder.PropertiesConstraintQuery - Class in com.marklogic.client.query
-
- StructuredQueryBuilder.PropertiesConstraintQuery(String, StructuredQueryDefinition) - Constructor for class com.marklogic.client.query.StructuredQueryBuilder.PropertiesConstraintQuery
-
Deprecated.
Use the propertiesConstraint() builder method of StructuredQueryBuilder
and type the object as an instance of the StructuredQueryDefinition interface.
- StructuredQueryBuilder.PropertiesQuery - Class in com.marklogic.client.query
-
- StructuredQueryBuilder.PropertiesQuery(StructuredQueryDefinition) - Constructor for class com.marklogic.client.query.StructuredQueryBuilder.PropertiesQuery
-
Deprecated.
Use the properties() builder method of StructuredQueryBuilder
and type the object as an instance of the StructuredQueryDefinition interface.
- StructuredQueryBuilder.RangeConstraintQuery - Class in com.marklogic.client.query
-
- StructuredQueryBuilder.RangeConstraintQuery(String, StructuredQueryBuilder.Operator, String...) - Constructor for class com.marklogic.client.query.StructuredQueryBuilder.RangeConstraintQuery
-
Deprecated.
Use the rangeConstraint() builder method of StructuredQueryBuilder
and type the object as an instance of the StructuredQueryDefinition interface.
- StructuredQueryBuilder.RangeIndex - Interface in com.marklogic.client.query
-
A RangeIndex can be used for range queries.
- StructuredQueryBuilder.Region - Interface in com.marklogic.client.query
-
A region matched by a geospatial query.
- StructuredQueryBuilder.TermQuery - Class in com.marklogic.client.query
-
- StructuredQueryBuilder.TermQuery(Double, String...) - Constructor for class com.marklogic.client.query.StructuredQueryBuilder.TermQuery
-
Deprecated.
Use the term() builder method of StructuredQueryBuilder
and type the object as an instance of the StructuredQueryDefinition interface.
- StructuredQueryBuilder.TextIndex - Interface in com.marklogic.client.query
-
A TextIndex can be used for word and value queries.
- StructuredQueryBuilder.ValueConstraintQuery - Class in com.marklogic.client.query
-
- StructuredQueryBuilder.ValueConstraintQuery(String, String...) - Constructor for class com.marklogic.client.query.StructuredQueryBuilder.ValueConstraintQuery
-
Deprecated.
Use the valueConstraint() builder method of StructuredQueryBuilder
and type the object as an instance of the StructuredQueryDefinition interface.
- StructuredQueryBuilder.ValueConstraintQuery(String, Double, String...) - Constructor for class com.marklogic.client.query.StructuredQueryBuilder.ValueConstraintQuery
-
Deprecated.
- StructuredQueryBuilder.WordConstraintQuery - Class in com.marklogic.client.query
-
- StructuredQueryBuilder.WordConstraintQuery(String, String...) - Constructor for class com.marklogic.client.query.StructuredQueryBuilder.WordConstraintQuery
-
Deprecated.
Use the wordConstraint() builder method of StructuredQueryBuilder
and type the object as an instance of the StructuredQueryDefinition interface.
- StructuredQueryBuilder.WordConstraintQuery(String, Double, String...) - Constructor for class com.marklogic.client.query.StructuredQueryBuilder.WordConstraintQuery
-
Deprecated.
- StructuredQueryDefinition - Interface in com.marklogic.client.query
-
A StructuredQueryDefinition represents a structured query.
- StructuredSearch - Class in com.marklogic.client.example.cookbook
-
StructuredSearch illustrates searching for documents and iterating over results
with structured criteria referencing a constraint defined by options.
- StructuredSearch() - Constructor for class com.marklogic.client.example.cookbook.StructuredSearch
-
- StructureReadHandle - Interface in com.marklogic.client.io.marker
-
A Structure Read Handle can represent a data structure read from the
database.
- StructureWriteHandle - Interface in com.marklogic.client.io.marker
-
A Structure Write Handle can represent a data structure written to the database.
- substringAfter(String) - Method in interface com.marklogic.client.document.DocumentMetadataPatchBuilder.CallBuilder
-
Calls the built-in method to reduce an existing string
to a trailing substring.
- substringBefore(String) - Method in interface com.marklogic.client.document.DocumentMetadataPatchBuilder.CallBuilder
-
Calls the built-in method to reduce an existing string
to a leading substring.
- subtract(Number) - Method in interface com.marklogic.client.document.DocumentMetadataPatchBuilder.CallBuilder
-
Calls the built-in method to subtract from an existing value.
- suggest(String, Integer, Integer, String...) - Method in class com.marklogic.client.example.cookbook.ResourceExtension.DictionaryManager
-
- Suggest - Class in com.marklogic.client.example.cookbook
-
Suggest illustrates getting suggestions for words to find in an element.
- Suggest() - Constructor for class com.marklogic.client.example.cookbook.Suggest
-
- suggest(String, int, String, String, DatabaseClientFactory.Authentication) - Static method in class com.marklogic.client.example.cookbook.Suggest
-
- suggest(SuggestDefinition) - Method in interface com.marklogic.client.query.QueryManager
-
Queries the REST server for suggested string completions based on
values in the SuggestionDefinition.
- SuggestDefinition - Interface in com.marklogic.client.query
-
Represents the criteria for a suggestion call, in which the beginning
of a term is supplied for possible suggested endings.
- validate(RawQueryByExampleDefinition, T) - Method in interface com.marklogic.client.query.QueryManager
-
Checks a query by example for mistakes in expressing the criteria.
- value(TermSpec) - Method in class com.marklogic.client.admin.config.QueryOptionsBuilder
-
Deprecated.
Builds a value index specification for use in a constraint, values, tuples or term configuration.
- value(TermSpec, Double, QueryOptions.FragmentScope, String...) - Method in class com.marklogic.client.admin.config.QueryOptionsBuilder
-
Deprecated.
Builds a value index specification for use in a constraint, values, tuples or term configuration.
- value(StructuredQueryBuilder.TextIndex, String...) - Method in class com.marklogic.client.query.StructuredQueryBuilder
-
Matches an element, attribute, json key, or field
that has a value with the same words as at least one
of the criteria values.
- value(StructuredQueryBuilder.TextIndex, StructuredQueryBuilder.FragmentScope, String[], double, String...) - Method in class com.marklogic.client.query.StructuredQueryBuilder
-
Matches an element, attribute, json key, or field
that has a value with the same words as at least one
of the criteria values.
- valueConstraint(String, String...) - Method in class com.marklogic.client.query.StructuredQueryBuilder
-
Matches the container specified by the constraint when it
has a value with the same words as at least one
of the criteria values.
- valueConstraint(String, double, String...) - Method in class com.marklogic.client.query.StructuredQueryBuilder
-
Matches the container specified by the constraint when it
has a value with the same words as at least one
of the criteria values.
- ValueLocator - Interface in com.marklogic.client.query
-
A Locator identifying a JSON key, element, or element and attribute
containing a value as part of a KeyValueQueryDefinition.
- valueOf(String) - Static method in enum com.marklogic.client.admin.config.QueryOptions.Facets
-
Deprecated.
Returns the enum constant of this type with the specified name.
- valueOf(String) - Static method in enum com.marklogic.client.admin.config.QueryOptions.FragmentScope
-
Deprecated.
Returns the enum constant of this type with the specified name.
- valueOf(String) - Static method in enum com.marklogic.client.admin.config.QueryOptions.QueryGrammar.QueryJoiner.Comparator
-
Deprecated.
Returns the enum constant of this type with the specified name.
- valueOf(String) - Static method in enum com.marklogic.client.admin.config.QueryOptions.QueryGrammar.QueryJoiner.JoinerApply
-
Deprecated.
Returns the enum constant of this type with the specified name.
- valueOf(String) - Static method in enum com.marklogic.client.admin.config.QueryOptions.QueryGrammar.QueryStarter.StarterApply
-
Deprecated.
Returns the enum constant of this type with the specified name.
- valueOf(String) - Static method in enum com.marklogic.client.admin.config.QueryOptions.QueryGrammar.Tokenize
-
Deprecated.
Returns the enum constant of this type with the specified name.
- valueOf(String) - Static method in enum com.marklogic.client.admin.config.QueryOptions.QueryRange.ComputedBucket.AnchorValue
-
Deprecated.
Returns the enum constant of this type with the specified name.
- valueOf(String) - Static method in enum com.marklogic.client.admin.config.QueryOptions.QuerySortOrder.Direction
-
Deprecated.
Returns the enum constant of this type with the specified name.
- valueOf(String) - Static method in enum com.marklogic.client.admin.config.QueryOptions.QuerySortOrder.Score
-
Deprecated.
Returns the enum constant of this type with the specified name.
- valueOf(String) - Static method in enum com.marklogic.client.admin.config.QueryOptions.QueryTerm.TermApply
-
Deprecated.
Returns the enum constant of this type with the specified name.
- valueOf(String) - Static method in enum com.marklogic.client.admin.config.support.GeospatialIndexType
-
Returns the enum constant of this type with the specified name.
- valueOf(String) - Static method in enum com.marklogic.client.admin.config.support.QueryUri
-
Returns the enum constant of this type with the specified name.
- valueOf(String) - Static method in enum com.marklogic.client.admin.MethodType
-
Returns the enum constant of this type with the specified name.
- valueOf(String) - Static method in enum com.marklogic.client.admin.ServerConfigurationManager.Policy
-
Returns the enum constant of this type with the specified name.
- valueOf(String) - Static method in enum com.marklogic.client.admin.ServerConfigurationManager.UpdatePolicy
-
Returns the enum constant of this type with the specified name.
- valueOf(String) - Static method in enum com.marklogic.client.DatabaseClientFactory.Authentication
-
Returns the enum constant of this type with the specified name.
- valueOf(String) - Static method in enum com.marklogic.client.document.BinaryDocumentManager.MetadataExtraction
-
Returns the enum constant of this type with the specified name.
- valueOf(String) - Static method in enum com.marklogic.client.document.DocumentManager.Metadata
-
Returns the enum constant of this type with the specified name.
- valueOf(String) - Static method in enum com.marklogic.client.document.DocumentMetadataPatchBuilder.Cardinality
-
Returns the enum constant of this type with the specified name.
- valueOf(String) - Static method in enum com.marklogic.client.document.DocumentPatchBuilder.Position
-
Returns the enum constant of this type with the specified name.
- valueOf(String) - Static method in enum com.marklogic.client.document.XMLDocumentManager.DocumentRepair
-
Returns the enum constant of this type with the specified name.
- valueOf(String) - Static method in enum com.marklogic.client.example.extension.BatchManager.OperationType
-
Returns the enum constant of this type with the specified name.
- valueOf(String) - Static method in enum com.marklogic.client.io.DocumentMetadataHandle.Capability
-
Returns the enum constant of this type with the specified name.
- valueOf(String) - Static method in enum com.marklogic.client.io.Format
-
Returns the enum constant of this type with the specified name.
- valueOf(String) - Static method in enum com.marklogic.client.query.QueryManager.QueryView
-
Returns the enum constant of this type with the specified name.
- valueOf(String) - Static method in enum com.marklogic.client.query.StructuredQueryBuilder.FragmentScope
-
Returns the enum constant of this type with the specified name.
- valueOf(String) - Static method in enum com.marklogic.client.query.StructuredQueryBuilder.Operator
-
Returns the enum constant of this type with the specified name.
- valueOf(String) - Static method in enum com.marklogic.client.query.StructuredQueryBuilder.Ordering
-
Returns the enum constant of this type with the specified name.
- valueOf(String) - Static method in enum com.marklogic.client.query.ValuesDefinition.Direction
-
Returns the enum constant of this type with the specified name.
- valueOf(String) - Static method in enum com.marklogic.client.query.ValuesDefinition.Frequency
-
Returns the enum constant of this type with the specified name.
- valueOfUncased(String) - Static method in enum com.marklogic.client.DatabaseClientFactory.Authentication
-
Returns the enumerated value for the case-insensitive name.
- ValueQueryDefinition - Interface in com.marklogic.client.query
-
ValueQueryDefinitions can be used in value queries.
- values() - Static method in enum com.marklogic.client.admin.config.QueryOptions.Facets
-
Deprecated.
Returns an array containing the constants of this enum type, in
the order they are declared.
- values() - Static method in enum com.marklogic.client.admin.config.QueryOptions.FragmentScope
-
Deprecated.
Returns an array containing the constants of this enum type, in
the order they are declared.
- values() - Static method in enum com.marklogic.client.admin.config.QueryOptions.QueryGrammar.QueryJoiner.Comparator
-
Deprecated.
Returns an array containing the constants of this enum type, in
the order they are declared.
- values() - Static method in enum com.marklogic.client.admin.config.QueryOptions.QueryGrammar.QueryJoiner.JoinerApply
-
Deprecated.
Returns an array containing the constants of this enum type, in
the order they are declared.
- values() - Static method in enum com.marklogic.client.admin.config.QueryOptions.QueryGrammar.QueryStarter.StarterApply
-
Deprecated.
Returns an array containing the constants of this enum type, in
the order they are declared.
- values() - Static method in enum com.marklogic.client.admin.config.QueryOptions.QueryGrammar.Tokenize
-
Deprecated.
Returns an array containing the constants of this enum type, in
the order they are declared.
- values() - Static method in enum com.marklogic.client.admin.config.QueryOptions.QueryRange.ComputedBucket.AnchorValue
-
Deprecated.
Returns an array containing the constants of this enum type, in
the order they are declared.
- values() - Static method in enum com.marklogic.client.admin.config.QueryOptions.QuerySortOrder.Direction
-
Deprecated.
Returns an array containing the constants of this enum type, in
the order they are declared.
- values() - Static method in enum com.marklogic.client.admin.config.QueryOptions.QuerySortOrder.Score
-
Deprecated.
Returns an array containing the constants of this enum type, in
the order they are declared.
- values() - Static method in enum com.marklogic.client.admin.config.QueryOptions.QueryTerm.TermApply
-
Deprecated.
Returns an array containing the constants of this enum type, in
the order they are declared.
- values(String, TupleSource, String...) - Method in class com.marklogic.client.admin.config.QueryOptionsBuilder
-
Deprecated.
Builds a QueryValues object.
- values(String, TupleSource, QueryOptions.Aggregate, String...) - Method in class com.marklogic.client.admin.config.QueryOptionsBuilder
-
Deprecated.
Builds a QueryValues object, with an included aggregate specification.
- values() - Static method in enum com.marklogic.client.admin.config.support.GeospatialIndexType
-
Returns an array containing the constants of this enum type, in
the order they are declared.
- values() - Static method in enum com.marklogic.client.admin.config.support.QueryUri
-
Returns an array containing the constants of this enum type, in
the order they are declared.
- values() - Static method in enum com.marklogic.client.admin.MethodType
-
Returns an array containing the constants of this enum type, in
the order they are declared.
- values() - Static method in enum com.marklogic.client.admin.ServerConfigurationManager.Policy
-
Returns an array containing the constants of this enum type, in
the order they are declared.
- values() - Static method in enum com.marklogic.client.admin.ServerConfigurationManager.UpdatePolicy
-
Returns an array containing the constants of this enum type, in
the order they are declared.
- values() - Static method in enum com.marklogic.client.DatabaseClientFactory.Authentication
-
Returns an array containing the constants of this enum type, in
the order they are declared.
- values() - Static method in enum com.marklogic.client.document.BinaryDocumentManager.MetadataExtraction
-
Returns an array containing the constants of this enum type, in
the order they are declared.
- values() - Static method in enum com.marklogic.client.document.DocumentManager.Metadata
-
Returns an array containing the constants of this enum type, in
the order they are declared.
- values() - Static method in enum com.marklogic.client.document.DocumentMetadataPatchBuilder.Cardinality
-
Returns an array containing the constants of this enum type, in
the order they are declared.
- values() - Static method in enum com.marklogic.client.document.DocumentPatchBuilder.Position
-
Returns an array containing the constants of this enum type, in
the order they are declared.
- values() - Static method in enum com.marklogic.client.document.XMLDocumentManager.DocumentRepair
-
Returns an array containing the constants of this enum type, in
the order they are declared.
- values() - Static method in enum com.marklogic.client.example.extension.BatchManager.OperationType
-
Returns an array containing the constants of this enum type, in
the order they are declared.
- values() - Static method in enum com.marklogic.client.io.DocumentMetadataHandle.Capability
-
Returns an array containing the constants of this enum type, in
the order they are declared.
- values() - Static method in enum com.marklogic.client.io.Format
-
Returns an array containing the constants of this enum type, in
the order they are declared.
- values() - Static method in enum com.marklogic.client.query.QueryManager.QueryView
-
Returns an array containing the constants of this enum type, in
the order they are declared.
- values(ValuesDefinition, T) - Method in interface com.marklogic.client.query.QueryManager
-
Retrieves values from indexes based on query criteria and, potentially,
previously saved query options.
- values(ValuesDefinition, T, long) - Method in interface com.marklogic.client.query.QueryManager
-
Retrieves values from indexes based on query criteria and, potentially,
previously saved query options.
- values(ValuesDefinition, T, Transaction) - Method in interface com.marklogic.client.query.QueryManager
-
Retrieves values from indexes based on query criteria and, potentially,
previously saved query options.
- values(ValuesDefinition, T, long, Transaction) - Method in interface com.marklogic.client.query.QueryManager
-
Retrieves values from indexes based on query criteria and, potentially,
previously saved query options.
- values() - Static method in enum com.marklogic.client.query.StructuredQueryBuilder.FragmentScope
-
Returns an array containing the constants of this enum type, in
the order they are declared.
- values() - Static method in enum com.marklogic.client.query.StructuredQueryBuilder.Operator
-
Returns an array containing the constants of this enum type, in
the order they are declared.
- values() - Static method in enum com.marklogic.client.query.StructuredQueryBuilder.Ordering
-
Returns an array containing the constants of this enum type, in
the order they are declared.
- values() - Static method in enum com.marklogic.client.query.ValuesDefinition.Direction
-
Returns an array containing the constants of this enum type, in
the order they are declared.
- values() - Static method in enum com.marklogic.client.query.ValuesDefinition.Frequency
-
Returns an array containing the constants of this enum type, in
the order they are declared.
- values() - Method in class com.marklogic.client.util.EditableNamespaceContext
-
Gets the list of URIs from the namespace bindings.
- values() - Method in class com.marklogic.client.util.RequestParameters
-
Returns a list of value lists.
- ValuesDefinition - Interface in com.marklogic.client.query
-
A ValuesDefinition represents a values query used to retreive values from the server.
- ValuesDefinition.Direction - Enum in com.marklogic.client.query
-
The possible directions.
- ValuesDefinition.Frequency - Enum in com.marklogic.client.query
-
The kinds of frequencies.
- ValuesHandle - Class in com.marklogic.client.io
-
A ValuesHandle represents a list of values or of tuples
(combination of values for the same document) retrieved
from the indexes.
- ValuesHandle() - Constructor for class com.marklogic.client.io.ValuesHandle
-
Zero-argument constructor.
- valuesList(ValuesListDefinition, T) - Method in interface com.marklogic.client.query.QueryManager
-
Retrieves the list of available named lexicon configurations from the
values list definition and, potentially, previously saved query options.
- valuesList(ValuesListDefinition, T, Transaction) - Method in interface com.marklogic.client.query.QueryManager
-
Retrieves the list of available named lexicon configurations from the
values list definition and, potentially, previously saved query options.
- ValuesListDefinition - Interface in com.marklogic.client.query
-
A ValuesListDefinition is the base type for a values or tuples list.
- ValuesListHandle - Class in com.marklogic.client.io
-
A ValuesListHandle represents a list of available named lexicon configurations
from saved query options.
- ValuesListHandle() - Constructor for class com.marklogic.client.io.ValuesListHandle
-
The constructor.
- ValuesListReadHandle - Interface in com.marklogic.client.io.marker
-
A ValuesListReadHandle represents a list of sets of values read from the database.
- ValuesListResults - Interface in com.marklogic.client.query
-
A ValuesListResults represents the results of a values query.
- ValuesMetrics - Interface in com.marklogic.client.query
-
A SearchMetrics object represents the query metrics returned by a search.
- ValuesReadHandle - Interface in com.marklogic.client.io.marker
-
A ValuesReadHandle represents a set of values read from the database.
- ValuesResults - Interface in com.marklogic.client.query
-
ValuesResults represents one set of values from a values query.
- verify(String, String[], String[]) - Method in class com.marklogic.client.DatabaseClientFactory.SSLHostnameVerifier.Builtin
-
- verify(String, String[], String[]) - Method in interface com.marklogic.client.DatabaseClientFactory.SSLHostnameVerifier
-
Checks a hostname during SSL authentication.
- warning(SAXParseException) - Method in class com.marklogic.client.io.InputSourceHandle.DraconianErrorHandler
-
Ignores the warning.
- with(TagNode) - Method in class com.marklogic.client.example.handle.HTMLCleanerHandle
-
- with(File, String) - Method in class com.marklogic.client.example.handle.HTMLCleanerHandle
-
- with(InputStream, String) - Method in class com.marklogic.client.example.handle.HTMLCleanerHandle
-
- with(Reader) - Method in class com.marklogic.client.example.handle.HTMLCleanerHandle
-
- with(String) - Method in class com.marklogic.client.example.handle.HTMLCleanerHandle
-
- with(URI) - Method in class com.marklogic.client.example.handle.URIHandle
-
- with(String) - Method in class com.marklogic.client.example.handle.URIHandle
-
- with(Document) - Method in class com.marklogic.client.extra.dom4j.DOM4JHandle
-
Assigns an XML document structure as the content and returns the handle.
- with(JsonElement) - Method in class com.marklogic.client.extra.gson.GSONHandle
-
Assigns a JSON tree as the content and returns the handle.
- with(JsonNode) - Method in class com.marklogic.client.extra.jackson.JacksonHandle
-
Assigns a JSON tree as the content and returns the handle.
- with(Document) - Method in class com.marklogic.client.extra.jdom.JDOMHandle
-
Assigns an XML document structure as the content and returns the handle.
- with(Document) - Method in class com.marklogic.client.extra.xom.XOMHandle
-
Assigns an XML document structure as the content and returns the handle.
- with(byte[]) - Method in class com.marklogic.client.io.BytesHandle
-
Assigns a byte array as the content and returns the handle
as a fluent convenience.
- with(Document) - Method in class com.marklogic.client.io.DOMHandle
-
Assigns a DOM document as the content and returns the handle
as a fluent convenience.
- with(File) - Method in class com.marklogic.client.io.FileHandle
-
Assigns a file as the content and returns the handle
as a fluent convenience.
- with(InputSource) - Method in class com.marklogic.client.io.InputSourceHandle
-
Assigns an input source as the content and returns the handle
as a fluent convenience.
- with(InputStream) - Method in class com.marklogic.client.io.InputStreamHandle
-
Assigns an input stream as the content and returns the handle
as a fluent convenience.
- with(C) - Method in class com.marklogic.client.io.JAXBHandle
-
Assigns the root object of the JAXB structure for the content
and returns the handle as a fluent convenience.
- with(OutputStreamSender) - Method in class com.marklogic.client.io.OutputStreamHandle
-
Assigns an output stream sender providing the callback that writes
content to the database and returns the handle as a fluent convenience.
- with(Reader) - Method in class com.marklogic.client.io.ReaderHandle
-
Assigns a character reader as the content and returns the handle
as a fluent convenience.
- with(Source) - Method in class com.marklogic.client.io.SourceHandle
-
Assigns a transform source that produces the content and returns
the handle as a fluent convenience.
- with(String) - Method in class com.marklogic.client.io.StringHandle
-
Assigns a string as the content and returns the handle
as a fluent convenience.
- with(XMLEventReader) - Method in class com.marklogic.client.io.XMLEventReaderHandle
-
Assigns an event reader for the content and returns the handle
as a fluent convenience.
- with(XMLStreamReader) - Method in class com.marklogic.client.io.XMLStreamReaderHandle
-
Assigns an stream reader for the content and returns the handle
as a fluent convenience.
- withAdditionalQuery(QueryOptions.QueryAdditionalQuery) - Method in class com.marklogic.client.admin.config.QueryOptions.QueryState
-
Deprecated.
- withAdditionalQuery(Element) - Method in class com.marklogic.client.admin.config.QueryOptions.QueryState
-
Deprecated.
- withAdditionalQuery(QueryOptions.QueryAdditionalQuery) - Method in class com.marklogic.client.io.QueryOptionsHandle
-
Deprecated.
Sets the ctsQuery element in the query options.
- withCollections(String...) - Method in class com.marklogic.client.io.DocumentMetadataHandle
-
Locally adds the collections to the current collections
for the document.
- withConfiguration(QueryOptionsConfiguration) - Method in class com.marklogic.client.io.QueryOptionsHandle
-
Deprecated.
Set common configuration objects for this handle, fluently.
- withConstraints(QueryOptions.QueryConstraint...) - Method in class com.marklogic.client.io.QueryOptionsHandle
-
Deprecated.
Set a List of constraints in the query options.
- withCriteria(String) - Method in interface com.marklogic.client.query.StringQueryDefinition
-
Sets the query criteria as a query string and returns the query
definition as a fluent convenience.
- withDelete(String) - Method in class com.marklogic.client.example.extension.BatchManager.BatchRequest
-
- withDirectory(String) - Method in interface com.marklogic.client.document.DocumentUriTemplate
-
Specifies the directory that should prefix the document uri
and returns the template object.
- withExtractMetadata(QueryOptions.QueryExtractMetadata) - Method in class com.marklogic.client.io.QueryOptionsHandle
-
Deprecated.
Sets the extract metadata setting in the options node.
- withForests(List<Long>) - Method in class com.marklogic.client.admin.config.QueryOptions.QueryState
-
Deprecated.
- withFormat(Format) - Method in interface com.marklogic.client.document.DocumentDescriptor
-
Specifies the format for a database document and
returns the descriptor object
- withFormat(Format) - Method in interface com.marklogic.client.document.DocumentUriTemplate
-
Specifies the format of the document
and returns the template object.
- withFormat(Format) - Method in class com.marklogic.client.example.handle.URIHandle
-
- withFormat(Format) - Method in class com.marklogic.client.io.BytesHandle
-
Specifies the format of the content and returns the handle
as a fluent convenience.
- withFormat(Format) - Method in class com.marklogic.client.io.FileHandle
-
Specifies the format of the content and returns the handle
as a fluent convenience.
- withFormat(Format) - Method in class com.marklogic.client.io.InputStreamHandle
-
Specifies the format of the content and returns the handle
as a fluent convenience.
- withFormat(Format) - Method in class com.marklogic.client.io.OutputStreamHandle
-
Specifies the format of the content and returns the handle
as a fluent convenience.
- withFormat(Format) - Method in class com.marklogic.client.io.QueryOptionsListHandle
-
Fluent setter for the format associated with this handle.
- withFormat(Format) - Method in class com.marklogic.client.io.ReaderHandle
-
Specifies the format of the content and returns the handle
as a fluent convenience.
- withFormat(Format) - Method in class com.marklogic.client.io.SearchHandle
-
Fluent setter for the format associated with this handle.
- withFormat(Format) - Method in class com.marklogic.client.io.StringHandle
-
Specifies the format of the content and returns the handle
as a fluent convenience.
- withFormat(Format) - Method in class com.marklogic.client.io.TuplesHandle
-
Fluent setter for the format associated with this handle.
- withFormat(Format) - Method in class com.marklogic.client.io.ValuesHandle
-
Fluent setter for the format associated with this handle.
- withFormat(Format) - Method in class com.marklogic.client.io.ValuesListHandle
-
Fluent setter for the format associated with this handle.
- withGrammar(QueryOptions.QueryGrammar) - Method in class com.marklogic.client.io.QueryOptionsHandle
-
Deprecated.
Sets the grammar in the query options.
- withHandle(StructureWriteHandle) - Method in interface com.marklogic.client.query.RawCombinedQueryDefinition
-
Specifies the handle for the JSON or XML representation
of a combined query and returns the query definition.
- withHandle(StructureWriteHandle) - Method in interface com.marklogic.client.query.RawQueryByExampleDefinition
-
Specifies the handle for the JSON or XML representation
of a query by example and returns the query definition.
- withHandle(StructureWriteHandle) - Method in interface com.marklogic.client.query.RawStructuredQueryDefinition
-
Specifies the handle for the JSON or XML representation
of a structured query and returns the query definition.
- withMimetype(String) - Method in class com.marklogic.client.io.BytesHandle
-
Specifies the mime type of the content and returns the handle
as a fluent convenience.
- withMimetype(String) - Method in class com.marklogic.client.io.DOMHandle
-
Specifies the mime type of the content and returns the handle
as a fluent convenience.
- withMimetype(String) - Method in class com.marklogic.client.io.FileHandle
-
Specifies the mime type of the content and returns the handle
as a fluent convenience.
- withMimetype(String) - Method in class com.marklogic.client.io.InputSourceHandle
-
Specifies the mime type of the content and returns the handle
as a fluent convenience.
- withMimetype(String) - Method in class com.marklogic.client.io.InputStreamHandle
-
Specifies the mime type of the content and returns the handle
as a fluent convenience.
- withMimetype(String) - Method in class com.marklogic.client.io.JAXBHandle
-
Specifies the mime type of the content and returns the handle
as a fluent convenience.
- withMimetype(String) - Method in class com.marklogic.client.io.OutputStreamHandle
-
Specifies the mime type of the content and returns the handle
as a fluent convenience.
- withMimetype(String) - Method in class com.marklogic.client.io.ReaderHandle
-
Specifies the mime type of the content and returns the handle
as a fluent convenience.
- withMimetype(String) - Method in class com.marklogic.client.io.SourceHandle
-
Specifies the mime type of the content and returns the handle
as a fluent convenience.
- withMimetype(String) - Method in class com.marklogic.client.io.StringHandle
-
Specifies the mime type of the content and returns the handle
as a fluent convenience.
- withMimetype(String) - Method in class com.marklogic.client.io.XMLEventReaderHandle
-
Specifies the mime type of the content and returns the handle
as a fluent convenience.
- withMimetype(String) - Method in class com.marklogic.client.io.XMLStreamReaderHandle
-
Specifies the mime type of the content and returns the handle
as a fluent convenience.
- withOperators(QueryOptions.QueryOperator...) - Method in class com.marklogic.client.io.QueryOptionsHandle
-
Deprecated.
Sets a List of operators in the query options.
- withPageLength(Long) - Method in class com.marklogic.client.admin.config.QueryOptions.QueryState
-
Deprecated.
- withPermission(String, DocumentMetadataHandle.Capability...) - Method in class com.marklogic.client.io.DocumentMetadataHandle
-
Locally adds the role and its capabilities to the current
permissions for the document.
- withProperty(QName, Object) - Method in class com.marklogic.client.io.DocumentMetadataHandle
-
Locally adds the property name and value to the current
properties for the document.
- withProperty(String, Object) - Method in class com.marklogic.client.io.DocumentMetadataHandle
-
Locally adds the property name and value to the current
properties for the document.
- withQuality(int) - Method in class com.marklogic.client.io.DocumentMetadataHandle
-
Locally specifies the match quality for the document.
- withQualityWeight(Double) - Method in class com.marklogic.client.admin.config.QueryOptions.QueryState
-
Deprecated.
- withRead(String, String) - Method in class com.marklogic.client.example.extension.BatchManager.BatchRequest
-
- withRead(String, DocumentManager.Metadata, String) - Method in class com.marklogic.client.example.extension.BatchManager.BatchRequest
-
- withRead(String, Set<DocumentManager.Metadata>, String) - Method in class com.marklogic.client.example.extension.BatchManager.BatchRequest
-
- withResendable(boolean) - Method in class com.marklogic.client.io.OutputStreamHandle
-
Specifies whether the content can be resent to the output stream and
returns the handle as a fluent convenience.
- withSearchableExpression(QueryOptions.QuerySearchableExpression) - Method in class com.marklogic.client.admin.config.QueryOptions.QueryState
-
Deprecated.
- withSearchableExpression(QueryOptions.QuerySearchableExpression) - Method in class com.marklogic.client.io.QueryOptionsHandle
-
Deprecated.
Sets the searchable expression in the query options.
- withSearchOptions(List<String>) - Method in class com.marklogic.client.admin.config.QueryOptions.QueryState
-
Deprecated.
- withSortOrders(QueryOptions.QuerySortOrder...) - Method in class com.marklogic.client.admin.config.QueryOptions.QueryState
-
Deprecated.
- withSortOrders(QueryOptions.QuerySortOrder...) - Method in class com.marklogic.client.io.QueryOptionsHandle
-
Deprecated.
Set a List of sort orders in the query options.
- withTerm(QueryOptions.QueryTerm) - Method in class com.marklogic.client.io.QueryOptionsHandle
-
Deprecated.
Set the term configuration in the query options.
- withTransformer(Transformer) - Method in class com.marklogic.client.io.SourceHandle
-
Specifies a transformer for modifying the content and returns the handle
as a fluent convenience.
- withTransformResults(QueryOptions.QueryTransformResults) - Method in class com.marklogic.client.admin.config.QueryOptions.QueryState
-
Deprecated.
- withTransformResults(QueryOptions.QueryTransformResults) - Method in class com.marklogic.client.io.QueryOptionsHandle
-
Deprecated.
Set the transform results in the query options.
- withTuples(QueryOptions.QueryTuples...) - Method in class com.marklogic.client.io.QueryOptionsHandle
-
Deprecated.
Sets a List of tuples in the query options.
- withValues(QueryOptions.QueryValues...) - Method in class com.marklogic.client.io.QueryOptionsHandle
-
Deprecated.
Sets a List of values in the query options.
- withWrite(String, AbstractWriteHandle) - Method in class com.marklogic.client.example.extension.BatchManager.BatchRequest
-
- withWrite(String, DocumentMetadataHandle, AbstractWriteHandle) - Method in class com.marklogic.client.example.extension.BatchManager.BatchRequest
-
- word(TermSpec) - Method in class com.marklogic.client.admin.config.QueryOptionsBuilder
-
Deprecated.
Builds a word index specification for use in a constraint or term configuration.
- word(TermSpec, Double, QueryOptions.FragmentScope, String...) - Method in class com.marklogic.client.admin.config.QueryOptionsBuilder
-
Deprecated.
Builds a word index specification for use in a constraint or term configuration.
- word(StructuredQueryBuilder.TextIndex, String...) - Method in class com.marklogic.client.query.StructuredQueryBuilder
-
Matches an element, attribute, json key, or field
that has at least one of the criteria words.
- word(StructuredQueryBuilder.TextIndex, StructuredQueryBuilder.FragmentScope, String[], double, String...) - Method in class com.marklogic.client.query.StructuredQueryBuilder
-
Matches an element, attribute, json key, or field
that has at least one of the criteria words.
- wordConstraint(String, String...) - Method in class com.marklogic.client.query.StructuredQueryBuilder
-
Matches the container specified by the constraint when it
has at least one of the criteria words.
- wordConstraint(String, double, String...) - Method in class com.marklogic.client.query.StructuredQueryBuilder
-
Matches the container specified by the constraint when it
has at least one of the criteria words.
- write(String, AbstractWriteHandle) - Method in interface com.marklogic.client.admin.ExtensionLibrariesManager
-
Writes the contents of a handle to the provided path on the REST server.
- write(ExtensionLibraryDescriptor, AbstractWriteHandle) - Method in interface com.marklogic.client.admin.ExtensionLibrariesManager
-
Writes the contents of a handle to the provided path on the REST server.
- write(OutputStream) - Method in class com.marklogic.client.alerting.RuleDefinition
-
Writes a serialized RuleDefinition to an OutputStream as XML.
- write(String, W) - Method in interface com.marklogic.client.document.DocumentManager
-
Writes the document content to the database from the representation provided by the handle
To call write(), an application must authenticate as rest-writer or rest-admin.
- write(String, W, ServerTransform) - Method in interface com.marklogic.client.document.DocumentManager
-
Writes the document content to the database as transformed on the server.
- write(DocumentDescriptor, W) - Method in interface com.marklogic.client.document.DocumentManager
-
Writes the document content to the database from the representation provided by the handle
To call write(), an application must authenticate as rest-writer or rest-admin.
- write(DocumentDescriptor, W, ServerTransform) - Method in interface com.marklogic.client.document.DocumentManager
-
Writes the document content to the database as transformed on the server.
- write(String, DocumentMetadataWriteHandle, W) - Method in interface com.marklogic.client.document.DocumentManager
-
Writes the document metadata and content to the database from the representations provided by the handles
To call write(), an application must authenticate as rest-writer or rest-admin.
- write(String, DocumentMetadataWriteHandle, W, ServerTransform) - Method in interface com.marklogic.client.document.DocumentManager
-
Writes the document metadata and content to the database as transformed on the server.
- write(DocumentDescriptor, DocumentMetadataWriteHandle, W) - Method in interface com.marklogic.client.document.DocumentManager
-
Writes the document metadata and content to the database from the representations provided by the handles
To call write(), an application must authenticate as rest-writer or rest-admin.
- write(DocumentDescriptor, DocumentMetadataWriteHandle, W, ServerTransform) - Method in interface com.marklogic.client.document.DocumentManager
-
Writes the document metadata and content to the database as transformed on the server.
- write(String, W, Transaction) - Method in interface com.marklogic.client.document.DocumentManager
-
Writes the document content to an open database transaction from the representation provided by the handle
To call write(), an application must authenticate as rest-writer or rest-admin.
- write(String, W, ServerTransform, Transaction) - Method in interface com.marklogic.client.document.DocumentManager
-
Writes the document content to an open database transaction as transformed on the server.
- write(DocumentDescriptor, W, Transaction) - Method in interface com.marklogic.client.document.DocumentManager
-
Writes the document content to an open database transaction from the representation provided by the handle
To call write(), an application must authenticate as rest-writer or rest-admin.
- write(DocumentDescriptor, W, ServerTransform, Transaction) - Method in interface com.marklogic.client.document.DocumentManager
-
Writes the document content to an open database transaction as transformed on the server.
- write(String, DocumentMetadataWriteHandle, W, Transaction) - Method in interface com.marklogic.client.document.DocumentManager
-
Writes the document metadata and content to an open database transaction from the representations provided by the handles
To call write(), an application must authenticate as rest-writer or rest-admin.
- write(String, DocumentMetadataWriteHandle, W, ServerTransform, Transaction) - Method in interface com.marklogic.client.document.DocumentManager
-
Writes the document metadata and content to an open database transaction as transformed on the server.
- write(DocumentDescriptor, DocumentMetadataWriteHandle, W, Transaction) - Method in interface com.marklogic.client.document.DocumentManager
-
Writes the document metadata and content to an open database transaction from the representations provided by the handles
To call write(), an application must authenticate as rest-writer or rest-admin.
- write(DocumentDescriptor, DocumentMetadataWriteHandle, W, ServerTransform, Transaction) - Method in interface com.marklogic.client.document.DocumentManager
-
Writes the document metadata and content to an open database transaction as transformed on the server.
- write(Reader) - Method in class com.marklogic.client.example.extension.OpenCSVBatcher
-
- write(Reader, String) - Method in class com.marklogic.client.example.extension.OpenCSVBatcher
-
- write(Reader, QName) - Method in class com.marklogic.client.example.extension.OpenCSVBatcher
-
- write(Reader, String, String) - Method in class com.marklogic.client.example.extension.OpenCSVBatcher
-
- write(Reader, String, QName) - Method in class com.marklogic.client.example.extension.OpenCSVBatcher
-
- write(Reader, String, String, QName...) - Method in class com.marklogic.client.example.extension.OpenCSVBatcher
-
- write(Reader, String, QName, QName...) - Method in class com.marklogic.client.example.extension.OpenCSVBatcher
-
- write(OutputStream) - Method in class com.marklogic.client.example.handle.HTMLCleanerHandle
-
- write(OutputStream) - Method in class com.marklogic.client.extra.dom4j.DOM4JHandle
-
- write(OutputStream) - Method in class com.marklogic.client.extra.jackson.JacksonHandle
-
- write(OutputStream) - Method in class com.marklogic.client.extra.jdom.JDOMHandle
-
- write(OutputStream) - Method in class com.marklogic.client.extra.xom.XOMHandle
-
- write(OutputStream) - Method in class com.marklogic.client.io.DocumentMetadataHandle
-
- write(OutputStream) - Method in class com.marklogic.client.io.DOMHandle
-
- write(OutputStream) - Method in class com.marklogic.client.io.InputSourceHandle
-
- write(OutputStream) - Method in class com.marklogic.client.io.JAXBHandle
-
- write(OutputStream) - Method in interface com.marklogic.client.io.OutputStreamSender
-
Implements a callback to write content to the provided output stream
for sending to the database server.
- write(OutputStream) - Method in class com.marklogic.client.io.QueryOptionsHandle
-
Deprecated.
Writes the query options node (as XML) to the specified output stream.
- write(OutputStream) - Method in class com.marklogic.client.io.ReaderHandle
-
- write(OutputStream) - Method in class com.marklogic.client.io.SourceHandle
-
- write(OutputStream) - Method in class com.marklogic.client.io.StringHandle
-
- write(OutputStream) - Method in class com.marklogic.client.io.XMLEventReaderHandle
-
- write(OutputStream) - Method in class com.marklogic.client.io.XMLStreamReaderHandle
-
- writeAs(String, Object) - Method in interface com.marklogic.client.admin.ExtensionLibrariesManager
-
Writes the contents of a handle to the provided path on the REST server
as an object of an IO class.
- writeAs(ExtensionLibraryDescriptor, Object) - Method in interface com.marklogic.client.admin.ExtensionLibrariesManager
-
Writes the contents of a handle to the provided path on the REST server
as an object of an IO class.
- writeAs(String, Object) - Method in interface com.marklogic.client.document.DocumentManager
-
Writes the document content to the database from an object of an IO class.
- writeAs(String, Object, ServerTransform) - Method in interface com.marklogic.client.document.DocumentManager
-
Writes the document content to the database from an object of an IO class.
- writeAs(String, DocumentMetadataWriteHandle, Object) - Method in interface com.marklogic.client.document.DocumentManager
-
Writes the document content to the database from an object of an IO class.
- writeAs(String, DocumentMetadataWriteHandle, Object, ServerTransform) - Method in interface com.marklogic.client.document.DocumentManager
-
Writes the document content to the database from an object of an IO class.
- writeConfiguration() - Method in interface com.marklogic.client.admin.ServerConfigurationManager
-
Writes the values of the properties of this object to the server.
- writeDefaultMetadata(String) - Method in interface com.marklogic.client.document.DocumentManager
-
Reverts the document metadata in the database to the defaults
To call writeDefaultMetadata(), an application must authenticate as rest-writer or rest-admin.
- writeDefaultMetadata(String, Transaction) - Method in interface com.marklogic.client.document.DocumentManager
-
Reverts the document metadata in an open database transaction to the defaults
To call writeDefaultMetadata(), an application must authenticate as rest-writer or rest-admin.
- writeDocument(String, int, String, String, DatabaseClientFactory.Authentication) - Static method in class com.marklogic.client.example.cookbook.DocumentWriteTransform
-
- writeMetadata(String, DocumentMetadataWriteHandle) - Method in interface com.marklogic.client.document.DocumentManager
-
Writes the document metadata to the database from the representation provided by the handle
To call writeMetadata(), an application must authenticate as rest-writer or rest-admin.
- writeMetadata(String, DocumentMetadataWriteHandle, Transaction) - Method in interface com.marklogic.client.document.DocumentManager
-
Writes the document metadata to an open database transaction from the representation provided by the handle
To call writeMetadata(), an application must authenticate as rest-writer or rest-admin.
- writeOptions(String, QueryOptionsWriteHandle) - Method in interface com.marklogic.client.admin.QueryOptionsManager
-
Write a named QueryOptions configuration to the REST server.
- writeOptionsAs(String, Format, Object) - Method in interface com.marklogic.client.admin.QueryOptionsManager
-
Write a named QueryOptions configuration to the REST server in a JSON or
XML representation provided as an object of an IO class.
- writeReadDeleteDocument(DatabaseClient, String, String) - Static method in class com.marklogic.client.example.cookbook.DocumentFormats
-
- writerPassword - Variable in class com.marklogic.client.example.cookbook.Util.ExampleProperties
-
- writeRule(RuleDefinition) - Method in interface com.marklogic.client.alerting.RuleManager
-
Writes a rule to the server from the provided handle.
- writeRule(String, RuleWriteHandle) - Method in interface com.marklogic.client.alerting.RuleManager
-
Writes a rule to the server from the provided handle.
- writeRuleAs(String, Object) - Method in interface com.marklogic.client.alerting.RuleManager
-
Writes a rule to the server in an XML representation provided
as an object of an IO class.
- writerUser - Variable in class com.marklogic.client.example.cookbook.Util.ExampleProperties
-
- writeServices(String, TextWriteHandle, ExtensionMetadata, ResourceExtensionsManager.MethodParameters...) - Method in interface com.marklogic.client.admin.ResourceExtensionsManager
-
Installs the services that implement a resource.
- writeServicesAs(String, Object, ExtensionMetadata, ResourceExtensionsManager.MethodParameters...) - Method in interface com.marklogic.client.admin.ResourceExtensionsManager
-
Installs the services that implement a resource
in a textual representation provided as an object of an IO class.
- writeXQueryTransform(String, TextWriteHandle) - Method in interface com.marklogic.client.admin.TransformExtensionsManager
-
Installs a transform implemented in XQuery.
- writeXQueryTransform(String, TextWriteHandle, ExtensionMetadata) - Method in interface com.marklogic.client.admin.TransformExtensionsManager
-
Installs a transform implemented in XQuery.
- writeXQueryTransform(String, TextWriteHandle, ExtensionMetadata, Map<String, String>) - Method in interface com.marklogic.client.admin.TransformExtensionsManager
-
Deprecated.
- writeXQueryTransformAs(String, Object) - Method in interface com.marklogic.client.admin.TransformExtensionsManager
-
Installs a transform implemented in XQuery
in a textual representation provided as an object of an IO class.
- writeXQueryTransformAs(String, ExtensionMetadata, Object) - Method in interface com.marklogic.client.admin.TransformExtensionsManager
-
Installs a transform implemented in XQuery
in a textual representation provided as an object of an IO class.
- writeXSLTransform(String, XMLWriteHandle) - Method in interface com.marklogic.client.admin.TransformExtensionsManager
-
Installs a transform implemented in XSL.
- writeXSLTransform(String, XMLWriteHandle, ExtensionMetadata) - Method in interface com.marklogic.client.admin.TransformExtensionsManager
-
Installs a transform implemented in XSL.
- writeXSLTransform(String, XMLWriteHandle, ExtensionMetadata, Map<String, String>) - Method in interface com.marklogic.client.admin.TransformExtensionsManager
-
Deprecated.
- writeXSLTransformAs(String, Object) - Method in interface com.marklogic.client.admin.TransformExtensionsManager
-
Installs a transform implemented in XSL
in an XML representation provided as an object of an IO class.
- writeXSLTransformAs(String, ExtensionMetadata, Object) - Method in interface com.marklogic.client.admin.TransformExtensionsManager
-
Installs a transform implemented in XSL
in an XML representation provided as an object of an IO class.