Skip navigation links

Package com.marklogic.client.admin.config

The package provides classes and interfaces that implement MarkLogic Search API configuration using Java Objects.

See: Description

Package com.marklogic.client.admin.config Description

The package provides classes and interfaces that implement MarkLogic Search API configuration using Java Objects.

Ordinarily, objects in this package will be created in one of two ways: by retrieving them from a MarkLogic Server using a QueryOptionsHandle or by building them with QueryOptionsBuilder.

A QueryOptions object contains getters and setters for each of the types of information that comprise a Search API configuration. These options include constraints, tuples configurations, operators, a grammar element, and options for configuring the result.

The classes of each kind of configuration object are enclosed within QueryOptions. For example, QueryOptions.QueryGrammar models the set of configuration elements that comprise a grammar. QueryOptions.QueryGeospatialElement models access to a particular geospatial index configuration that uses an element to encode coordinates. QueryOptions.QueryTerm contains the behavior of bare search terms in a Search string configuration.

While you can access and manipulate query options configurations in this way, it is simpler to build fresh ones with QueryOptionsBuilder.

QueryOptions, when stored on the server and referenced from a subsequent request, control the behavior and results of calls to QueryManager.search(), QueryManager.values(), and QueryManager.tuples()

For comprehensive treatment of the Search API, the REST API and the Java API visit http://docs.marklogic.com

Note: QueryOptions and QueryOptionsBuilder are deprecated. Use a JSON or XML handle instead to write or read query options.

Skip navigation links

Copyright © 2013-2016 MarkLogic Corporation.