Klasse "FacetRefinement"

Mit der Klasse FacetRefinement werden Ergebnisse auf der Grundlage eines Attributwerts eingegrenzt.

Es wird empfohlen, dem 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 wird im Modul google.appengine.api.search definiert.

Konstruktor

Die Definition des Konstruktors für die Klasse FacetRefinement sieht so aus:

class FacetRefinement(name, value=None, facet_range=None)

Erstellt 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.

value

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.

Properties

Eine Instanz der Klasse FacetRefinement hat die folgenden Properties:

name

Name des Attributsuchfilters.

value

Stringwert des Attributsuchfilters.

range

Numerischer Bereich des Attributsuchfilters.

Instanzmethoden

Die 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.

Hat Ihnen diese Seite weitergeholfen? Teilen Sie uns Ihr Feedback mit:

Feedback geben zu...

App Engine-Standardumgebung für Python 2