mlclient::utilities::SearchOptionsBuilder Class Reference

This class helps create a MarkLogic search options JSON object for use with SearchDescription. More...

#include <SearchOptionsBuilder.hpp>

Public Member Functions
MLCLIENT_API SearchOptionsBuilder *	additionalQuery (const IQuery &query)
MLCLIENT_API SearchOptionsBuilder *	containerConstraint (const IContainerRef &container)
MLCLIENT_API SearchOptionsBuilder *	emptySnippet ()
MLCLIENT_API SearchOptionsBuilder *	rawSnippet ()
MLCLIENT_API SearchOptionsBuilder *	valuesRangeAggregate (const std::string &name, const RangeOptions &range, const AggregateInfo &aggregate, const std::map< ValuesOption, std::string > &valuesOption)
MLCLIENT_API SearchOptionsBuilder *	valuesRange (const std::string &name, const RangeOptions &range, const std::map< ValuesOption, std::string > &valuesOption)
MLCLIENT_API void	fromDocument (const ITextDocumentContent &doc)
MLCLIENT_API ITextDocumentContent *	toDocument (bool asObject=false)

Detailed Description

This class helps create a MarkLogic search options JSON object for use with SearchDescription.

Author

Adam Fowler adam..nosp@m.fowl.nosp@m.er@ma.nosp@m.rklo.nosp@m.gic.c.nosp@m.om

Since

8.0.2

Date

2016-06-08

Note

This class deals only with search options, NOT complex searches or text grammar.

This class only ever generates JSON output, never XML. This enables the class to be more efficient, using the same internal structures as required by a JSON stream.

This class has an external dependency on Microsoft's C++ cpprest API. As this API is required to use MarkLogic's C++ wrapper (this API) , this does not introduce any extra dependencies.

---

The documentation for this class was generated from the following file:

• include/mlclient/utilities/SearchOptionsBuilder.hpp