アノテーションの更新

すべてのアノテーション関連の関数で使用される、アノテーション関数の共通パラメーターで説明した共通パラメーターのほかに、既存のアノテーションを更新するための関数には、各関数に固有のさまざまなパラメーターが必要です。さまざまなタイプのアノテーションの更新や、異なる方法でのアノテーションの更新のために提供される API 関数を以下にまとめます。以下の説明では、各関数の後に、その関数に固有のパラメーターをまとめて示しています。

• annotation-express-update-doc-list: 以下の追加パラメーターを取ります。
  • ACL: 更新されるアノテーションに関連付けるアクセス制御リスト。このパラメーターは必須です。
  • content: 更新するアノテーションを含むコンテンツ・エレメント。少なくとも 1 つの name 属性と 1 つの対応する値から成ります。このパラメーターは必須です。
  • content-old: 更新されるコンテンツ・エレメント。少なくとも 1 つの name 属性から成ります。値を指定しない場合、リスト内のすべての文書が更新され、この名前を持つすべてのコンテンツ・エレメントが上書きされます。このパラメーターは必須です。
  • documents: アノテーションを更新する対象の文書ノードのノード・セット。このパラメーターは必須です。 各文書を一意に識別できるように、各文書に 1 つの vse-key 属性が必要です。
• annotation-express-update-query: 以下の追加パラメーターを取ります。
  • ACL: 更新されるアノテーションに関連付けるアクセス制御リスト。このパラメーターは必須です。
  • content: 更新するアノテーションを含むコンテンツ・エレメント。少なくとも 1 つの name 属性と 1 つの対応する値から成ります。このパラメーターは必須です。
  • content-old: 更新されるコンテンツ・エレメント。少なくとも 1 つの name 属性から成ります。値を指定しない場合、リスト内のすべての文書が更新され、この名前を持つすべてのコンテンツ・エレメントが上書きされます。このパラメーターは必須です。
  • num-doc-at-a-time: 一度に取得と更新を実行する文書の数を示す整数。このパラメーターのデフォルト値は 500 です。大きい数値を指定すると、パフォーマンスに影響を与える可能性があります。
  • query: 指定したアノテーションを更新する対象の文書を識別する照会を含むノード・セット。
• annotation-update: 以下の追加パラメーターを取ります。
  • ACL: 更新されるアノテーションに関連付けるアクセス制御リスト。このパラメーターは必須です。
  • content: 更新するアノテーションを含むコンテンツ・エレメント。少なくとも 1 つの name 属性と 1 つの対応する値から成ります。このパラメーターは必須です。
  • document-vse-key: アノテーションを追加する文書を一意に識別する vse-key。このパラメーターは必須です。
  • document-vse-key-normalized: document-vse-key が既に正規化されているかどうかを示すブール値。true の場合、キーはその後正規化されません。 false の場合、キーがその後正規化されます (可能な場合)。

詳しくは、これらの関数についてのリファレンス情報を参照してください。