Overview

Builder for objects.

Summary

Constructors

Methods

Indicates how the query terms should match TermMatchCode in the index.

If this method is not called, the default term match type is SearchSpec.TERM_MATCH_PREFIX.

Adds a Schema type filter to SearchSpec Entry. Only search for documents that have the specified schema types.

If unset, the query will search over all schema types.

Adds a Schema type filter to SearchSpec Entry. Only search for documents that have the specified schema types.

If unset, the query will search over all schema types.

Adds the Schema names of given document classes to the Schema type filter of SearchSpec Entry. Only search for documents that have the specified schema types.

If unset, the query will search over all schema types.

Parameters:

documentClasses: classes annotated with Document.

Adds the Schema names of given document classes to the Schema type filter of SearchSpec Entry. Only search for documents that have the specified schema types.

If unset, the query will search over all schema types.

Parameters:

documentClasses: classes annotated with Document.

Adds a namespace filter to SearchSpec Entry. Only search for documents that have the specified namespaces.

If unset, the query will search over all namespaces.

Adds a namespace filter to SearchSpec Entry. Only search for documents that have the specified namespaces.

If unset, the query will search over all namespaces.

Adds a package name filter to SearchSpec Entry. Only search for documents that were indexed from the specified packages.

If unset, the query will search over all packages that the caller has access to. If package names are specified which caller doesn't have access to, then those package names will be ignored.

Adds a package name filter to SearchSpec Entry. Only search for documents that were indexed from the specified packages.

If unset, the query will search over all packages that the caller has access to. If package names are specified which caller doesn't have access to, then those package names will be ignored.

Sets the number of results per page in the returned object.

The default number of results per page is 10.

Sets ranking strategy for AppSearch results.

Indicates the order of returned search results, the default is SearchSpec.ORDER_DESCENDING, meaning that results with higher scores come first.

This order field will be ignored if RankingStrategy = RANKING_STRATEGY_NONE.

Only the first snippetCount documents based on the ranking strategy will have snippet information provided.

The list returned from SearchResult.getMatchInfos() will contain at most this many entries.

If set to 0 (default), snippeting is disabled and the list returned from SearchResult.getMatchInfos() will be empty.

Sets snippetCountPerProperty. Only the first snippetCountPerProperty snippets for each property of each GenericDocument will contain snippet information.

If set to 0, snippeting is disabled and the list returned from SearchResult.getMatchInfos() will be empty.

The default behavior is to snippet all matches a property contains, up to the maximum value of 10,000.

Sets maxSnippetSize, the maximum snippet size. Snippet windows start at maxSnippetSize/2 bytes before the middle of the matching token and end at maxSnippetSize/2 bytes after the middle of the matching token. It respects token boundaries, therefore the returned window may be smaller than requested.

Setting maxSnippetSize to 0 will disable windowing and an empty string will be returned. If matches enabled is also set to false, then snippeting is disabled.

Ex. maxSnippetSize = 16. "foo bar baz bat rat" with a query of "baz" will return a window of "bar baz bat" which is only 11 bytes long.

Adds property paths for the specified type to be used for projection. If property paths are added for a type, then only the properties referred to will be retrieved for results of that type. If a property path that is specified isn't present in a result, it will be ignored for that result. Property paths cannot be null.

If no property paths are added for a particular type, then all properties of results of that type will be retrieved.

If property path is added for the SearchSpec.PROJECTION_SCHEMA_TYPE_WILDCARD, then those property paths will apply to all results, excepting any types that have their own, specific property paths set.

Suppose the following document is in the index.

 Email: Document {
   sender: Document {
     name: "Mr. Person"
     email: "mrperson123@google.com"
   }
   recipients: [
     Document {
       name: "John Doe"
       email: "johndoe123@google.com"
     }
     Document {
       name: "Jane Doe"
       email: "janedoe123@google.com"
     }
   ]
   subject: "IMPORTANT"
   body: "Limited time offer!"
 }
 

Then, suppose that a query for "important" is issued with the following projection type property paths:

 {schema: "Email", ["subject", "sender.name", "recipients.name"]}
 

The above document will be returned as:

 Email: Document {
   sender: Document {
     name: "Mr. Body"
   }
   recipients: [
     Document {
       name: "John Doe"
     }
     Document {
       name: "Jane Doe"
     }
   ]
   subject: "IMPORTANT"
 }
 

Set the maximum number of results to return for each group, where groups are defined by grouping type.

Calling this method will override any previous calls. So calling setResultGrouping(GROUPING_TYPE_PER_PACKAGE, 7) and then calling setResultGrouping(GROUPING_TYPE_PER_PACKAGE, 2) will result in only the latter, a limit of two results per package, being applied. Or calling setResultGrouping (GROUPING_TYPE_PER_PACKAGE, 1) and then calling setResultGrouping (GROUPING_TYPE_PER_PACKAGE | GROUPING_PER_NAMESPACE, 5) will result in five results per package per namespace.

Parameters:

groupingTypeFlags: One or more combination of grouping types.
limit: Number of results to return per groupingTypeFlags.

Constructs a new SearchSpec from the contents of this builder.