La classe Facet est une classe de base abstraite représentant un attribut dans un document. Cette classe ne doit pas être directement instanciée.
La classe Facet est définie dans le module google.appengine.api.search.
Propriétés
Une instance de la classe Facet possède les propriétés suivantes :
- name
Nom de l'attribut. Les noms d'attribut doivent avoir une longueur maximale "MAXIMUM_FIELD_NAME_LENGTH" et correspondre au modèle "[A-Za-z][A-Za-z0-9_]*".
- value
Valeur de l'attribut. Celle-ci peut être une valeur "str", une valeur Unicode ou un nombre.
Sous-classes
Les sous-classes de Facet sont les suivantes :
- Classe AtomFacet
Attribut dont le contenu doit être traité comme un seul jeton pour l'indexation.
La valeur de l'attribut est un objet "str" ou Unicode à traiter comme une valeur de texte indivisible. L'exemple suivant présente un attribut atomique nommé "wine_type" :
AtomFacet(name='wine_type', value='Red')
-
Exceptions
- TypeError
La valeur indiquée n'est pas une chaîne de texte.
- ValueError
La valeur dépasse la longueur maximale autorisée.
- Classe NumberFacet
Attribut contenant une valeur numérique.
L'exemple suivant présente un attribut numérique nommé "wine_vintage" :
NumberFacet(name='wine_vintage', value=2000)
-
Exceptions
- TypeError
La valeur indiquée n'est pas numérique.
- ValueError
La valeur est hors plage.