La classe FacetRefinement viene utilizzata per restringere i risultati di ricerca in base a un valore facet.
Il modo consigliato per utilizzare il perfezionamento facet consiste nell'utilizzare la relativa stringa token. Ogni facetResult avrà un token accettabile al posto di questa classe. Per fornire manualmente FacetRefinement, è possibile passare un'istanza di questa classe a SearchOptions.
FacetRefinement è definito nel modulo google.appengine.api.search.
Costruttore
Il costruttore della classe FacetRefinement viene definito come segue:
class FacetRefinement(name, value=None, facet_range=None)
Crea un'istanza di classe
FacetRefinement.NOTA: è necessario impostare il valore o l'intervallo_facet, ma non entrambi.
Argomenti
- nome
Imposta la proprietà del nome
- valore
Imposta la proprietà del valore
- facet_range
Imposta la proprietà facet_range
Valore risultato
Una nuova istanza della classe
FacetRefinement.
Eccezioni
- TypeError
Se uno o più parametri hanno tipi non validi o se viene trasmesso un attributo sconosciuto.
- ValueError
Se uno o più parametri presentano valori non validi.
Proprietà
Un'istanza della classe FacetRefinement ha le seguenti proprietà:
- nome
nome del perfezionamento facet.
- valore
valore stringa del perfezionamento facet.
- intervallo
intervallo numerico del perfezionamento facet.
Metodi di istanza
Le istanze della classe FacetRefinement hanno i seguenti metodi:
- ToTokenString()
Converte questo perfezionamento in una stringa token che può essere utilizzata in HTML. Il formato di questa stringa può cambiare.
-
Valore risultato
Una stringa token che può essere utilizzata in modo sicuro nel codice HTML per questo perfezionamento facet.
- FromTokenString()
Questo metodo statico converte una stringa di token in un oggetto FacetRefinement. Non archiviare le stringhe di token tra versioni diverse dell'API perché la chiave potrebbe non essere compatibile.
-
Argomenti
- token_string
Una stringa di token creata dal metodo ToTokenString o restituita da un risultato di ricerca.
Valore risultato
Un oggetto FacetRefinement.
Eccezioni
- ValueError
Se il valore token_string non è valido.