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