La clase FacetRefinement se usa para restringir los resultados de la búsqueda en función de un valor de faceta.
Se recomienda usar la string de token para definir mejor la faceta. Cada FacetResult tendrá un token aceptable en lugar de esta clase. Con el fin de proporcionar FacetRefinement manual, se puede pasar una instancia de esta clase a SearchOptions.
FacetRefinement se define en el módulo google.appengine.api.search.
Constructor
El constructor para la clase FacetRefinement se define de la siguiente manera:
clase FacetRefinement(name, value=None, facet_range=None)
Construye una instancia de la clase
FacetRefinement.NOTA: Se debe configurar el valor o facet_range, pero no se deben configurar ambos.
Argumentos
- name
Configura la propiedad del nombre.
- value
Configura la propiedad del valor.
- facet_range
Configura la propiedad de facet_range.
Valor del resultado
Una instancia nueva de la clase
FacetRefinement.
Excepciones
- TypeError
Se muestra si cualquiera de los parámetros tiene un tipo no válido, o si se pasa un atributo desconocido.
- ValueError
Se muestra si cualquiera de los parámetros tiene valores no válidos.
Propiedades
Una instancia de la clase FacetRefinement tiene las siguientes propiedades:
- name
El nombre del perfeccionamiento de la faceta.
- value
El valor de string del perfeccionamiento de la faceta.
- range
El rango numérico de la faceta de refinamiento.
Métodos de instancia
Las instancias de la clase FacetRefinement tienen los siguientes métodos:
- ToTokenString()
Convierte este perfeccionamiento en una string de token segura para usar en HTML. El formato de la string puede variar.
-
Valor del resultado
Una string de token segura para usar en HTML con el fin de realizar este perfeccionamiento de faceta.
- FromTokenString()
Este método estático convierte una string de token en un objeto FacetRefinement. No almacenes strings de token entre diferentes versiones de API porque es posible que la clave no sea compatible.
-
Argumentos
- token_string
Una string de token creada con el método ToTokenString o que se muestra como el resultado de una búsqueda.
Valor de resultado
Un objeto FacetRefinement.
Excepciones
- ValueError
Se muestra si token_string no es válida.