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));
@Deprecated public final class QueryOptions extends Object implements Annotatable<QueryOptions>
Modifier and Type | Class and Description |
---|---|
static class |
QueryOptions.Aggregate
Deprecated.
Corresponds to aggregate element in Search API configuration.
|
static class |
QueryOptions.AttributeOrElementValue
Deprecated.
Wraps access to attributes and elements in one superclass.
|
static class |
QueryOptions.AttributeValue
Deprecated.
Models access to an attribute by QName for use in metadata extraction
|
static class |
QueryOptions.BaseConstraintItem
Deprecated.
Partial implementation of A ConstraintSource.
|
static class |
QueryOptions.ConstraintValue
Deprecated.
Models access to values returned by a constraint, by constraint name.
|
static class |
QueryOptions.DefaultTermSource
Deprecated.
The source of data for a default term search.
|
static class |
QueryOptions.ElementValue
Deprecated.
Models access to an element by QName for use in metadata extraction
|
static class |
QueryOptions.ExpressionNamespaceBinding
Deprecated.
An encapsulation of a prefix and a namespace URI for use in xpath expression evaluation.
|
static class |
QueryOptions.ExpressionNamespaceBindings
Deprecated.
A list of ExpressionNamespaceBinding objects.
|
static class |
QueryOptions.FacetableConstraintConfiguration
Deprecated.
Partial implementation of constraint sources that can have facets
|
static class |
QueryOptions.Facets
Deprecated.
Two possible states for faceting.
|
static class |
QueryOptions.Field
Deprecated.
Models a field.
|
static class |
QueryOptions.FragmentScope
Deprecated.
Enumeration of the two possibilities for Fragment scope.
|
static class |
QueryOptions.Heatmap
Deprecated.
Models a two-dimensional grid used to categorize data along two dimensions.
|
static class |
QueryOptions.JsonKey
Deprecated.
Models a JSON Key.
|
static class |
QueryOptions.MarkLogicQName
Deprecated.
Models a QName, as encoded with attributes for several parts of the Search API
|
static class |
QueryOptions.PathIndex
Deprecated.
Models a Path Index specification.
|
static class |
QueryOptions.PreferredElements
Deprecated.
Models preferred elements.
|
static class |
QueryOptions.QueryAdditionalQuery
Deprecated.
Wraps a cts:query element to be used in addition to other
query configuration options, as an ANDed query.
|
static class |
QueryOptions.QueryAnnotation
Deprecated.
Models annotations for search API documents
|
static class |
QueryOptions.QueryCollection
Deprecated.
Models a constraint on collection URIs.
|
static class |
QueryOptions.QueryConstraint
Deprecated.
Models a constraint node in Search API configuration.
|
static class |
QueryOptions.QueryCustom
Deprecated.
A custom constraint.
|
static class |
QueryOptions.QueryDefaultSuggestionSource
Deprecated.
Models the default source for calls to the search:suggest XQuery function.
|
static class |
QueryOptions.QueryElementQuery
Deprecated.
Models an Element Query constraint
|
static class |
QueryOptions.QueryExtractMetadata
Deprecated.
Models specification for extracting document metadata in search results.
|
static class |
QueryOptions.QueryGeospatialAttributePair
Deprecated.
Models a geospatial index with coordinates stored in a pair of attributes
|
static class |
QueryOptions.QueryGeospatialElement
Deprecated.
Models a geospatial index with coordinates stored in a single element.
|
static class |
QueryOptions.QueryGeospatialElementPair
Deprecated.
Models a geospatial index with coordinates stored in a pair of elements.
|
static class |
QueryOptions.QueryGrammar
Deprecated.
Models an extension to the default grammar for search strings.
|
static class |
QueryOptions.QueryOperator
Deprecated.
Represents how query terms are to be combined.
|
static class |
QueryOptions.QueryProperties
Deprecated.
Corresponds to the <properties> constraint type in the MarkLogic
Search API
|
static class |
QueryOptions.QueryRange
Deprecated.
Models a range constraint source.
|
static class |
QueryOptions.QuerySearchableExpression
Deprecated.
Models a searchable expression.
|
static class |
QueryOptions.QuerySortOrder
Deprecated.
Models criteria for sorting results.
|
static class |
QueryOptions.QueryState
Deprecated.
Models a named state to be triggered by inclusion of this name in an operator search string
|
static class |
QueryOptions.QuerySuggestionSource
Deprecated.
Models a source for calls to the search:suggest XQuery function.
|
static class |
QueryOptions.QueryTerm
Deprecated.
Models configuration for a search API term.
|
static class |
QueryOptions.QueryTransformResults
Deprecated.
Models configurations that transform search results.
|
static class |
QueryOptions.QueryTuples
Deprecated.
Models configurations that extract co-occurring values from lexicons
Use two or more sources to retrieve tuples from the database.
|
static class |
QueryOptions.QueryValue
Deprecated.
Models a value constraint
|
static class |
QueryOptions.QueryValues
Deprecated.
Models configurations that extract values from lexicons
|
static class |
QueryOptions.QueryWord
Deprecated.
Models a word constraint
|
static class |
QueryOptions.WordLexicon
Deprecated.
Models the word lexicon, as a source of tems for suggestions.
|
static class |
QueryOptions.XQueryExtension
Deprecated.
Models a method to locate XQuery functions with use of "ns", "apply"
and "at" attributes.
|
Modifier and Type | Field and Description |
---|---|
static String |
DEFAULT_COLLATION
Deprecated.
|
static String |
SEARCH_NS
Deprecated.
|
Constructor and Description |
---|
QueryOptions()
Deprecated.
|
public static final String DEFAULT_COLLATION
public static final String SEARCH_NS
public void setSearchableExpressionNamespaceContext(QueryOptions.ExpressionNamespaceBinding[] bindingsArray)
public void addForest(Long forest)
public void addSearchOption(String searchOption)
public Element getAdditionalQuery()
public List<QueryOptions.QueryAnnotation> getAnnotations()
getAnnotations
in interface Annotatable<QueryOptions>
public QueryOptions annotate(String xmlAnnotation)
annotate
in interface Annotatable<QueryOptions>
public Integer getConcurrencyLevel()
public Boolean getDebug()
public QueryOptions.QueryDefaultSuggestionSource getDefaultSuggestionSource()
public QueryOptions.QueryExtractMetadata getExtractMetadata()
public String getFragmentScope()
public QueryOptions.QueryGrammar getGrammar()
public Long getPageLength()
public Double getQualityWeight()
public List<QueryOptions.QueryConstraint> getQueryConstraints()
public List<QueryOptions.QueryOperator> getQueryOperators()
public List<QueryOptions.QueryValues> getQueryValues()
public List<QueryOptions.QueryTuples> getQueryTuples()
public Boolean getReturnAggregates()
public Boolean getReturnConstraints()
public Boolean getReturnFacets()
public Boolean getReturnFrequencies()
public Boolean getReturnMetrics()
public Boolean getReturnPlan()
public Boolean getReturnQtext()
public Boolean getReturnQuery()
public Boolean getReturnResults()
public Boolean getReturnSimilar()
public Boolean getReturnValues()
public EditableNamespaceContext getSearchableExpressionNamespaceContext()
public String getSearchableExpression()
public List<QueryOptions.QuerySortOrder> getSortOrders()
public List<QueryOptions.QuerySuggestionSource> getSuggestionSources()
public QueryOptions.QueryTerm getTerm()
public QueryOptions.QueryTransformResults getTransformResults()
public void setAdditionalQuery(Element additionalQuery)
public void setConcurrencyLevel(Integer concurrencyLevel)
public void setDebug(Boolean debug)
public void setDefaultSuggestionSource(QueryOptions.QueryDefaultSuggestionSource dss)
public void setExtractMetadata(QueryOptions.QueryExtractMetadata extractMetadata)
public void setFragmentScope(QueryOptions.FragmentScope fragmentScope)
public void setGrammar(QueryOptions.QueryGrammar grammarOption)
public void setOperators(List<QueryOptions.QueryOperator> operatorOptions)
public void setPageLength(Long pageLength)
public void setQualityWeight(Double qualityWeight)
public void setQueryValues(List<QueryOptions.QueryValues> values)
public void setQueryTuples(List<QueryOptions.QueryTuples> tuples)
public void setReturnAggregates(Boolean returnAggregates)
public void setReturnConstraints(Boolean returnConstraints)
public void setReturnFacets(Boolean returnFacets)
public void setReturnFrequencies(Boolean returnFrequencies)
public void setReturnMetrics(Boolean returnMetrics)
public void setReturnPlan(Boolean returnPlan)
public void setReturnQtext(Boolean returnQtext)
public void setReturnQuery(Boolean returnQuery)
public void setReturnResults(Boolean returnResults)
public void setReturnSimilar(Boolean returnSimilar)
public void setReturnValues(Boolean returnValues)
public void setSearchableExpression(QueryOptions.QuerySearchableExpression searchableExpression)
public void setSearchableExpressionNamespaceContext(EditableNamespaceContext context)
public void setSortOrders(List<QueryOptions.QuerySortOrder> sortOrders)
public void setSuggestionSources(List<QueryOptions.QuerySuggestionSource> suggestionSourceOptions)
public void setTerm(QueryOptions.QueryTerm termConfig)
public void setTransformResults(QueryOptions.QueryTransformResults transformResultsOption)
public void patchBindings()
public void setConstraints(List<QueryOptions.QueryConstraint> constraints)
constraints
- the constraintsCopyright © 2013-2016 MarkLogic Corporation.