JoinSpec
class JoinSpec : Parcelable
kotlin.Any | |
↳ | android.app.appsearch.JoinSpec |
This class represents the specifications for the joining operation in search.
Joins are only possible for matching on the qualified id of an outer document and a property value within a subquery document. In the subquery documents, these values may be referred to with a property path such as "email.recipient.id" or "entityId" or a property expression. One such property expression is "this.qualifiedId()", which refers to the document's combined package, database, namespace, and id.
Note that in order for perform the join, the property referred to by getChildPropertyExpression
has to be a property with android.app.appsearch.AppSearchSchema.StringPropertyConfig#getJoinableValueType
set to android.app.appsearch.AppSearchSchema.StringPropertyConfig#JOINABLE_VALUE_TYPE_QUALIFIED_ID
. Otherwise no documents will be joined to any SearchResult
.
Take these outer query and subquery results for example:
<code>Outer result { id: id1 score: 5 } Subquery result 1 { id: id2 score: 2 entityId: pkg$db/ns#id1 notes: This is some doc } Subquery result 2 { id: id3 score: 3 entityId: pkg$db/ns#id2 notes: This is another doc } </code>
In this example, subquery result 1 contains a property "entityId" whose value is "pkg$db/ns#id1", referring to the outer result. If you call Builder
with "entityId", we will retrieve the value of the property "entityId" from the child document, which is "pkg$db#ns/id1". Let's say the qualified id of the outer result is "pkg$db#ns/id1". This would mean the subquery result 1 document will be matched to that parent document. This is done by adding a SearchResult
containing the child document to the top-level parent android.app.appsearch.SearchResult#getJoinedResults
.
If getChildPropertyExpression
is "notes", we will check the values of the notes property in the subquery results. In subquery result 1, this values is "This is some doc", which does not equal the qualified id of the outer query result. As such, subquery result 1 will not be joined to the outer query result.
It's possible to define an advanced ranking strategy in the nested SearchSpec
and also use SearchSpec#RANKING_STRATEGY_JOIN_AGGREGATE_SCORE
in the outer SearchSpec
. In this case, the parents will be ranked based on an aggregation, such as the sum, of the signals calculated by scoring the joined documents with the advanced ranking strategy.
In terms of scoring, if SearchSpec#RANKING_STRATEGY_JOIN_AGGREGATE_SCORE
is set in SearchSpec#getRankingStrategy
, the scores of the outer SearchResults can be influenced by the ranking signals of the subquery results. For example, if the android.app.appsearch.JoinSpec#getAggregationScoringStrategy
is set to:
JoinSpec#AGGREGATION_SCORING_MIN_RANKING_SIGNAL
, the ranking signal of the outerSearchResult
will be set to the minimum of the ranking signals of the subquery results. In this case, it will be the minimum of 2 and 3, which is 2.JoinSpec#AGGREGATION_SCORING_MAX_RANKING_SIGNAL
, the ranking signal of the outerSearchResult
will be 3.JoinSpec#AGGREGATION_SCORING_AVG_RANKING_SIGNAL
, the ranking signal of the outerSearchResult
will be 2.5.JoinSpec#AGGREGATION_SCORING_RESULT_COUNT
, the ranking signal of the outerSearchResult
will be 2 as there are two joined results.JoinSpec#AGGREGATION_SCORING_SUM_RANKING_SIGNAL
, the ranking signal of the outerSearchResult
will be 5, the sum of 2 and 3.JoinSpec#AGGREGATION_SCORING_OUTER_RESULT_RANKING_SIGNAL
, the ranking signal of the outerSearchResult
will stay as it is.
Referring to "this.childrenRankingSignals()" in the ranking signal of the outer query will return the signals calculated by scoring the joined documents using the scoring strategy in the nested SearchSpec
, as in SearchResult#getRankingSignal
.
Summary
Nested classes | |
---|---|
Builder for |
Constants | |
---|---|
static Int |
Score the aggregation of joined documents using the average ranking signal. |
static Int |
Score the aggregation of joined documents using the largest ranking signal. |
static Int |
Score the aggregation of joined documents using the smallest ranking signal. |
static Int |
Do not score the aggregation of joined documents. |
static Int |
Score the aggregation of joined documents by counting the number of results. |
static Int |
Score the aggregation of joined documents using the sum of ranking signal. |
Inherited constants | |
---|---|
Public methods | |
---|---|
Int |
Gets the joined document list scoring strategy. |
String |
The property expression that is used to get values from child documents, returned from the nested search. |
Int |
Returns the max amount of |
String |
Returns the query to run on the joined documents. |
SearchSpec |
Returns the search spec used to retrieve the joined documents. |
Unit |
writeToParcel(dest: Parcel, flags: Int) Flatten this object in to a Parcel. |
Properties | |
---|---|
static Parcelable.Creator<JoinSpec!> |
Creator class for |
Constants
AGGREGATION_SCORING_AVG_RANKING_SIGNAL
static val AGGREGATION_SCORING_AVG_RANKING_SIGNAL: Int
Score the aggregation of joined documents using the average ranking signal.
Value: 3
AGGREGATION_SCORING_MAX_RANKING_SIGNAL
static val AGGREGATION_SCORING_MAX_RANKING_SIGNAL: Int
Score the aggregation of joined documents using the largest ranking signal.
Value: 4
AGGREGATION_SCORING_MIN_RANKING_SIGNAL
static val AGGREGATION_SCORING_MIN_RANKING_SIGNAL: Int
Score the aggregation of joined documents using the smallest ranking signal.
Value: 2
AGGREGATION_SCORING_OUTER_RESULT_RANKING_SIGNAL
static val AGGREGATION_SCORING_OUTER_RESULT_RANKING_SIGNAL: Int
Do not score the aggregation of joined documents. This is for the case where we want to perform a join, but keep the parent ranking signal.
Value: 0
AGGREGATION_SCORING_RESULT_COUNT
static val AGGREGATION_SCORING_RESULT_COUNT: Int
Score the aggregation of joined documents by counting the number of results.
Value: 1
AGGREGATION_SCORING_SUM_RANKING_SIGNAL
static val AGGREGATION_SCORING_SUM_RANKING_SIGNAL: Int
Score the aggregation of joined documents using the sum of ranking signal.
Value: 5
Public methods
getAggregationScoringStrategy
fun getAggregationScoringStrategy(): Int
Gets the joined document list scoring strategy.
The default scoring strategy is AGGREGATION_SCORING_OUTER_RESULT_RANKING_SIGNAL
, which specifies that the score of the outer parent document will be used.
getChildPropertyExpression
fun getChildPropertyExpression(): String
The property expression that is used to get values from child documents, returned from the nested search. These values are then used to match them to parent documents. These are analogous to foreign keys.
Return | |
---|---|
String |
the property expression to match in the child documents. This value cannot be null . |
getMaxJoinedResultCount
fun getMaxJoinedResultCount(): Int
Returns the max amount of SearchResult
objects to return with the parent document, with a default of 10 SearchResults.
getNestedQuery
fun getNestedQuery(): String
Returns the query to run on the joined documents.
Return | |
---|---|
String |
This value cannot be null . |
getNestedSearchSpec
fun getNestedSearchSpec(): SearchSpec
Returns the search spec used to retrieve the joined documents.
If Builder#setNestedSearch
is never called, this will return a SearchSpec
with all default values. This will match every document, as the nested search query will be "" and no schema will be filtered out.
Return | |
---|---|
SearchSpec |
This value cannot be null . |
writeToParcel
fun writeToParcel(
dest: Parcel,
flags: Int
): Unit
Flatten this object in to a Parcel.
Parameters | |
---|---|
dest |
Parcel: This value cannot be null . |
flags |
Int: Additional flags about how the object should be written. May be 0 or PARCELABLE_WRITE_RETURN_VALUE . Value is either 0 or a combination of android.os.Parcelable#PARCELABLE_WRITE_RETURN_VALUE , and android.os.Parcelable.PARCELABLE_ELIDE_DUPLICATES |
Properties
CREATOR
static val CREATOR: Parcelable.Creator<JoinSpec!>
Creator class for JoinSpec
.