JoinSpec クラス

定義

[Android.Runtime.Register("android/app/appsearch/JoinSpec", ApiSince=34, DoNotGenerateAcw=true)]
public sealed class JoinSpec : Java.Lang.Object, Android.OS.IParcelable, IDisposable

[<Android.Runtime.Register("android/app/appsearch/JoinSpec", ApiSince=34, DoNotGenerateAcw=true)>]
type JoinSpec = class
    inherit Object
    interface IParcelable
    interface IJavaObject
    interface IDisposable
    interface IJavaPeerable

継承

Object

JavaObject

Object

JoinSpec

属性

RegisterAttribute

実装

IParcelable IJavaObject IJavaPeerable IDisposable

注釈

このクラスは、検索での結合操作の仕様を表します。

結合は、外部ドキュメントの修飾 ID とサブクエリ ドキュメント内のプロパティ値に対してのみ照合できます。 サブクエリ ドキュメントでは、これらの値を "email.recipient.id" や "entityId" などのプロパティ パスまたはプロパティ式で参照できます。 このようなプロパティ式の 1 つは "this.qualifiedId()" で、ドキュメントの結合パッケージ、データベース、名前空間、ID を参照します。

結合を実行するには、 #getChildPropertyExpression によって参照されるプロパティが、 AppSearchSchema.StringPropertyConfig#getJoinableValueType が AppSearchSchema.StringPropertyConfig#JOINABLE_VALUE_TYPE_QUALIFIED_ID に設定されたプロパティである必要があることに注意してください。 それ以外の場合、ドキュメントはどの SearchResultにも参加しません。

次のような外部クエリとサブクエリの結果を取得します。

{@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
            }
            }

この例では、サブクエリの結果 1 には、外部の結果を参照する値が "pkg$db/ns#id1" であるプロパティ "entityId" が含まれています。 "entityId" で Builder を呼び出すと、子ドキュメント ("pkg$db#ns/id1" ) からプロパティ "entityId" の値が取得されます。 外側の結果の修飾 ID が "pkg$db#ns/id1" であるとします。 これは、サブクエリの結果 1 のドキュメントがその親ドキュメントと一致することを意味します。 これを行うには、子ドキュメントを含む SearchResult を最上位の親 SearchResult#getJoinedResultsに追加します。

#getChildPropertyExpressionが "notes" の場合は、サブクエリの結果の notes プロパティの値を確認します。 サブクエリ結果 1 では、この値は "This is some doc" であり、外部クエリ結果の修飾 ID と等しくありません。 そのため、サブクエリの結果 1 は外部クエリ結果に結合されません。

入れ子になったSearchSpecで高度なランク付け戦略を定義し、外側のSearchSpec#RANKING_STRATEGY_JOIN_AGGREGATE_SCOREでSearchSpecを使用することもできます。 この場合、親は、結合されたドキュメントを高度なランク付け戦略でスコア付けすることによって計算されたシグナルの合計などの集計に基づいてランク付けされます。

スコアリングでは、 SearchSpec#RANKING_STRATEGY_JOIN_AGGREGATE_SCORE が SearchSpec#getRankingStrategyで設定されている場合、外部 SearchResults のスコアは、サブクエリ結果のランク付けシグナルの影響を受ける可能性があります。 たとえば、 JoinSpec#getAggregationScoringStrategy が次に設定されている場合です。

<ul><li>JoinSpec#AGGREGATION_SCORING_MIN_RANKING_SIGNAL、外部 SearchResult のランク付けシグナルは、サブクエリ結果のランク付けシグナルの最小値に設定されます。 この場合、2 と 3 の最小値になります。これは 2 です。 <li>JoinSpec#AGGREGATION_SCORING_MAX_RANKING_SIGNAL、外部 SearchResult の順位付け信号は3になります。 <li>JoinSpec#AGGREGATION_SCORING_AVG_RANKING_SIGNAL、外部 SearchResult の順位付け信号は2.5になります。 <li>JoinSpec#AGGREGATION_SCORING_RESULT_COUNT、外部 SearchResult のランク付け信号は、2 つの結合された結果があるため、2 になります。 <li>JoinSpec#AGGREGATION_SCORING_SUM_RANKING_SIGNAL、外側の SearchResult の順位付け信号は 5 になり、合計は 2 と 3 になります。 <li>JoinSpec#AGGREGATION_SCORING_OUTER_RESULT_RANKING_SIGNAL、外側の SearchResult の順位付け信号は、そのまま残ります。 </ul>

外部クエリのランク付けシグナルで "this.childrenRankingSignals()" を参照すると、SearchSpecのように、入れ子になったSearchResult#getRankingSignalのスコア付け戦略を使用して結合されたドキュメントをスコア付けすることによって計算されたシグナルが返されます。

Javaドキュメント。

このページの一部は、によって作成および共有され、に記載されている条件に従って使用される作業に基づく変更です。