- 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.
- 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.
- geospatialConstraint(String, StructuredQueryBuilder.Region...) - Method in class com.marklogic.client.query.StructuredQueryBuilder
-
- 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.DOM4JHandle
-
- get() - Method in class com.marklogic.client.example.handle.HTMLCleanerHandle
-
- get() - Method in class com.marklogic.client.example.handle.JacksonHandle
-
- get() - Method in class com.marklogic.client.example.handle.JDOMHandle
-
- get() - Method in class com.marklogic.client.example.handle.URIHandle
-
- get() - Method in class com.marklogic.client.example.handle.XOMHandle
-
- 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.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() - 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
-
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.
- 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
-
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.
- 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.batch.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.example.handle.JDOMHandle
-
- getBuilder() - Method in class com.marklogic.client.example.handle.XOMHandle
-
- 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
-
- 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
-
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
-
Return the named query constraint from the query options.
- getConstraintConfiguration() - Method in class com.marklogic.client.admin.config.QueryOptions.QuerySuggestionSource
-
Deprecated.
- getConstraints() - Method in class com.marklogic.client.io.QueryOptionsHandle
-
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.batch.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.batch.BatchManager.ReadOutput
-
- getContentVersionRequests() - Method in interface com.marklogic.client.admin.ServerConfigurationManager
-
Returns whether the server requires, allows, or ignores document versionss
on document read, write, and delete requests.
- 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.
- 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
-
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.
- 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
-
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.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.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.batch.BatchManager.OutputItem
-
- getExtractMetadata() - Method in class com.marklogic.client.admin.config.QueryOptions
-
Deprecated.
- getExtractMetadata() - Method in class com.marklogic.client.io.QueryOptionsHandle
-
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.
- 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
-
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
-
Returns the underlying format supported by the query options handle.
- 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
-
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
-
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.
- getHasHeader() - Method in class com.marklogic.client.example.batch.OpenCSVBatcher
-
- getHeatmap() - Method in class com.marklogic.client.admin.config.support.HeatmapAndOptions
-
- 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
-
- getLength() - Method in interface com.marklogic.client.extensions.ResourceServices.ServiceResult
-
Returns the length of the content in bytes.
- 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
-
- 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.example.handle.JacksonHandle
-
- 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.example.batch.BatchManager.ReadOutput
-
- getMetadata(R) - Method in class com.marklogic.client.example.batch.BatchManager.ReadOutput
-
- getMetadata() - Method in interface com.marklogic.client.query.MatchDocumentSummary
-
Returns the metadata associated with this document.
- getMetadataCategories() - Method in interface com.marklogic.client.document.DocumentManager
-
Returns the categories of metadata to read or write
- 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
-
- 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.document.ServerTransform
-
- 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.
- 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.batch.BatchManager.DeleteOutput
-
- getOperationType() - Method in class com.marklogic.client.example.batch.BatchManager.OutputItem
-
- getOperationType() - Method in class com.marklogic.client.example.batch.BatchManager.ReadOutput
-
- getOperationType() - Method in class com.marklogic.client.example.batch.BatchManager.WriteOutput
-
- getOperator(String) - Method in class com.marklogic.client.io.QueryOptionsHandle
-
Returns the named query operator.
- getOperators() - Method in class com.marklogic.client.io.QueryOptionsHandle
-
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
-
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.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.example.handle.DOM4JHandle
-
- getOutputter() - Method in class com.marklogic.client.example.handle.JDOMHandle
-
- 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.batch.SearchCollector
-
- getPageLength() - Method in class com.marklogic.client.io.QueryOptionsHandle
-
Returns the page length specified in the query options.
- getPageLength() - Method in interface com.marklogic.client.query.QueryManager
-
Returns the maximum number of documents that can appear in any page of query results.
- 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
-
- 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 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.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() - Method in interface com.marklogic.client.query.SearchResults
-
Returns the query plan.
- 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
-
Returns the quality weight specified in the query options.
- 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.
- 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.example.handle.DOM4JHandle
-
- 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.
- 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.
- 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
-
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
-
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
-
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
-
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
-
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
-
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
-
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
-
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
-
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
-
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
-
Returns the return values option from the query options.
- 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
-
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
-
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
-
Returns a List of the search options in the query options.
- getSearchResult(R) - Method in class com.marklogic.client.example.batch.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.
- 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.
- 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
-
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.
- 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.
- getSuccess() - Method in class com.marklogic.client.example.batch.BatchManager.BatchResponse
-
- getSuccess() - Method in class com.marklogic.client.example.batch.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
-
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
-
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 the total number of results.
- 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
-
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
-
Returns a List of the tuples accessors in the query options.
- getTuples(String) - Method in class com.marklogic.client.io.QueryOptionsHandle
-
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
- 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.batch.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.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
-
Returns a List of the values accessors in the query options.
- getValues(String) - Method in class com.marklogic.client.io.QueryOptionsHandle
-
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.
- 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 read requests that don't specify a transform
- 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.
- 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 handle instead to write or read query options.
- 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 handle instead to write or read query options.
- 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
-
A QueryOptionsHandle is used to configure query configurations.
- QueryOptionsHandle() - Constructor for class com.marklogic.client.io.QueryOptionsHandle
-
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
-
- 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.
- rangeConstraint(String, StructuredQueryBuilder.Operator, String...) - Method in class com.marklogic.client.query.StructuredQueryBuilder
-
- 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
-
- 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.
- RawCombinedQueryDefinition - Interface in com.marklogic.client.query
-
A RawCombinedQueryDefinition provides access to a combined query
in a 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(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.
- readAll() - Method in interface com.marklogic.client.admin.NamespacesManager
-
Reads all of the namespace bindings from the server.
- 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.
- 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.
- readPrefix(String) - Method in interface com.marklogic.client.admin.NamespacesManager
-
Returns the namespace URI bound to the specified prefix on the server.
- readServices(String, T) - Method in interface com.marklogic.client.admin.ResourceExtensionsManager
-
Reads the XQuery implementation of the services for a resource.
- 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.
- readXSLTransform(String, T) - Method in interface com.marklogic.client.admin.TransformExtensionsManager
-
Reads the source for a transform implemented in XSLT.
- release() - Method in interface com.marklogic.client.DatabaseClient
-
Closes the database client and releases associated resources.
- remove() - Method in class com.marklogic.client.example.batch.BatchManager.BatchResponse
-
- remove() - Method in class com.marklogic.client.example.batch.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.
- 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.batch.OpenCSVBatcher
-
- RESTAPI_PREFIX - Static variable in class com.marklogic.client.example.batch.OpenCSVBatcher
-
- 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.
- run(Util.ExampleProperties) - Static method in class com.marklogic.client.example.batch.BatchManagerExample
-
- run(Util.ExampleProperties) - Static method in class com.marklogic.client.example.batch.OpenCSVBatcherExample
-
- run(Util.ExampleProperties) - Static method in class com.marklogic.client.example.batch.SearchCollectorExample
-
- 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.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.ResourceExtension
-
- 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.handle.DOM4JHandleExample
-
- 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
-
- 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(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.
- 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.batch
-
SearchCollector provides an extension for collecting a set of database
documents based on a search.
- SearchCollector(DatabaseClient) - Constructor for class com.marklogic.client.example.batch.SearchCollector
-
- SearchCollector.CollectorResults - Class in com.marklogic.client.example.batch
-
- SearchCollectorExample - Class in com.marklogic.client.example.batch
-
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.batch.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.
- SearchResults - Interface in com.marklogic.client.query
-
The SearchResults represent the set of results returned by a search.
- serialize() - Method in class com.marklogic.client.query.StructuredQueryBuilder.Box
-
- serialize() - Method in class com.marklogic.client.query.StructuredQueryBuilder.Circle
-
- serialize() - Method in class com.marklogic.client.query.StructuredQueryBuilder.Point
-
- serialize() - Method in class com.marklogic.client.query.StructuredQueryBuilder.Polygon
-
- serialize() - Method in class com.marklogic.client.query.StructuredQueryBuilder.Region
-
- 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.
- 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
-
- set(Document) - Method in class com.marklogic.client.example.handle.DOM4JHandle
-
- 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(JsonNode) - Method in class com.marklogic.client.example.handle.JacksonHandle
-
- set(Document) - Method in class com.marklogic.client.example.handle.JDOMHandle
-
- 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.example.handle.XOMHandle
-
- 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(Object) - Method in class com.marklogic.client.io.JAXBHandle
-
Assigns the root object of the JAXB structure for 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
-
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.
- 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.batch.OpenCSVBatcher
-
- setBuilder(SAXBuilder) - Method in class com.marklogic.client.example.handle.JDOMHandle
-
- setBuilder(Builder) - Method in class com.marklogic.client.example.handle.XOMHandle
-
- 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
-
- 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
-
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
-
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
-
Specifies whether the server requires, allows, or ignores document versionss
on document read, write, and delete requests.
- 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, that is the query string.
- 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
-
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.
- 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
-
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.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.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.
- setExtractMetadata(QueryOptions.QueryExtractMetadata) - Method in class com.marklogic.client.admin.config.QueryOptions
-
Deprecated.
- setExtractMetadata(QueryOptions.QueryExtractMetadata) - Method in class com.marklogic.client.io.QueryOptionsHandle
-
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
-
Sets the force DOM flag.
- 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
-
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.DOM4JHandle
-
- setFormat(Format) - Method in class com.marklogic.client.example.handle.HTMLCleanerHandle
-
- setFormat(Format) - Method in class com.marklogic.client.example.handle.JacksonHandle
-
- setFormat(Format) - Method in class com.marklogic.client.example.handle.JDOMHandle
-
- setFormat(Format) - Method in class com.marklogic.client.example.handle.XOMHandle
-
- 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
-
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
-
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
-
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.
- setHasHeader(boolean) - Method in class com.marklogic.client.example.batch.OpenCSVBatcher
-
- setHeatmap(QueryOptions.Heatmap) - Method in class com.marklogic.client.admin.config.support.HeatmapAndOptions
-
- 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
-
- 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.
- setMetadataCategories(Set<DocumentManager.Metadata>) - Method in interface com.marklogic.client.document.DocumentManager
-
Specifies the categories of metadata to read or write
- setMetadataCategories(DocumentManager.Metadata...) - Method in interface com.marklogic.client.document.DocumentManager
-
Specifies the categories of metadata to read or write
- 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.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.
- 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
-
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.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.example.handle.DOM4JHandle
-
- setOutputter(XMLOutputter) - Method in class com.marklogic.client.example.handle.JDOMHandle
-
- 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.batch.SearchCollector
-
- setPageLength(Long) - Method in class com.marklogic.client.io.QueryOptionsHandle
-
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
-
- 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
-
- 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.
- 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 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
-
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.
- 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.example.handle.DOM4JHandle
-
- setReadTransform(ServerTransform) - Method in interface com.marklogic.client.document.DocumentManager
-
Specifies a read 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.
- 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
-
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
-
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
-
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
-
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
-
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
-
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
-
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
-
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
-
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
-
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
-
Sets the return values option in the query options.
- 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
-
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
-
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
-
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
-
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.
- 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
-
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
-
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
-
Set the transform results in the query options.
- setTuples(List<QueryOptions.QueryTuples>) - Method in class com.marklogic.client.io.QueryOptionsHandle
-
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.
- setUpExample(DatabaseClient) - Static method in class com.marklogic.client.example.batch.BatchManagerExample
-
- setUpExample(DatabaseClient) - Static method in class com.marklogic.client.example.batch.SearchCollectorExample
-
- 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(XMLDocumentManager, String, String) - 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.StringSearch
-
- setUpExample(DatabaseClient) - Static method in class com.marklogic.client.example.cookbook.StructuredSearch
-
- 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
-
- setValues(List<QueryOptions.QueryValues>) - Method in class com.marklogic.client.io.QueryOptionsHandle
-
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.
- 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 read transform for read requests that don't specify a transform
- 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.
- split(XMLWriteHandle) - Method in class com.marklogic.client.example.batch.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 default page for search results.
- 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(String) - Constructor for class com.marklogic.client.query.StructuredQueryBuilder
-
- StructuredQueryBuilder.AndNotQuery - Class in com.marklogic.client.query
-
- StructuredQueryBuilder.AndNotQuery(StructuredQueryDefinition, StructuredQueryDefinition) - Constructor for class com.marklogic.client.query.StructuredQueryBuilder.AndNotQuery
-
- StructuredQueryBuilder.AndQuery - Class in com.marklogic.client.query
-
- StructuredQueryBuilder.AndQuery(StructuredQueryDefinition...) - Constructor for class com.marklogic.client.query.StructuredQueryBuilder.AndQuery
-
- StructuredQueryBuilder.Box - Class in com.marklogic.client.query
-
- StructuredQueryBuilder.Box(double, double, double, double) - Constructor for class com.marklogic.client.query.StructuredQueryBuilder.Box
-
- StructuredQueryBuilder.Circle - Class in com.marklogic.client.query
-
- StructuredQueryBuilder.Circle(double, double, double) - Constructor for class com.marklogic.client.query.StructuredQueryBuilder.Circle
-
- StructuredQueryBuilder.CollectionConstraintQuery - Class in com.marklogic.client.query
-
- StructuredQueryBuilder.CollectionConstraintQuery(String, String...) - Constructor for class com.marklogic.client.query.StructuredQueryBuilder.CollectionConstraintQuery
-
- StructuredQueryBuilder.CollectionQuery - Class in com.marklogic.client.query
-
- StructuredQueryBuilder.CollectionQuery(String...) - Constructor for class com.marklogic.client.query.StructuredQueryBuilder.CollectionQuery
-
- StructuredQueryBuilder.CustomConstraintQuery - Class in com.marklogic.client.query
-
- StructuredQueryBuilder.CustomConstraintQuery(String, String...) - Constructor for class com.marklogic.client.query.StructuredQueryBuilder.CustomConstraintQuery
-
- StructuredQueryBuilder.DirectoryQuery - Class in com.marklogic.client.query
-
- StructuredQueryBuilder.DirectoryQuery(boolean, String...) - Constructor for class com.marklogic.client.query.StructuredQueryBuilder.DirectoryQuery
-
- StructuredQueryBuilder.DocumentFragmentQuery - Class in com.marklogic.client.query
-
- StructuredQueryBuilder.DocumentFragmentQuery(StructuredQueryDefinition) - Constructor for class com.marklogic.client.query.StructuredQueryBuilder.DocumentFragmentQuery
-
- StructuredQueryBuilder.DocumentQuery - Class in com.marklogic.client.query
-
- StructuredQueryBuilder.DocumentQuery(String) - Constructor for class com.marklogic.client.query.StructuredQueryBuilder.DocumentQuery
-
- StructuredQueryBuilder.ElementConstraintQuery - Class in com.marklogic.client.query
-
- StructuredQueryBuilder.ElementConstraintQuery(String, StructuredQueryDefinition) - Constructor for class com.marklogic.client.query.StructuredQueryBuilder.ElementConstraintQuery
-
- StructuredQueryBuilder.GeospatialConstraintQuery - Class in com.marklogic.client.query
-
- StructuredQueryBuilder.GeospatialConstraintQuery(String, StructuredQueryBuilder.Region...) - Constructor for class com.marklogic.client.query.StructuredQueryBuilder.GeospatialConstraintQuery
-
- StructuredQueryBuilder.LocksQuery - Class in com.marklogic.client.query
-
- StructuredQueryBuilder.LocksQuery(StructuredQueryDefinition) - Constructor for class com.marklogic.client.query.StructuredQueryBuilder.LocksQuery
-
- StructuredQueryBuilder.NearQuery - Class in com.marklogic.client.query
-
- StructuredQueryBuilder.NearQuery(StructuredQueryDefinition...) - Constructor for class com.marklogic.client.query.StructuredQueryBuilder.NearQuery
-
- StructuredQueryBuilder.NearQuery(int, double, StructuredQueryBuilder.Ordering, StructuredQueryDefinition...) - Constructor for class com.marklogic.client.query.StructuredQueryBuilder.NearQuery
-
- StructuredQueryBuilder.NotQuery - Class in com.marklogic.client.query
-
- StructuredQueryBuilder.NotQuery(StructuredQueryDefinition) - Constructor for class com.marklogic.client.query.StructuredQueryBuilder.NotQuery
-
- StructuredQueryBuilder.Operator - Enum in com.marklogic.client.query
-
- StructuredQueryBuilder.Ordering - Enum in com.marklogic.client.query
-
- StructuredQueryBuilder.OrQuery - Class in com.marklogic.client.query
-
- StructuredQueryBuilder.OrQuery(StructuredQueryDefinition...) - Constructor for class com.marklogic.client.query.StructuredQueryBuilder.OrQuery
-
- StructuredQueryBuilder.Point - Class in com.marklogic.client.query
-
- StructuredQueryBuilder.Point(double, double) - Constructor for class com.marklogic.client.query.StructuredQueryBuilder.Point
-
- StructuredQueryBuilder.Polygon - Class in com.marklogic.client.query
-
- StructuredQueryBuilder.Polygon(StructuredQueryBuilder.Point...) - Constructor for class com.marklogic.client.query.StructuredQueryBuilder.Polygon
-
- StructuredQueryBuilder.PropertiesConstraintQuery - Class in com.marklogic.client.query
-
- StructuredQueryBuilder.PropertiesConstraintQuery(String, StructuredQueryDefinition) - Constructor for class com.marklogic.client.query.StructuredQueryBuilder.PropertiesConstraintQuery
-
- StructuredQueryBuilder.PropertiesQuery - Class in com.marklogic.client.query
-
- StructuredQueryBuilder.PropertiesQuery(StructuredQueryDefinition) - Constructor for class com.marklogic.client.query.StructuredQueryBuilder.PropertiesQuery
-
- StructuredQueryBuilder.RangeConstraintQuery - Class in com.marklogic.client.query
-
- StructuredQueryBuilder.RangeConstraintQuery(String, StructuredQueryBuilder.Operator, String...) - Constructor for class com.marklogic.client.query.StructuredQueryBuilder.RangeConstraintQuery
-
- StructuredQueryBuilder.Region - Class in com.marklogic.client.query
-
- StructuredQueryBuilder.Region() - Constructor for class com.marklogic.client.query.StructuredQueryBuilder.Region
-
- StructuredQueryBuilder.TermQuery - Class in com.marklogic.client.query
-
- StructuredQueryBuilder.TermQuery(double, String...) - Constructor for class com.marklogic.client.query.StructuredQueryBuilder.TermQuery
-
- StructuredQueryBuilder.ValueConstraintQuery - Class in com.marklogic.client.query
-
- StructuredQueryBuilder.ValueConstraintQuery(String, String...) - Constructor for class com.marklogic.client.query.StructuredQueryBuilder.ValueConstraintQuery
-
- StructuredQueryBuilder.ValueConstraintQuery(String, double, String...) - Constructor for class com.marklogic.client.query.StructuredQueryBuilder.ValueConstraintQuery
-
- StructuredQueryBuilder.WordConstraintQuery - Class in com.marklogic.client.query
-
- StructuredQueryBuilder.WordConstraintQuery(String, String...) - Constructor for class com.marklogic.client.query.StructuredQueryBuilder.WordConstraintQuery
-
- StructuredQueryBuilder.WordConstraintQuery(String, double, String...) - Constructor for class com.marklogic.client.query.StructuredQueryBuilder.WordConstraintQuery
-
- StructuredQueryDefinition - Interface in com.marklogic.client.query
-
A StructuredQueryDefinition represents the criteria associated with 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.
- suggest(String, Integer, Integer, String...) - Method in class com.marklogic.client.example.cookbook.ResourceExtension.DictionaryManager
-
- 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.
- valueConstraint(String, String...) - Method in class com.marklogic.client.query.StructuredQueryBuilder
-
- valueConstraint(String, double, String...) - Method in class com.marklogic.client.query.StructuredQueryBuilder
-
- 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.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.XMLDocumentManager.DocumentRepair
-
Returns the enum constant of this type with the specified name.
- valueOf(String) - Static method in enum com.marklogic.client.example.batch.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.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.
- 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.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.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.batch.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, 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.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
-
- 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.
- ValuesOrTuples - Interface in com.marklogic.client.admin.config.support
-
Marks classes that can comprise values or tuples
definitions.
- 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(Document) - Method in class com.marklogic.client.example.handle.DOM4JHandle
-
- 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(JsonNode) - Method in class com.marklogic.client.example.handle.JacksonHandle
-
- with(Document) - Method in class com.marklogic.client.example.handle.JDOMHandle
-
- 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.example.handle.XOMHandle
-
- 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(Object) - 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
-
Sets the ctsQuery element in the query options.
- withConfiguration(QueryOptionsConfiguration) - Method in class com.marklogic.client.io.QueryOptionsHandle
-
Set common configuration objects for this handle, fluently.
- withConstraints(QueryOptions.QueryConstraint...) - Method in class com.marklogic.client.io.QueryOptionsHandle
-
Set a List of constraints in the query options.
- withDelete(String) - Method in class com.marklogic.client.example.batch.BatchManager.BatchRequest
-
- withExtractMetadata(QueryOptions.QueryExtractMetadata) - Method in class com.marklogic.client.io.QueryOptionsHandle
-
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 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
-
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.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
-
Sets a List of operators in the query options.
- withPageLength(Long) - Method in class com.marklogic.client.admin.config.QueryOptions.QueryState
-
Deprecated.
- withQualityWeight(Double) - Method in class com.marklogic.client.admin.config.QueryOptions.QueryState
-
Deprecated.
- withRead(String, String) - Method in class com.marklogic.client.example.batch.BatchManager.BatchRequest
-
- withRead(String, DocumentManager.Metadata, String) - Method in class com.marklogic.client.example.batch.BatchManager.BatchRequest
-
- withRead(String, Set<DocumentManager.Metadata>, String) - Method in class com.marklogic.client.example.batch.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
-
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
-
Set a List of sort orders in the query options.
- withTerm(QueryOptions.QueryTerm) - Method in class com.marklogic.client.io.QueryOptionsHandle
-
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
-
Set the transform results in the query options.
- withTuples(QueryOptions.QueryTuples...) - Method in class com.marklogic.client.io.QueryOptionsHandle
-
Sets a List of tuples in the query options.
- withValues(QueryOptions.QueryValues...) - Method in class com.marklogic.client.io.QueryOptionsHandle
-
Sets a List of values in the query options.
- withWrite(String, AbstractWriteHandle) - Method in class com.marklogic.client.example.batch.BatchManager.BatchRequest
-
- withWrite(String, DocumentMetadataHandle, AbstractWriteHandle) - Method in class com.marklogic.client.example.batch.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.
- wordConstraint(String, String...) - Method in class com.marklogic.client.query.StructuredQueryBuilder
-
- wordConstraint(String, double, String...) - Method in class com.marklogic.client.query.StructuredQueryBuilder
-
- 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.batch.OpenCSVBatcher
-
- write(Reader, String) - Method in class com.marklogic.client.example.batch.OpenCSVBatcher
-
- write(Reader, QName) - Method in class com.marklogic.client.example.batch.OpenCSVBatcher
-
- write(Reader, String, String) - Method in class com.marklogic.client.example.batch.OpenCSVBatcher
-
- write(Reader, String, QName) - Method in class com.marklogic.client.example.batch.OpenCSVBatcher
-
- write(Reader, String, String, QName...) - Method in class com.marklogic.client.example.batch.OpenCSVBatcher
-
- write(Reader, String, QName, QName...) - Method in class com.marklogic.client.example.batch.OpenCSVBatcher
-
- write(OutputStream) - Method in class com.marklogic.client.example.handle.DOM4JHandle
-
- write(OutputStream) - Method in class com.marklogic.client.example.handle.HTMLCleanerHandle
-
- write(OutputStream) - Method in class com.marklogic.client.example.handle.JacksonHandle
-
- write(OutputStream) - Method in class com.marklogic.client.example.handle.JDOMHandle
-
- write(OutputStream) - Method in class com.marklogic.client.example.handle.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
-
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
-
- 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.
- 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
-
- 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.
- 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
-
Installs a transform implemented in XQuery.
- 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
-
Installs a transform implemented in XSL.