See: Description
Class | Description |
---|---|
QueryOptions | Deprecated
Use a JSON or XML
write handle or
read handle
implementation instead of this class to write or read
query options. |
QueryOptions.Aggregate |
Corresponds to aggregate element in Search API configuration.
|
QueryOptions.AttributeOrElementValue |
Wraps access to attributes and elements in one superclass.
|
QueryOptions.AttributeValue |
Models access to an attribute by QName for use in metadata extraction
|
QueryOptions.BaseConstraintItem |
Partial implementation of A ConstraintSource.
|
QueryOptions.ConstraintValue |
Models access to values returned by a constraint, by constraint name.
|
QueryOptions.DefaultTermSource |
The source of data for a default term search.
|
QueryOptions.ElementValue |
Models access to an element by QName for use in metadata extraction
|
QueryOptions.ExpressionNamespaceBinding |
An encapsulation of a prefix and a namespace URI for use in xpath expression evaluation.
|
QueryOptions.ExpressionNamespaceBindings |
A list of ExpressionNamespaceBinding objects.
|
QueryOptions.FacetableConstraintConfiguration |
Partial implementation of constraint sources that can have facets
|
QueryOptions.Field |
Models a field.
|
QueryOptions.Heatmap |
Models a two-dimensional grid used to categorize data along two dimensions.
|
QueryOptions.JsonKey |
Models a JSON Key.
|
QueryOptions.MarkLogicQName |
Models a QName, as encoded with attributes for several parts of the Search API
|
QueryOptions.PathIndex |
Models a Path Index specification.
|
QueryOptions.PreferredElements |
Models preferred elements.
|
QueryOptions.QueryAdditionalQuery |
Wraps a cts:query element to be used in addition to other
query configuration options, as an ANDed query.
|
QueryOptions.QueryAnnotation |
Models annotations for search API documents
|
QueryOptions.QueryCollection |
Models a constraint on collection URIs.
|
QueryOptions.QueryConstraint |
Models a constraint node in Search API configuration.
|
QueryOptions.QueryCustom |
A custom constraint.
|
QueryOptions.QueryDefaultSuggestionSource |
Models the default source for calls to the search:suggest XQuery function.
|
QueryOptions.QueryElementQuery |
Models an Element Query constraint
|
QueryOptions.QueryExtractMetadata |
Models specification for extracting document metadata in search results.
|
QueryOptions.QueryGeospatialAttributePair |
Models a geospatial index with coordinates stored in a pair of attributes
|
QueryOptions.QueryGeospatialElement |
Models a geospatial index with coordinates stored in a single element.
|
QueryOptions.QueryGeospatialElementPair |
Models a geospatial index with coordinates stored in a pair of elements.
|
QueryOptions.QueryGrammar |
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.QueryStarter |
A Query Starter delimits a term as part of a query grammar.
|
QueryOptions.QueryOperator |
Represents how query terms are to be combined.
|
QueryOptions.QueryProperties |
Corresponds to the <properties> constraint type in the MarkLogic
Search API
|
QueryOptions.QueryRange |
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.QuerySearchableExpression |
Models a searchable expression.
|
QueryOptions.QuerySortOrder |
Models criteria for sorting results.
|
QueryOptions.QueryState |
Models a named state to be triggered by inclusion of this name in an operator search string
|
QueryOptions.QuerySuggestionSource |
Models a source for calls to the search:suggest XQuery function.
|
QueryOptions.QueryTerm |
Models configuration for a search API term.
|
QueryOptions.QueryTransformResults |
Models configurations that transform search results.
|
QueryOptions.QueryTuples |
Models configurations that extract co-occurring values from lexicons
Use two or more sources to retrieve tuples from the database.
|
QueryOptions.QueryValue |
Models a value constraint
|
QueryOptions.QueryValues |
Models configurations that extract values from lexicons
|
QueryOptions.QueryWord |
Models a word constraint
|
QueryOptions.WordLexicon |
Models the word lexicon, as a source of tems for suggestions.
|
QueryOptions.XQueryExtension |
Models a method to locate XQuery functions with use of "ns", "apply"
and "at" attributes.
|
QueryOptionsBuilder | Deprecated
Use a JSON or XML
write handle or
read handle
implementation instead of this class to write or read
query options. |
Enum | Description |
---|---|
QueryOptions.Facets |
Two possible states for faceting.
|
QueryOptions.FragmentScope |
Enumeration of the two possibilities for Fragment scope.
|
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.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.QueryRange.ComputedBucket.AnchorValue |
Defines values for use in computed buckets anchored to time.
|
QueryOptions.QuerySortOrder.Direction |
Direction enumerates the order for sorting values.
|
QueryOptions.QuerySortOrder.Score |
Score enumerates whether or not the relevance score is used.
|
QueryOptions.QueryTerm.TermApply |
The TermApply enumeration provides the special circumstances of an
empty search string.
|
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.
Copyright © 2013-2016 MarkLogic Corporation.