Uses of Package
com.marklogic.client.admin.config

Packages that use com.marklogic.client.admin.config

Package	Description
com.marklogic.client.admin.config	The package provides classes and interfaces that implement MarkLogic Search API configuration using Java Objects.
com.marklogic.client.admin.config.support	Interfaces and classes used by QueryOptionsBuilder, QueryOptions, and QueryOptionsHandle to comprise builder expressions and mark function arguments.
com.marklogic.client.io	The package provides the handle classes with different representations for document content when you read documents from the database or write documents to the database.

Classes in com.marklogic.client.admin.config used by com.marklogic.client.admin.config

Class and Description
QueryOptions Deprecated. Use a JSON or XML write handle or read handle implementation instead of this class to write or read query options. For instance: String opts = new StringBuilder() .append("<options xmlns=\"http://marklogic.com/appservices/search\">") .append( "<debug>true</debug>") .append("</options>") .toString(); optsMgr.writeOptions("debug", new StringHandle(opts)); or String opts = "{\"options\":{\"debug\":true}}"; optsMgr.writeOptions("debug", new StringHandle(opts).withFormat(Format.JSON));
QueryOptions.Aggregate Deprecated. Corresponds to aggregate element in Search API configuration.
QueryOptions.AttributeOrElementValue Deprecated. Wraps access to attributes and elements in one superclass.
QueryOptions.AttributeValue Deprecated. Models access to an attribute by QName for use in metadata extraction
QueryOptions.BaseConstraintItem Deprecated. Partial implementation of A ConstraintSource.
QueryOptions.ConstraintValue Deprecated. Models access to values returned by a constraint, by constraint name.
QueryOptions.DefaultTermSource Deprecated. The source of data for a default term search.
QueryOptions.ElementValue Deprecated. Models access to an element by QName for use in metadata extraction
QueryOptions.ExpressionNamespaceBinding Deprecated. An encapsulation of a prefix and a namespace URI for use in xpath expression evaluation.
QueryOptions.ExpressionNamespaceBindings Deprecated. A list of ExpressionNamespaceBinding objects.
QueryOptions.FacetableConstraintConfiguration Deprecated. Partial implementation of constraint sources that can have facets
QueryOptions.Facets Deprecated. Two possible states for faceting.
QueryOptions.Field Deprecated. Models a field.
QueryOptions.FragmentScope Deprecated. Enumeration of the two possibilities for Fragment scope.
QueryOptions.Heatmap Deprecated. Models a two-dimensional grid used to categorize data along two dimensions.
QueryOptions.JsonKey Deprecated. Models a JSON Key.
QueryOptions.MarkLogicQName Deprecated. Models a QName, as encoded with attributes for several parts of the Search API
QueryOptions.PathIndex Deprecated. Models a Path Index specification.
QueryOptions.QueryAdditionalQuery Deprecated. Wraps a cts:query element to be used in addition to other query configuration options, as an ANDed query.
QueryOptions.QueryAnnotation Deprecated. Models annotations for search API documents
QueryOptions.QueryCollection Deprecated. Models a constraint on collection URIs.
QueryOptions.QueryConstraint Deprecated. Models a constraint node in Search API configuration.
QueryOptions.QueryCustom Deprecated. A custom constraint.
QueryOptions.QueryDefaultSuggestionSource Deprecated. Models the default source for calls to the search:suggest XQuery function.
QueryOptions.QueryElementQuery Deprecated. Models an Element Query constraint
QueryOptions.QueryExtractMetadata Deprecated. Models specification for extracting document metadata in search results.
QueryOptions.QueryGeospatialAttributePair Deprecated. Models a geospatial index with coordinates stored in a pair of attributes
QueryOptions.QueryGeospatialElement Deprecated. Models a geospatial index with coordinates stored in a single element.
QueryOptions.QueryGeospatialElementPair Deprecated. Models a geospatial index with coordinates stored in a pair of elements.
QueryOptions.QueryGrammar Deprecated. Models an extension to the default grammar for search strings.
QueryOptions.QueryGrammar.QueryJoiner A Query Joiner combines two terms as part of a query grammar.
QueryOptions.QueryGrammar.QueryJoiner.Comparator A Comparator enumerates the possible binary relations for constraining an index with a value.
QueryOptions.QueryGrammar.QueryJoiner.JoinerApply A JoinerApply enumerates the built-in functions available to join the terms.
QueryOptions.QueryGrammar.QueryStarter A Query Starter delimits a term as part of a query grammar.
QueryOptions.QueryGrammar.QueryStarter.StarterApply A StarterApply enumerates the built-in functions available to start terms.
QueryOptions.QueryGrammar.Tokenize Tokenize enumerates how terms are distinguished for a joiner.
QueryOptions.QueryOperator Deprecated. Represents how query terms are to be combined.
QueryOptions.QueryRange Deprecated. Models a range constraint source.
QueryOptions.QueryRange.Bucket Configures a range, for use in grouping range index values in facets.
QueryOptions.QueryRange.ComputedBucket Models a bucket on a range constraint whose values are anchored to time, and computed based on the current time.
QueryOptions.QueryRange.ComputedBucket.AnchorValue Defines values for use in computed buckets anchored to time.
QueryOptions.QuerySearchableExpression Deprecated. Models a searchable expression.
QueryOptions.QuerySortOrder Deprecated. Models criteria for sorting results.
QueryOptions.QuerySortOrder.Direction Direction enumerates the order for sorting values.
QueryOptions.QuerySortOrder.Score Score enumerates whether or not the relevance score is used.
QueryOptions.QueryState Deprecated. Models a named state to be triggered by inclusion of this name in an operator search string
QueryOptions.QuerySuggestionSource Deprecated. Models a source for calls to the search:suggest XQuery function.
QueryOptions.QueryTerm Deprecated. Models configuration for a search API term.
QueryOptions.QueryTerm.TermApply The TermApply enumeration provides the special circumstances of an empty search string.
QueryOptions.QueryTransformResults Deprecated. Models configurations that transform search results.
QueryOptions.QueryTuples Deprecated. Models configurations that extract co-occurring values from lexicons Use two or more sources to retrieve tuples from the database.
QueryOptions.QueryValues Deprecated. Models configurations that extract values from lexicons
QueryOptions.QueryWord Deprecated. Models a word constraint
QueryOptions.WordLexicon Deprecated. Models the word lexicon, as a source of tems for suggestions.
QueryOptions.XQueryExtension Deprecated. Models a method to locate XQuery functions with use of "ns", "apply" and "at" attributes.

Classes in com.marklogic.client.admin.config used by com.marklogic.client.admin.config.support

Class and Description
QueryOptions.Field Deprecated. Models a field.
QueryOptions.FragmentScope Deprecated. Enumeration of the two possibilities for Fragment scope.
QueryOptions.Heatmap Deprecated. Models a two-dimensional grid used to categorize data along two dimensions.
QueryOptions.JsonKey Deprecated. Models a JSON Key.
QueryOptions.MarkLogicQName Deprecated. Models a QName, as encoded with attributes for several parts of the Search API
QueryOptions.PathIndex Deprecated. Models a Path Index specification.
QueryOptions.QueryAnnotation Deprecated. Models annotations for search API documents
QueryOptions.QueryExtractMetadata Deprecated. Models specification for extracting document metadata in search results.
QueryOptions.QueryTuples Deprecated. Models configurations that extract co-occurring values from lexicons Use two or more sources to retrieve tuples from the database.
QueryOptions.QueryValues Deprecated. Models configurations that extract values from lexicons

Classes in com.marklogic.client.admin.config used by com.marklogic.client.io

Class and Description
QueryOptions Deprecated. Use a JSON or XML write handle or read handle implementation instead of this class to write or read query options. For instance: String opts = new StringBuilder() .append("<options xmlns=\"http://marklogic.com/appservices/search\">") .append( "<debug>true</debug>") .append("</options>") .toString(); optsMgr.writeOptions("debug", new StringHandle(opts)); or String opts = "{\"options\":{\"debug\":true}}"; optsMgr.writeOptions("debug", new StringHandle(opts).withFormat(Format.JSON));
QueryOptions.FragmentScope Deprecated. Enumeration of the two possibilities for Fragment scope.
QueryOptions.QueryAdditionalQuery Deprecated. Wraps a cts:query element to be used in addition to other query configuration options, as an ANDed query.
QueryOptions.QueryAnnotation Deprecated. Models annotations for search API documents
QueryOptions.QueryConstraint Deprecated. Models a constraint node in Search API configuration.
QueryOptions.QueryDefaultSuggestionSource Deprecated. Models the default source for calls to the search:suggest XQuery function.
QueryOptions.QueryExtractMetadata Deprecated. Models specification for extracting document metadata in search results.
QueryOptions.QueryGrammar Deprecated. Models an extension to the default grammar for search strings.
QueryOptions.QueryOperator Deprecated. Represents how query terms are to be combined.
QueryOptions.QuerySearchableExpression Deprecated. Models a searchable expression.
QueryOptions.QuerySortOrder Deprecated. Models criteria for sorting results.
QueryOptions.QuerySuggestionSource Deprecated. Models a source for calls to the search:suggest XQuery function.
QueryOptions.QueryTerm Deprecated. Models configuration for a search API term.
QueryOptions.QueryTransformResults Deprecated. Models configurations that transform search results.
QueryOptions.QueryTuples Deprecated. Models configurations that extract co-occurring values from lexicons Use two or more sources to retrieve tuples from the database.
QueryOptions.QueryValues Deprecated. Models configurations that extract values from lexicons