エンティティの操作

次の表では、エンティティおよびコレクション構成Webサービスのエンティティ関連の操作をリストします。

操作 説明
listEntities データ・ドメイン内に存在するエンティティをリストします。この操作の用途の1つとして、たとえば後でputEntities操作を使用してEndecaデータ・ドメインにインポートするために、アップグレード手順中に既存のエンティティをエクスポートできます。
validateEntity 指定されたキーと定義のエンティティ(アクティブまたは非アクティブのいずれか)を検証します。
validateEntities 指定された定義の複数のエンティティ(アクティブまたは非アクティブのいずれか)を検証します。
putEntity 指定されたキーと定義を持つエンティティをデータ・ドメインに追加します。

キーはNCName書式に従って有効である必要があります。NCName書式は、http://www.w3.org/TR/REC-xml-names/#NT-NCNameにあるW3Cのドキュメント「Namespaces in XML 1.0 (Second Edition)」に定義されています。

エンティティを作成するには、その構成要素(物理レコードと属性)がデータ・ドメインにすでに存在する必要があります。

指定されたキーを持つエンティティがコーパスにすでに存在する場合は、同じキーを持つ新しいエンティティで置換されます。エンティティがアクティブである場合は、エンティティを定義するEQL文が有効である必要があることに注意してください。

エンティティが存在しない場合は作成されます。isActiveフラグがtrueに設定されており、EQL定義が有効ではない場合、エンティティは作成されないことに注意してください。

putEntities 指定されたキーと定義を持つ複数のエンティティをデータ・ドメインに追加します。キーはNCName書式に従って有効である必要があります。
deleteEntities キーが指定されている複数のエンティティを削除します。
deleteAllEntities キーを指定せずに、コーパスに存在するすべてのエンティティを削除します。