Die Klasse FacetRefinement wird verwendet, um Suchergebnisse basierend auf einem Attributwert einzugrenzen.
Es wird empfohlen, den Attributsuchfilter mit seinem Tokenstring zu verwenden. Jedes FacetResult hat ein Token, das anstelle dieser Klasse akzeptiert werden kann. Wenn Sie FacetRefinement manuell bereitstellen möchten, können Sie eine Instanz dieser Klasse an SearchOptions übergeben.
FacetRefinement ist im Modul google.appengine.api.search definiert.
Konstruktor
Der Konstruktor für die Klasse FacetRefinement ist so definiert:
class FacetRefinement(name, value=None, facet_range=None)
Konstruieren Sie eine Instanz der Klasse
FacetRefinement.HINWEIS: Es sollte entweder der Wert oder der facet_range festgelegt werden, aber nicht beides.
Argumente
- name
Legt die Namens-Property fest.
- Wert
Legt die Wert-Property fest.
- facet_range
Legt die Property "facet_range" fest.
Ergebniswert
Eine neue Instanz der Klasse
FacetRefinement.
Ausnahmen
- TypeError
Wenn einer der Parameter ungültige Typen aufweist oder ein unbekanntes Attribut übergeben wird.
- ValueError
Wenn einer der Parameter ungültige Werte hat.
Eigenschaften
Eine Instanz der Klasse FacetRefinement hat die folgenden Attribute:
- name
Name des Attributsuchfilters.
- Wert
Stringwert des Attributsuchfilters.
- Bereich
Numerischer Bereich des Attributsuchfilters.
Instanzmethoden
Instanzen der Klasse FacetRefinement haben die folgenden Methoden:
- ToTokenString()
Wandelt diesen Suchfilter in einen Tokenstring um, der sicher in HTML verwendet werden kann. Das Format dieses Strings kann sich ändern.
-
Ergebniswert
Tokenstring, der für diesen Attributsuchfilter sicher in HTML verwendet werden kann.
- FromTokenString()
Bei dieser statischen Methode wird ein Tokenstring in ein FacetRefinement-Objekt umgewandelt. Speichern Sie Tokenstrings nicht in verschiedenen API-Versionen, da der Schlüssel inkompatibel sein könnte.
-
Argumente
- token_string
Mit der Methode "ToTokenString" erstellter oder von einem Suchergebnis zurückgegebener Tokenstring.
Ergebniswert
Ein "FacetRefinement"-Objekt.
Ausnahmen
- ValueError
Wenn der token_string ungültig ist.