Query.Builder (Google App Engine API para Java)

com.google.appengine.api.search

Classe Query.Builder

  • java.lang.Object
    • com.google.appengine.api.search.Query.Builder
  • Classe de inclusão:
    Query


    public static class Query.Builder
    extends java.lang.Object
    Um construtor que cria objetos Query.
    • Detalhes do método

      • setOptions

        public Query.Builder setOptions(QueryOptions options)
        Define as opções de consulta.
        Parâmetros:
        options: as QueryOptions para aplicar aos resultados da pesquisa
        Retorna:
        este builder
      • setFacetOptions

        public Query.Builder setFacetOptions(FacetOptions options)
        Define as opções de atributos.
        Parâmetros:
        options: FacetOptions para aplicar aos resultados dos atributos
        Retorna:
        este builder
      • setEnableFacetDiscovery

        public Query.Builder setEnableFacetDiscovery(boolean value)
        Define a ativação da sinalização de descoberta de atributo.
        Retorna:
        este builder
      • addReturnFacet

        public Query.Builder addReturnFacet(FacetRequest facet)
        Solicita um atributo a ser retornado com os resultados da pesquisa. O atributo será incluído no resultado independentemente do número de valores que tem.
        Parâmetros:
        facet: a FacetRequest a ser adicionada para retornar atributos.
        Retorna:
        este builder
      • addFacetRefinementFromToken

        public Query.Builder addFacetRefinementFromToken(java.lang.String token)
        Adiciona um token de refinamento de atributo. O token é retornado por cada FacetResultValue. Haverá disjunção entre tokens referentes ao mesmo atributo e conjunção entre tokens referentes a diferentes atributos. Por exemplo, se os tokens de refinamento forem (name=wine_type,value=red), (name=wine_type,value=white) e (name=year, Range (2000,2010)), o resultado será refinado de acordo com:
         ((wine_type is red) OR (wine_type is white)) AND (year in Range(2000,2010))
         
        Parâmetros:
        token: o token retornado por FacetResultValue.getRefinementToken() ou FacetRefinement.toTokenString().
        Retorna:
        este builder
        Gera:
        java.lang.IllegalArgumentException: se o token não for válido.
      • addFacetRefinement

        public Query.Builder addFacetRefinement(FacetRefinement refinement)
        Adiciona um refinamento de atributo. Haverá disjunção entre refinamentos referentes ao mesmo atributo e conjunção entre refinamentos referentes a diferentes atributos. Por exemplo, se os refinamentos forem (name=wine_type,value=red), (name=wine_type,value=white) e (name=year, Range (2000,2010)), o resultado será refinado de acordo com:
         ((wine_type is red) OR (wine_type is white)) AND (year in Range.closedOpen(2000,2010))
         
        Parâmetros:
        refinement: um objeto FacetRefinement.
        Retorna:
        este builder
      • addReturnFacet

        public Query.Builder addReturnFacet(java.lang.String facetName)
        Adiciona uma solicitação de atributo apenas pelo nome dele.
        Parâmetros:
        facetName: o nome do atributo a ser adicionado para retornar atributos.
        Retorna:
        este builder
      • build

        public Query build(java.lang.String queryString)
        Cria uma Query com base na string de consulta e nos parâmetros definidos em Query.Builder. Uma string de consulta pode ser tão simples quanto um termo único ("foo") ou tão complexa quanto uma expressão booleana, incluindo nomes de campo ("title: hello OR body:important -october").
        Parâmetros:
        queryString: a string de consulta para analisar e aplicar a um índice
        Retorna:
        uma consulta compilada com base nos parâmetros inseridos neste builder, incluindo a queryString
        Gera:
        SearchQueryException: se a string de consulta for inválida
      • build

        public Query build()
        Constrói a mensagem.
        Retorna:
        a consulta criada com base nos parâmetros inseridos neste builder
        Gera:
        java.lang.IllegalArgumentException: se a string de consulta for inválida