A classe FacetRefinement é usada para restringir os resultados da pesquisa com base em um valor de atributo.
A maneira recomendada de usar o refinamento de atributo é usar a respectiva string de token. Cada FacetResult terá um token aceitável em vez dessa classe. Para fornecer FacetRefinement manual, uma instância dessa classe pode ser transmitida para SearchOptions.
FacetRefinement é definido no módulo google.appengine.api.search.
Construtor
O construtor da classe FacetRefinement é definido da seguinte maneira:
classe FacetRefinement(name, value=None, facet_range=None)
Crie uma instância da classe
FacetRefinement.OBSERVAÇÃO: o valor ou o facet_range precisam ser definidos, mas não os dois.
Argumentos
- name
Define a propriedade "name"
- value
Define a propriedade "value"
- facet_range
Define a propriedade "facet_range"
Valor do resultado
Uma nova instância da classe
FacetRefinement.
Exceções
- TypeError
Se algum dos parâmetros tiver tipos inválidos ou um atributo desconhecido for passado.
- ValueError
Se algum dos parâmetros tiver valores inválidos.
Propriedades
Uma instância da classe FacetRefinement tem as seguintes propriedades:
- name
Nome do refinamento do atributo.
- value
Valor da string do refinamento do atributo.
- Intervalo
Intervalo numérico do refinamento do atributo.
Métodos de instância
As instâncias de classe FacetRefinement têm os seguintes métodos:
- ToTokenString()
Converte este refinamento em uma string de token seguro para ser usada em HTML.
-
Valor do resultado
Uma string de token segura para ser usada em HTML neste refinamento de atributo.
- FromTokenString()
Este método estático converte uma string de token em um objeto FacetRefinement. Não armazene strings de token entre diferentes versões da API, porque a chave pode ser incompatível.
-
Argumentos
- token_string
Uma string de token criada pelo método ToTokenString ou retornada por um resultado de pesquisa.
Valor do resultado
Um objeto FacetRefinement.
Exceções
- ValueError
Se o token_string é inválido.