Facet クラスは、ドキュメントのファセットを表す基本の抽象クラスです。このクラスは直接インスタンス化できません。
Facet は、google.appengine.api.search モジュールで定義されます。
プロパティ
Facet クラスのインスタンスには次のプロパティがあります。
- name
ファセットの名前。ファセット名は MAXIMUM_FIELD_NAME_LENGTH 文字以内で指定し、パターン「[A-Za-z][A-Za-z0-9_]*」に一致している必要があります。
- value
ファセットの値。文字列、Unicode、または数値で指定します。
サブクラス
Facet クラスには次のサブクラスがあります。
- class AtomFacet
インデックスに登録するため、単一のトークンとして扱われるコンテンツを持つファセット。
ファセットの値は、非表示のテキスト値として処理される文字列または Unicode オブジェクトです。次の例は、wine_type という名前のアトム ファセットを示します。
AtomFacet(name='wine_type', value='Red')
-
例外
- TypeError
指定された値がテキスト文字列ではありません。
- ValueError
値が、許容される長さの上限を超えています。
- class NumberFacet
数値を持つファセット。
次の例は wine_vintage という名前の数値ファセットを示しています。
NumberFacet(name='wine_vintage', value=2000)
-
例外
- TypeError
指定された値が数字ではありません。
- ValueError
範囲外の値が使われています。