OpsScorerInitParams は、Cava を使用してカスタムソートプラグインを実装する際に、boolean init(OpsScorerInitParams params) メソッドに渡されます。これは、初期化中にプラグインが必要とするドキュメントリソースとリクエストリソースへのアクセスを提供します。フレームワークがこのオブジェクトを自動的に構築して渡すため、ご自身でインスタンス化する必要はありません。
仕組み
初期化は、プラグインがロードされるときに一度だけ実行されます。OpsScorerInitParams を init() で使用して、以下を実行します。
getDoc()を介して、スコアリングロジックが読み取るドキュメントフィールドを宣言します。getRequest()を介して、受信した検索リクエストを検査します。
関数
| 関数 | 戻り値 | 説明 |
|---|---|---|
OpsDoc getDoc() | OpsDoc | ドキュメントアクセサーを取得します。init() でこれを呼び出して、スコアリングロジックが必要とする属性フィールドを宣言します。 |
OpsRequest getRequest() | OpsRequest | リクエストアクセサーを取得します。init() でこれを呼び出して、受信した検索リクエストからパラメーターを読み取ります。 |
関数の詳細
OpsDoc getDoc()
OpsDoc オブジェクトを返します。init() でこれを呼び出して、スコアリング中にプラグインがアクセスするドキュメントの属性フィールドを宣言します。
完全な OpsDoc API については、OpsDoc をご参照ください。
OpsRequest getRequest()
OpsRequest オブジェクトを返します。init() でこれを呼び出して、リクエスト情報を取得します。
OpsRequest API の詳細については、OpsRequest をご参照ください。