La classe FacetRefinement

La classe FacetRefinement est utilisée pour affiner les résultats de la recherche en fonction d'une valeur d'attribut.

La méthode recommandée pour utiliser le raffinement d'attribut consiste à utiliser sa chaîne de jeton. Chaque FacetResult aura un jeton acceptable à la place de cette classe. Pour fournir FacetRefinement manuellement, une instance de cette classe peut être transmise à SearchOptions.

FacetRefinement est défini dans le module google.appengine.api.search.

Constructeur

Le constructeur de la classe FacetRefinement est défini comme suit :

classe FacetRefinement (nom, valeur = None, facet_range = None)

Construire une instance de la classe FacetRefinement.

Remarque : La valeur ou la facet_range doit être définie, mais pas les deux.

Arguments

name

Définit la propriété du nom

value

Définit la propriété value

FacetRange

Définit la propriété facet_range

Valeur du résultat

Une nouvelle instance de la classe FacetRefinement.

Exceptions

TypeError

Si l'un des paramètres contient un type non valide ou si un attribut inconnu est transmis.

ValueError

Si l'un des paramètres possède des valeurs non valides.

Propriétés

Une instance de la classe FacetRefinement possède les propriétés suivantes :

name

nom du raffinement de l'attribut.

value

valeur de chaîne du raffinement de l'attribut.

range

plage numérique du raffinement de l'attribut.

Méthodes des instances

Les instances de la classe FacetRefinement utilisent les méthodes suivantes :

ToTokenString()

Convertit ce raffinement en chaîne de jeton pouvant être utilisée en HTML. Le format de cette chaîne peut changer.

Valeur du résultat

Une chaîne de jeton sécurisée à utiliser en HTML pour ce raffinement d'attribut.

FromTokenString()

Cette méthode statique convertit une chaîne de jeton en objet FacetRefinement. Ne stockez pas de chaînes de jeton entre différentes versions de l'API, car la clé pourrait être incompatible.

Arguments

token_string

Chaîne de jeton créée par la méthode ToTokenString ou renvoyée par un résultat de recherche.

Valeur du résultat

Un objet FacetRefinement.

Exceptions

ValueError

Si token_string n'est pas valide.

Cette page vous a-t-elle été utile ? Évaluez-la :

Envoyer des commentaires concernant…

Environnement standard App Engine pour Python 2