La classe FacetRefinement viene utilizzata per restringere i risultati di ricerca in base a un valore del facet.
Il modo consigliato per utilizzare il perfezionamento dei parametri è utilizzare la stringa del token. Ogni FacetResult avrà un token accettabile anziché questo tipo. Per fornire una definizione manuale di FacetRefinement, un'istanza di questa classe può essere passata a SearchOptions.
FacetRefinement è definito nel modulo google.appengine.api.search.
Costruttore
Il costruttore della classe FacetRefinement è definito come segue:
class FacetRefinement(name, value=None, facet_range=None)
Costruisci un'istanza della classe
FacetRefinement.NOTA: deve essere impostato il valore o l'intervallo di aspetti, ma non entrambi.
Argomenti
- name
Imposta la proprietà name
- value
Imposta la proprietà value
- facet_range
Imposta la proprietà facet_range
Valore del risultato
Una nuova istanza della classe
FacetRefinement.
Eccezioni
- TypeError
Se uno dei parametri ha tipi non validi o viene passato un attributo sconosciuto.
- ValueError
Se uno dei parametri ha valori non validi.
Proprietà
Un'istanza della classe FacetRefinement ha le seguenti proprietà:
- name
Nome del perfezionamento della frazione.
- value
Valore stringa del perfezionamento del livello.
- intervallo
Intervallo numerico del perfezionamento del facet.
Metodi istanza
Le istanze della classe FacetRefinement hanno i seguenti metodi:
- ToTokenString()
Consente di convertire questo perfezionamento in una stringa di token sicura da utilizzare in HTML. Il formato di questa stringa potrebbe cambiare.
-
Valore del risultato
Una stringa di token sicura da utilizzare in HTML per questo perfezionamento della frazione.
- FromTokenString()
Questo metodo statico converte una stringa di token in un oggetto FacetRefinement. Non memorizzare stringhe di token tra versioni diverse dell'API perché la chiave potrebbe essere incompatibile.
-
Argomenti
- token_string
Una stringa di token creata dal metodo ToTokenString o restituita da un risultato di ricerca.
Valore del risultato
Un oggetto FacetRefinement.
Eccezioni
- ValueError
Se la stringa token non è valida.