QueryManager (MarkLogic Java Client API 8.1.0)

Summary:
Nested |
Field |
Constr |
Method

Detail:
Field |
Constr |
Method

SEARCH:

public interface QueryManager

A Query Manager supports searching documents and retrieving values and tuples from lexicons. Query configuration depends on the kind of query definition used, the parameters to that definition, and the server-side options used. Server-side options can be constructed and written to the server with a QueryOptionsManager. Once stored on the server, a set of named query options can be used by any query.

Nested Class Summary

Nested Classes

Modifier and Type

Interface

Description

static enum

QueryManager.QueryView

The view produced by a query.
Field Summary

Fields

Modifier and Type

Field

Description

static final long

DEFAULT_PAGE_LENGTH

The default maximum number of documents in a page of search results.

static final long

START

The offset of the first result in the default page.
Method Summary

Modifier and Type

Method

Description

<T extends StructureReadHandle> T

convert(RawQueryByExampleDefinition query, T convertedHandle)

Sends a query by example to the server to convert into a combined query that expresses the criteria as a structured search.

void

delete(DeleteQueryDefinition querydef)

Deletes documents based on the query criteria.

void

delete(DeleteQueryDefinition querydef, Transaction transaction)

Deletes documents based on the query criteria as part of the specified transaction.

MatchDocumentSummary

findOne(QueryDefinition querydef)

The findOne method is a convenience.

MatchDocumentSummary

findOne(QueryDefinition querydef, Transaction transaction)

The findOne method is a convenience.

long

getPageLength()

Returns the maximum number of documents that can appear in any page of query results.

QueryManager.QueryView

getView()

Returns the type of view results produced by queries.

CtsQueryBuilder

newCtsSearchBuilder()

Returns a new CtsSearchBuilder.

DeleteQueryDefinition

newDeleteDefinition()

Creates a query definition for deleting documents.

RawCombinedQueryDefinition

newRawCombinedQueryDefinition(StructureWriteHandle handle)

Defines a combined query from a JSON or XML representation.

RawCombinedQueryDefinition

newRawCombinedQueryDefinition(StructureWriteHandle handle, String optionsName)

Defines a combined query from a JSON or XML representation.

RawCombinedQueryDefinition

newRawCombinedQueryDefinitionAs(Format format, Object rawQuery)

Defines a combined query from a JSON or XML representation provided as an object of an IO class.

RawCombinedQueryDefinition

newRawCombinedQueryDefinitionAs(Format format, Object rawQuery, String optionsName)

Defines a combined query from a JSON or XML representation provided as an object of an IO class.

RawCtsQueryDefinition

newRawCtsQueryDefinition(CtsQueryWriteHandle handle)

Defines a serialized cts query from a JSON or XML representation.

RawCtsQueryDefinition

newRawCtsQueryDefinition(CtsQueryWriteHandle handle, String optionsName)

Defines a serialized cts query from a JSON or XML representation.

RawCtsQueryDefinition

newRawCtsQueryDefinitionAs(Format format, Object rawQuery)

Defines a serialized cts query from a JSON or XML representation provided as an object of an IO class.

RawCtsQueryDefinition

newRawCtsQueryDefinitionAs(Format format, Object rawQuery, String optionsName)

Defines a serialized cts query from a JSON or XML representation provided as an object of an IO class.

RawQueryByExampleDefinition

newRawQueryByExampleDefinition(StructureWriteHandle handle)

Defines a simple query by example from a JSON or XML representation.

RawQueryByExampleDefinition

newRawQueryByExampleDefinition(StructureWriteHandle handle, String optionsName)

Defines a simple query by example from a JSON or XML representation.

RawQueryByExampleDefinition

newRawQueryByExampleDefinitionAs(Format format, Object rawQuery)

Defines a simple query by example from a JSON or XML representation provided as an object of an IO class.

RawQueryByExampleDefinition

newRawQueryByExampleDefinitionAs(Format format, Object rawQuery, String optionsName)

Defines a simple query by example from a JSON or XML representation provided as an object of an IO class.

RawStructuredQueryDefinition

newRawStructuredQueryDefinition(StructureWriteHandle handle)

Defines a structured query from a JSON or XML representation.

RawStructuredQueryDefinition

newRawStructuredQueryDefinition(StructureWriteHandle handle, String optionsName)

Defines a structured query from a JSON or XML representation.

RawStructuredQueryDefinition

newRawStructuredQueryDefinitionAs(Format format, Object rawQuery)

Defines a structured query from a JSON or XML representation provided as an object of an IO class.

RawStructuredQueryDefinition

newRawStructuredQueryDefinitionAs(Format format, Object rawQuery, String optionsName)

Defines a structured query from a JSON or XML representation provided as an object of an IO class.

StringQueryDefinition

newStringDefinition()

Creates a query definition based on a string and the default query options.

StringQueryDefinition

newStringDefinition(String optionsName)

Creates a query definition based on a string and on named query options saved previously.

StructuredQueryBuilder

newStructuredQueryBuilder()

Creates a query definition based on a structure that identifies clauses and conjunctions and the default query options.

StructuredQueryBuilder

newStructuredQueryBuilder(String optionsName)

Creates a query definition based on a structure and on named query options saved previously.

SuggestDefinition

newSuggestDefinition()

Creates a suggestion definition based on a single string for completion, using the default options node.

SuggestDefinition

newSuggestDefinition(String optionsName)

Creates a suggestion definition based on a query options name.

SuggestDefinition

newSuggestDefinition(String suggestString, String optionsName)

Creates a suggestion definition based on a single string for completion, using the default options node.

ValuesDefinition

newValuesDefinition(String name)

Creates a query definition for retrieving values based on a named constraint on an index and the default query options.

ValuesDefinition

newValuesDefinition(String name, String optionsName)

Creates a query definition for retrieving values based on a named constraint and on named query options saved previously.

ValuesListDefinition

newValuesListDefinition()

Creates a query definition for retrieving the list of available named lexicon configurations from the default query options.

ValuesListDefinition

newValuesListDefinition(String optionsName)

Creates a query definition for retrieving the list of available named lexicon configurations from the named query options.

<T extends QueryOptionsListReadHandle> T

optionsList(T listHandle)

Retrieves the list of available named query options.

<T extends QueryOptionsListReadHandle> T

optionsList(T valueHandle, Transaction transaction)

Retrieves the list of available named query options.

<T extends SearchReadHandle> T

search(SearchQueryDefinition querydef, T searchHandle)

Searches documents based on query criteria and, potentially, previously saved query options.

<T extends SearchReadHandle> T

search(SearchQueryDefinition querydef, T searchHandle, long start)

Searches documents based on query criteria and, potentially, previously saved query options starting with the specified page listing document results.

<T extends SearchReadHandle> T

search(SearchQueryDefinition querydef, T searchHandle, long start, Transaction transaction)

Searches documents based on query criteria and, potentially, previously saved query options starting with the specified page listing document results.

<T extends SearchReadHandle> T

search(SearchQueryDefinition querydef, T searchHandle, long start, Transaction transaction, String forestName)

Searches documents based on query criteria and, potentially, previously saved query options starting with the specified page listing document results.

<T extends SearchReadHandle> T

search(SearchQueryDefinition querydef, T searchHandle, long start, String forestName)

Searches documents based on query criteria and, potentially, previously saved query options starting with the specified page listing document results.

<T extends SearchReadHandle> T

search(SearchQueryDefinition querydef, T searchHandle, Transaction transaction)

Searches documents based on query criteria and, potentially, previously saved query options.

<T extends SearchReadHandle> T

search(SearchQueryDefinition querydef, T searchHandle, Transaction transaction, String forestName)

Searches documents based on query criteria and, potentially, previously saved query options.

<T extends SearchReadHandle> T

search(SearchQueryDefinition querydef, T searchHandle, String forestName)

Searches documents based on query criteria and, potentially, previously saved query options.

void

setPageLength(long length)

Specifies the maximum number of documents that can appear in any page of the query results, overriding any maximum specified in the query options.

void

setView(QueryManager.QueryView view)

Specifies the type of view results produced by queries.

void

startLogging(RequestLogger logger)

Starts debugging client requests.

void

stopLogging()

Stops debugging client requests.

String[]

suggest(SuggestDefinition suggestionDef)

Queries the REST server for suggested string completions based on values in the SuggestionDefinition.

<T extends TuplesReadHandle> T

tuples(ValuesDefinition valdef, T tupleHandle)

Retrieves combinations of values for the same document from indexes based on query criteria and, potentially, previously saved query options.

<T extends TuplesReadHandle> T

tuples(ValuesDefinition valdef, T tupleHandle, long start)

Retrieves combinations of values for the same document from indexes based on query criteria and, potentially, previously saved query options.

<T extends TuplesReadHandle> T

tuples(ValuesDefinition valdef, T tupleHandle, long start, Transaction transaction)

Retrieves combinations of values for the same document from indexes based on query criteria and, potentially, previously saved query options.

<T extends TuplesReadHandle> T

tuples(ValuesDefinition valdef, T tupleHandle, Transaction transaction)

Retrieves combinations of values for the same document from indexes based on query criteria and, potentially, previously saved query options.

<T extends StructureReadHandle> T

validate(RawQueryByExampleDefinition query, T reportHandle)

Checks a query by example for mistakes in expressing the criteria.

<T extends ValuesReadHandle> T

values(ValuesDefinition valdef, T valueHandle)

Retrieves values from indexes based on query criteria and, potentially, previously saved query options.

<T extends ValuesReadHandle> T

values(ValuesDefinition valdef, T valueHandle, long start)

Retrieves values from indexes based on query criteria and, potentially, previously saved query options.

<T extends ValuesReadHandle> T

values(ValuesDefinition valdef, T valueHandle, long start, Transaction transaction)

Retrieves values from indexes based on query criteria and, potentially, previously saved query options.

<T extends ValuesReadHandle> T

values(ValuesDefinition valdef, T valueHandle, Transaction transaction)

Retrieves values from indexes based on query criteria and, potentially, previously saved query options.

<T extends ValuesListReadHandle> T

valuesList(ValuesListDefinition valdef, T valueHandle)

Retrieves the list of available named lexicon configurations from the values list definition and, potentially, previously saved query options.

<T extends ValuesListReadHandle> T

valuesList(ValuesListDefinition valdef, T valueHandle, Transaction transaction)

Retrieves the list of available named lexicon configurations from the values list definition and, potentially, previously saved query options.

Field Details
- DEFAULT_PAGE_LENGTH
  
  static final long DEFAULT_PAGE_LENGTH
  
  The default maximum number of documents in a page of search results.
  See Also:
  - Constant Field Values
- START
  
  static final long START
  
  The offset of the first result in the default page.
  See Also:
  - Constant Field Values
Method Details
- getPageLength
  
  long getPageLength()
  
  Returns the maximum number of documents that can appear in any page of query results.
  
  Returns:
  
  the maximum number of results
- setPageLength
  
  void setPageLength(long length)
  
  Specifies the maximum number of documents that can appear in any page of the query results, overriding any maximum specified in the query options.
  
  Parameters:
  
  length - the maximum number of results
- getView
  
  QueryManager.QueryView getView()
  
  Returns the type of view results produced by queries.
  
  Returns:
  
  the view type for the queries
- setView
  
  void setView(QueryManager.QueryView view)
  
  Specifies the type of view results produced by queries.
  
  Parameters:
  
  view - the view type for the queries
- newStringDefinition
  
  StringQueryDefinition newStringDefinition()
  
  Creates a query definition based on a string and the default query options. The string has a simple grammar for specifying constraint values for indexes and can be supplied by an end-user in a web form.
  
  Returns:
  
  the string query definition
- newStringDefinition
  
  StringQueryDefinition newStringDefinition(String optionsName)
  
  Creates a query definition based on a string and on named query options saved previously.
  
  Parameters:
  
  optionsName - the name of the query options
  
  Returns:
  
  the string query definition
- newSuggestDefinition
  
  SuggestDefinition newSuggestDefinition()
  
  Creates a suggestion definition based on a single string for completion, using the default options node.
  
  Returns:
  
  the suggest definition.
- newSuggestDefinition
  
  SuggestDefinition newSuggestDefinition(String optionsName)
  
  Creates a suggestion definition based on a query options name.
  
  Parameters:
  
  optionsName - the name of the query options
  
  Returns:
  
  the suggest definition.
- newSuggestDefinition
  
  SuggestDefinition newSuggestDefinition(String suggestString, String optionsName)
  
  Creates a suggestion definition based on a single string for completion, using the default options node.
  
  Parameters:
  
  suggestString - A string as input for completion suggestions.
  
  optionsName - the name of the query options
  
  Returns:
  
  the suggest definition.
- newStructuredQueryBuilder
  
  StructuredQueryBuilder newStructuredQueryBuilder()
  
  Creates a query definition based on a structure that identifies clauses and conjunctions and the default query options.
  
  Returns:
  
  the structured query definition
- newStructuredQueryBuilder
  
  StructuredQueryBuilder newStructuredQueryBuilder(String optionsName)
  
  Creates a query definition based on a structure and on named query options saved previously.
  
  Parameters:
  
  optionsName - the name of the query options
  
  Returns:
  
  the structured query definition
- newDeleteDefinition
  
  DeleteQueryDefinition newDeleteDefinition()
  
  Creates a query definition for deleting documents.
  
  Returns:
  
  the deletion query definition
- newValuesDefinition
  
  ValuesDefinition newValuesDefinition(String name)
  
  Creates a query definition for retrieving values based on a named constraint on an index and the default query options.
  
  Parameters:
  
  name - the index constraint
  
  Returns:
  
  the values query definition
- newValuesDefinition
  
  ValuesDefinition newValuesDefinition(String name, String optionsName)
  
  Creates a query definition for retrieving values based on a named constraint and on named query options saved previously.
  
  Parameters:
  
  name - the index constraint
  
  optionsName - the name of the query options
  
  Returns:
  
  the values query definition
- newValuesListDefinition
  
  ValuesListDefinition newValuesListDefinition()
  
  Creates a query definition for retrieving the list of available named lexicon configurations from the default query options.
  
  Returns:
  
  the values list definition
- newValuesListDefinition
  
  ValuesListDefinition newValuesListDefinition(String optionsName)
  
  Creates a query definition for retrieving the list of available named lexicon configurations from the named query options.
  
  Parameters:
  
  optionsName - the name of the query options
  
  Returns:
  
  the values list definition
- search
  
  <T extends SearchReadHandle> T search(SearchQueryDefinition querydef, T searchHandle)
  
  Searches documents based on query criteria and, potentially, previously saved query options.
  
  Type Parameters:
  
  T - the type of SearchReadHandle to return
  
  Parameters:
  
  querydef - the definition of query criteria and query options
  
  searchHandle - a handle for reading the results from the search
  
  Returns:
  
  the handle populated with the results from the search
- search
  
  <T extends SearchReadHandle> T search(SearchQueryDefinition querydef, T searchHandle, String forestName)
  
  Searches documents based on query criteria and, potentially, previously saved query options.
  
  Type Parameters:
  
  T - the type of SearchReadHandle to return
  
  Parameters:
  
  querydef - the definition of query criteria and query options
  
  searchHandle - a handle for reading the results from the search
  
  forestName - a forest to limit this search
  
  Returns:
  
  the handle populated with the results from the search
- search
  
  <T extends SearchReadHandle> T search(SearchQueryDefinition querydef, T searchHandle, long start)
  
  Searches documents based on query criteria and, potentially, previously saved query options starting with the specified page listing document results.
  
  Type Parameters:
  
  T - the type of SearchReadHandle to return
  
  Parameters:
  
  querydef - the definition of query criteria and query options
  
  searchHandle - a handle for reading the results from the search
  
  start - the offset of the first document in the page (where 1 is the first result)
  
  Returns:
  
  the handle populated with the results from the search
- search
  
  <T extends SearchReadHandle> T search(SearchQueryDefinition querydef, T searchHandle, long start, String forestName)
  
  Searches documents based on query criteria and, potentially, previously saved query options starting with the specified page listing document results.
  
  Type Parameters:
  
  T - the type of SearchReadHandle to return
  
  Parameters:
  
  querydef - the definition of query criteria and query options
  
  searchHandle - a handle for reading the results from the search
  
  start - the offset of the first document in the page (where 1 is the first result)
  
  forestName - a forest to limit this search
  
  Returns:
  
  the handle populated with the results from the search
- search
  
  <T extends SearchReadHandle> T search(SearchQueryDefinition querydef, T searchHandle, Transaction transaction)
  
  Searches documents based on query criteria and, potentially, previously saved query options. The search includes documents modified by the transaction and ignores documents deleted by the transaction.
  
  Type Parameters:
  
  T - the type of SearchReadHandle to return
  
  Parameters:
  
  querydef - the definition of query criteria and query options
  
  searchHandle - a handle for reading the results from the search
  
  transaction - a open transaction for matching documents
  
  Returns:
  
  the handle populated with the results from the search
- search
  
  <T extends SearchReadHandle> T search(SearchQueryDefinition querydef, T searchHandle, Transaction transaction, String forestName)
  
  Searches documents based on query criteria and, potentially, previously saved query options. The search includes documents modified by the transaction and ignores documents deleted by the transaction.
  
  Type Parameters:
  
  T - the type of SearchReadHandle to return
  
  Parameters:
  
  querydef - the definition of query criteria and query options
  
  searchHandle - a handle for reading the results from the search
  
  transaction - a open transaction for matching documents
  
  forestName - a forest to limit this search
  
  Returns:
  
  the handle populated with the results from the search
- search
  
  <T extends SearchReadHandle> T search(SearchQueryDefinition querydef, T searchHandle, long start, Transaction transaction)
  
  Searches documents based on query criteria and, potentially, previously saved query options starting with the specified page listing document results. The search includes documents modified by the transaction and ignores documents deleted by the transaction.
  
  Type Parameters:
  
  T - the type of SearchReadHandle to return
  
  Parameters:
  
  querydef - the definition of query criteria and query options
  
  searchHandle - a handle for reading the results from the search
  
  start - the offset of the first document in the page (where 1 is the first result)
  
  transaction - a open transaction for matching documents
  
  Returns:
  
  the handle populated with the results from the search
- search
  
  <T extends SearchReadHandle> T search(SearchQueryDefinition querydef, T searchHandle, long start, Transaction transaction, String forestName)
  
  Searches documents based on query criteria and, potentially, previously saved query options starting with the specified page listing document results. The search includes documents modified by the transaction and ignores documents deleted by the transaction.
  
  Type Parameters:
  
  T - the type of SearchReadHandle to return
  
  Parameters:
  
  querydef - the definition of query criteria and query options
  
  searchHandle - a handle for reading the results from the search
  
  start - the offset of the first document in the page (where 1 is the first result)
  
  transaction - a open transaction for matching documents
  
  forestName - a forest to limit this search
  
  Returns:
  
  the handle populated with the results from the search
- suggest
  
  String[] suggest(SuggestDefinition suggestionDef)
  
  Queries the REST server for suggested string completions based on values in the SuggestionDefinition. The list of strings returned by this function can be used to provide possible values for completing a string search.
  
  Parameters:
  
  suggestionDef - the partial string to complete and suggest query options
  
  Returns:
  
  the suggested string completions
- delete
  
  void delete(DeleteQueryDefinition querydef)
  
  Deletes documents based on the query criteria.
  
  Parameters:
  
  querydef - the definition of query criteria
- delete
  
  void delete(DeleteQueryDefinition querydef, Transaction transaction)
  
  Deletes documents based on the query criteria as part of the specified transaction.
  
  Parameters:
  
  querydef - the definition of query criteria
  
  transaction - a open transaction for the delete operation
- values
  
  <T extends ValuesReadHandle> T values(ValuesDefinition valdef, T valueHandle)
  
  Retrieves values from indexes based on query criteria and, potentially, previously saved query options.
  
  Type Parameters:
  
  T - the type of ValuesReadHandle to return
  
  Parameters:
  
  valdef - the definition of query criteria and query options
  
  valueHandle - a handle for reading the values for the matched documents
  
  Returns:
  
  the handle populated with the values from the index
- values
  
  <T extends ValuesReadHandle> T values(ValuesDefinition valdef, T valueHandle, long start)
  
  Retrieves values from indexes based on query criteria and, potentially, previously saved query options.
  
  Type Parameters:
  
  T - the type of ValuesReadHandle to return
  
  Parameters:
  
  valdef - the definition of query criteria and query options
  
  valueHandle - a handle for reading the values for the matched documents
  
  start - the offset of the first returned result (where 1 is the first value)
  
  Returns:
  
  the handle populated with the values from the index
- values
  
  <T extends ValuesReadHandle> T values(ValuesDefinition valdef, T valueHandle, Transaction transaction)
  
  Retrieves values from indexes based on query criteria and, potentially, previously saved query options. The query includes documents modified by the transaction and ignores documents deleted by the transaction.
  
  Type Parameters:
  
  T - the type of ValuesReadHandle to return
  
  Parameters:
  
  valdef - the definition of query criteria and query options
  
  valueHandle - a handle for reading the values for the matched documents
  
  transaction - a open transaction for matching documents
  
  Returns:
  
  the handle populated with the values from the index
- values
  
  <T extends ValuesReadHandle> T values(ValuesDefinition valdef, T valueHandle, long start, Transaction transaction)
  
  Retrieves values from indexes based on query criteria and, potentially, previously saved query options. The query includes documents modified by the transaction and ignores documents deleted by the transaction.
  
  Type Parameters:
  
  T - the type of ValuesReadHandle to return
  
  Parameters:
  
  valdef - the definition of query criteria and query options
  
  valueHandle - a handle for reading the values for the matched documents
  
  start - the offset of the first returned result (where 1 is the first value)
  
  transaction - a open transaction for matching documents
  
  Returns:
  
  the handle populated with the values from the index
- tuples
  
  <T extends TuplesReadHandle> T tuples(ValuesDefinition valdef, T tupleHandle)
  
  Retrieves combinations of values for the same document from indexes based on query criteria and, potentially, previously saved query options.
  
  Type Parameters:
  
  T - the type of TuplesReadHandle to return
  
  Parameters:
  
  valdef - the definition of query criteria and query options
  
  tupleHandle - a handle for reading the tuples for the matched documents
  
  Returns:
  
  the handle populated with the tuples from the index
- tuples
  
  <T extends TuplesReadHandle> T tuples(ValuesDefinition valdef, T tupleHandle, long start)
  
  Retrieves combinations of values for the same document from indexes based on query criteria and, potentially, previously saved query options.
  
  Type Parameters:
  
  T - the type of TuplesReadHandle to return
  
  Parameters:
  
  valdef - the definition of query criteria and query options
  
  tupleHandle - a handle for reading the tuples for the matched documents
  
  start - the offset of the first returned result (where 1 is the first tuple)
  
  Returns:
  
  the handle populated with the tuples from the index
- tuples
  
  <T extends TuplesReadHandle> T tuples(ValuesDefinition valdef, T tupleHandle, Transaction transaction)
  
  Retrieves combinations of values for the same document from indexes based on query criteria and, potentially, previously saved query options. The query includes documents modified by the transaction and ignores documents deleted by the transaction.
  
  Type Parameters:
  
  T - the type of TuplesReadHandle to return
  
  Parameters:
  
  valdef - the definition of query criteria and query options
  
  tupleHandle - a handle for reading the tuples for the matched documents
  
  transaction - a open transaction for matching documents
  
  Returns:
  
  the handle populated with the tuples from the index
- tuples
  
  <T extends TuplesReadHandle> T tuples(ValuesDefinition valdef, T tupleHandle, long start, Transaction transaction)
  
  Retrieves combinations of values for the same document from indexes based on query criteria and, potentially, previously saved query options. The query includes documents modified by the transaction and ignores documents deleted by the transaction.
  
  Type Parameters:
  
  T - the type of TuplesReadHandle to return
  
  Parameters:
  
  valdef - the definition of query criteria and query options
  
  tupleHandle - a handle for reading the tuples for the matched documents
  
  start - the offset of the first returned result (where 1 is the first tuple)
  
  transaction - a open transaction for matching documents
  
  Returns:
  
  the handle populated with the tuples from the index
- valuesList
  
  <T extends ValuesListReadHandle> T valuesList(ValuesListDefinition valdef, T valueHandle)
  
  Retrieves the list of available named lexicon configurations from the values list definition and, potentially, previously saved query options.
  
  Type Parameters:
  
  T - the type of ValuesListReadHandle to return
  
  Parameters:
  
  valdef - the definition of the query criteria and options
  
  valueHandle - a handle for reading the list of names lexicon configurations
  
  Returns:
  
  the handle populated with the names
- valuesList
  
  <T extends ValuesListReadHandle> T valuesList(ValuesListDefinition valdef, T valueHandle, Transaction transaction)
  
  Retrieves the list of available named lexicon configurations from the values list definition and, potentially, previously saved query options. The query includes options modified by the transaction and ignores options deleted by the transaction.
  
  Type Parameters:
  
  T - the type of ValuesListReadHandle to return
  
  Parameters:
  
  valdef - the definition of the query criteria and options
  
  valueHandle - a handle for reading the list of names lexicon configurations
  
  transaction - a open transaction for matching documents
  
  Returns:
  
  the handle populated with the names
- optionsList
  
  <T extends QueryOptionsListReadHandle> T optionsList(T listHandle)
  
  Retrieves the list of available named query options.
  
  Type Parameters:
  
  T - the type of QueryOptionsListReadHandle to return
  
  Parameters:
  
  listHandle - a handle for reading the list of name options
  
  Returns:
  
  the handle populated with the names
- optionsList
  
  <T extends QueryOptionsListReadHandle> T optionsList(T valueHandle, Transaction transaction)
  
  Retrieves the list of available named query options. The query includes options modified by the transaction and ignores options deleted by the transaction.
  
  Type Parameters:
  
  T - the type of QueryOptionsListReadHandle to return
  
  Parameters:
  
  valueHandle - a handle for reading the list of name options
  
  transaction - a open transaction for matching documents
  
  Returns:
  
  the handle populated with the names
- findOne
  
  MatchDocumentSummary findOne(QueryDefinition querydef)
  
  The findOne method is a convenience. It searches documents based on query criteria and, potentially, previously saved query options. It returns the MatchDocumentSummary of the first search result.
  
  Parameters:
  
  querydef - the definition of query criteria and query options
  
  Returns:
  
  the summary of the first search result or null if there are no results
- findOne
  
  MatchDocumentSummary findOne(QueryDefinition querydef, Transaction transaction)
  
  The findOne method is a convenience. It searches documents based on query criteria and, potentially, previously saved query options. It returns the MatchDocumentSummary of the first search result. The search includes documents modified by the transaction and ignores documents deleted by the transaction.
  
  Parameters:
  
  querydef - the definition of query criteria and query options
  
  transaction - a open transaction for matching documents
  
  Returns:
  
  the summary of the first search result or null if there are no results
- convert
  
  <T extends StructureReadHandle> T convert(RawQueryByExampleDefinition query, T convertedHandle)
  
  Sends a query by example to the server to convert into a combined query that expresses the criteria as a structured search.
  
  Type Parameters:
  
  T - the type of StructureReadHandle to return
  
  Parameters:
  
  query - the query by example
  
  convertedHandle - the container to use for the new converted query
  
  Returns:
  
  the handle populated with the combined query
- validate
  
  <T extends StructureReadHandle> T validate(RawQueryByExampleDefinition query, T reportHandle)
  
  Checks a query by example for mistakes in expressing the criteria.
  
  Type Parameters:
  
  T - the type of StructureReadHandle to return
  
  Parameters:
  
  query - the query by example
  
  reportHandle - a handle for reading the validation report
  
  Returns:
  
  the handle populated with the validation report
- startLogging
  
  void startLogging(RequestLogger logger)
  
  Starts debugging client requests. You can suspend and resume debugging output using the methods of the logger.
  
  Parameters:
  
  logger - the logger that receives debugging output
- stopLogging
  
  void stopLogging()
  
  Stops debugging client requests.
- newCtsSearchBuilder
  
  CtsQueryBuilder newCtsSearchBuilder()
  
  Returns a new CtsSearchBuilder.
  
  Returns:
  
  a CtsQueryBuilder
- newRawCombinedQueryDefinitionAs
  
  RawCombinedQueryDefinition newRawCombinedQueryDefinitionAs(Format format, Object rawQuery)
  
  Defines a combined query from a JSON or XML representation provided as an object of an IO class. The IO class must have been registered before creating the database client. By default, the provided handles that implement ContentHandle are registered. Learn more about shortcut methods
  
  Parameters:
  
  format - whether the format of the representation is JSON or XML
  
  rawQuery - an IO representation of the JSON or XML combined query
  
  Returns:
  
  a QueryDefinition for use of the combined query
- newRawCombinedQueryDefinitionAs
  
  RawCombinedQueryDefinition newRawCombinedQueryDefinitionAs(Format format, Object rawQuery, String optionsName)
  
  Defines a combined query from a JSON or XML representation provided as an object of an IO class. The IO class must have been registered before creating the database client. By default, the provided handles that implement ContentHandle are registered. Learn more about shortcut methods
  
  Parameters:
  
  format - whether the format of the representation is JSON or XML
  
  rawQuery - an IO representation of the JSON or XML combined query
  
  optionsName - the name of a persisted query options configuration
  
  Returns:
  
  a QueryDefinition for use of the combined query
- newRawCombinedQueryDefinition
  
  RawCombinedQueryDefinition newRawCombinedQueryDefinition(StructureWriteHandle handle)
  
  Defines a combined query from a JSON or XML representation.
  
  Parameters:
  
  handle - a handle for a JSON or XML combined query
  
  Returns:
  
  a QueryDefinition for use of the combined query
- newRawCombinedQueryDefinition
  
  RawCombinedQueryDefinition newRawCombinedQueryDefinition(StructureWriteHandle handle, String optionsName)
  
  Defines a combined query from a JSON or XML representation.
  
  Parameters:
  
  handle - a handle for a JSON or XML combined query
  
  optionsName - the name of a persisted query options configuration
  
  Returns:
  
  a QueryDefinition for use of the combined query
- newRawStructuredQueryDefinitionAs
  
  RawStructuredQueryDefinition newRawStructuredQueryDefinitionAs(Format format, Object rawQuery)
  
  Defines a structured query from a JSON or XML representation provided as an object of an IO class. The IO class must have been registered before creating the database client. By default, the provided handles that implement ContentHandle are registered. Learn more about shortcut methods
  
  Parameters:
  
  format - whether the format of the representation is JSON or XML
  
  rawQuery - an IO representation of the JSON or XML structured query
  
  Returns:
  
  a QueryDefinition for use of the structured query.
- newRawStructuredQueryDefinitionAs
  
  RawStructuredQueryDefinition newRawStructuredQueryDefinitionAs(Format format, Object rawQuery, String optionsName)
  
  Defines a structured query from a JSON or XML representation provided as an object of an IO class. The IO class must have been registered before creating the database client. By default, the provided handles that implement ContentHandle are registered. Learn more about shortcut methods
  
  Parameters:
  
  format - whether the format of the representation is JSON or XML
  
  rawQuery - an IO representation of the JSON or XML structured query
  
  optionsName - the name of a persisted query options configuration
  
  Returns:
  
  a QueryDefinition for use of the structured query.
- newRawStructuredQueryDefinition
  
  RawStructuredQueryDefinition newRawStructuredQueryDefinition(StructureWriteHandle handle)
  
  Defines a structured query from a JSON or XML representation.
  
  Parameters:
  
  handle - a handle for a JSON or XML structured query
  
  Returns:
  
  a QueryDefinition for use of the structured query
- newRawStructuredQueryDefinition
  
  RawStructuredQueryDefinition newRawStructuredQueryDefinition(StructureWriteHandle handle, String optionsName)
  
  Defines a structured query from a JSON or XML representation.
  
  Parameters:
  
  handle - a handle for a JSON or XML structured query
  
  optionsName - the name of a persisted query options configuration
  
  Returns:
  
  a QueryDefinition for use of the structured query
- newRawCtsQueryDefinitionAs
  
  RawCtsQueryDefinition newRawCtsQueryDefinitionAs(Format format, Object rawQuery)
  
  Defines a serialized cts query from a JSON or XML representation provided as an object of an IO class. The IO class must have been registered before creating the database client. By default, the provided handles that implement ContentHandle are registered. Learn more about shortcut methods
  
  Parameters:
  
  format - whether the format of the representation is JSON or XML
  
  rawQuery - an IO representation of the JSON or XML serialized cts query
  
  Returns:
  
  a QueryDefinition for use of the serialized cts query.
- newRawCtsQueryDefinitionAs
  
  RawCtsQueryDefinition newRawCtsQueryDefinitionAs(Format format, Object rawQuery, String optionsName)
  
  Defines a serialized cts query from a JSON or XML representation provided as an object of an IO class. The IO class must have been registered before creating the database client. By default, the provided handles that implement ContentHandle are registered. Learn more about shortcut methods
  
  Parameters:
  
  format - whether the format of the representation is JSON or XML
  
  rawQuery - an IO representation of the JSON or XML serialized cts query
  
  optionsName - the name of a persisted query options configuration
  
  Returns:
  
  a QueryDefinition for use of the serialized cts query.
- newRawCtsQueryDefinition
  
  RawCtsQueryDefinition newRawCtsQueryDefinition(CtsQueryWriteHandle handle)
  
  Defines a serialized cts query from a JSON or XML representation.
  
  Parameters:
  
  handle - a handle for a JSON or XML serialized cts query
  
  Returns:
  
  a QueryDefinition for use of the serialized cts query
- newRawCtsQueryDefinition
  
  RawCtsQueryDefinition newRawCtsQueryDefinition(CtsQueryWriteHandle handle, String optionsName)
  
  Defines a serialized cts query from a JSON or XML representation.
  
  Parameters:
  
  handle - a handle for a JSON or XML serialized cts query
  
  optionsName - the name of a persisted query options configuration
  
  Returns:
  
  a QueryDefinition for use of the serialized cts query
- newRawQueryByExampleDefinitionAs
  
  RawQueryByExampleDefinition newRawQueryByExampleDefinitionAs(Format format, Object rawQuery)
  
  Defines a simple query by example from a JSON or XML representation provided as an object of an IO class. The IO class must have been registered before creating the database client. By default, the provided handles that implement ContentHandle are registered. Learn more about shortcut methods
  
  Parameters:
  
  format - whether the format of the representation is JSON or XML
  
  rawQuery - an IO representation of the query by example
  
  Returns:
  
  a QueryDefinition for use of the query by example
- newRawQueryByExampleDefinitionAs
  
  RawQueryByExampleDefinition newRawQueryByExampleDefinitionAs(Format format, Object rawQuery, String optionsName)
  
  Defines a simple query by example from a JSON or XML representation provided as an object of an IO class. The IO class must have been registered before creating the database client. By default, the provided handles that implement ContentHandle are registered. Learn more about shortcut methods
  
  Parameters:
  
  format - whether the format of the representation is JSON or XML
  
  rawQuery - an IO representation of the query by example
  
  optionsName - the name of a persisted query options configuration
  
  Returns:
  
  a QueryDefinition for use of the query by example
- newRawQueryByExampleDefinition
  
  RawQueryByExampleDefinition newRawQueryByExampleDefinition(StructureWriteHandle handle)
  
  Defines a simple query by example from a JSON or XML representation.
  
  Parameters:
  
  handle - a handle for a JSON or XML query by example.
  
  Returns:
  
  a QueryDefinition for use of the query by example.
- newRawQueryByExampleDefinition
  
  RawQueryByExampleDefinition newRawQueryByExampleDefinition(StructureWriteHandle handle, String optionsName)
  
  Defines a simple query by example from a JSON or XML representation.
  
  Parameters:
  
  handle - a handle for a JSON or XML query by example.
  
  optionsName - The name of a persisted query options configuration
  
  Returns:
  
  a QueryDefinition for use of the query by example.

Interface QueryManager

Nested Class Summary

Field Summary

Method Summary

Field Details

DEFAULT_PAGE_LENGTH

START

Method Details

getPageLength

setPageLength

getView

setView

newStringDefinition

newStringDefinition

newSuggestDefinition

newSuggestDefinition

newSuggestDefinition

newStructuredQueryBuilder

newStructuredQueryBuilder

newDeleteDefinition

newValuesDefinition

newValuesDefinition

newValuesListDefinition

newValuesListDefinition

search

search

search

search

search

search

search

search

suggest

delete

delete

values

values

values

values

tuples

tuples

tuples

tuples

valuesList

valuesList

optionsList

optionsList

findOne

findOne

convert

validate

startLogging

stopLogging

newCtsSearchBuilder

newRawCombinedQueryDefinitionAs

newRawCombinedQueryDefinitionAs

newRawCombinedQueryDefinition

newRawCombinedQueryDefinition

newRawStructuredQueryDefinitionAs

newRawStructuredQueryDefinitionAs

newRawStructuredQueryDefinition

newRawStructuredQueryDefinition

newRawCtsQueryDefinitionAs

newRawCtsQueryDefinitionAs

newRawCtsQueryDefinition

newRawCtsQueryDefinition

newRawQueryByExampleDefinitionAs

newRawQueryByExampleDefinitionAs

newRawQueryByExampleDefinition

newRawQueryByExampleDefinition