A classe FacetRefinement é usada para restringir os resultados da pesquisa com base num valor de faceta.
A forma recomendada de usar o refinamento de facetas é usar a respetiva string de token. Cada FacetResult tem um token aceitável em vez desta classe. Para fornecer o FacetRefinement manual, pode transmitir uma instância desta classe para SearchOptions.
FacetRefinement está definido no módulo google.appengine.api.search.
Construtor
O construtor da classe FacetRefinement é definido da seguinte forma:
class FacetRefinement(name, value=None, facet_range=None)
Construa uma instância da classe
FacetRefinement.NOTA: deve definir o valor ou o facet_range, mas não ambos.
Argumentos
- name
Define a propriedade name
- valor
Define a propriedade de valor
- 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 for transmitido um atributo desconhecido.
- 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 de facetas.
- valor
Valor de string do refinamento de facetas.
- range
Intervalo numérico do refinamento de atributos.
Métodos de instância
As instâncias da classe FacetRefinement têm os seguintes métodos:
- ToTokenString()
Converte este refinamento numa string de token segura para utilização em HTML. O formato desta string pode mudar.
-
Valor do resultado
Uma string de token segura para ser usada em HTML para este refinamento de faceta.
- FromTokenString()
Este método estático converte uma string de token num objeto FacetRefinement. Não armazene strings de tokens entre diferentes versões da API, uma vez que a chave pode ser incompatível.
-
Argumentos
- token_string
Uma string de token criada pelo método ToTokenString ou devolvida por um resultado da pesquisa.
Valor do resultado
Um objeto FacetRefinement.
Exceções
- ValueError
Se o token_string for inválido.