Package com.google.appengine.api.search.checkers

Class QueryOptionsChecker

    • Method Summary

      All Methods Static Methods Concrete Methods 
      Modifier and Type Method Description
      static List<String> checkFieldNames​(List<String> fieldNames)
      Checks that there are at most #MAXIMUM_NUMBER_OF_FIELDS_TO_RETURN field names and that each field name is valid.
      static int checkLimit​(int limit)
      Checks whether the number of documents to return is between 1 and the maximum.
      static int checkNumberFoundAccuracy​(int numberFoundAccuracy)
      Checks whether the minimum number of documents found accuracy is between 1 and the maximum.
      static Integer checkOffset​(Integer offset)
      Checks whether the offset is between 0 and the maximum.
      static com.google.appengine.api.search.proto.SearchServicePb.SearchParams checkValid​(com.google.appengine.api.search.proto.SearchServicePb.SearchParams params)
      Checks the search options are valid, specifically, has a non-null number of documents to return specification, a valid cursor if present, valid sort specification list, a valid collection of field names for sorting, and a valid scorer specification.

    • Constructor Detail

      • QueryOptionsChecker

        public QueryOptionsChecker()

    • Method Detail

      • checkLimit

        public static int checkLimit​(int limit)
        Checks whether the number of documents to return is between 1 and the maximum.
        Parameters:
        limit - the maximum number of documents to return in search results
        Returns:
        the checked number of documents to return
        Throws:
        IllegalArgumentException - if the number of documents to return is out of range

      • checkOffset

        public static Integer checkOffset​(Integer offset)
        Checks whether the offset is between 0 and the maximum. Can be null.
        Parameters:
        offset - the offset of the first result to return results
        Returns:
        the checked offset of the first result to return
        Throws:
        IllegalArgumentException - if the offset is out of range

      • checkNumberFoundAccuracy

        public static int checkNumberFoundAccuracy​(int numberFoundAccuracy)
        Checks whether the minimum number of documents found accuracy is between 1 and the maximum.
        Parameters:
        numberFoundAccuracy - the minimum number of documents found accuracy
        Returns:
        the checked accuracy
        Throws:
        IllegalArgumentException - if the minimum is out of range

      • checkFieldNames

        public static List<String> checkFieldNames​(List<String> fieldNames)
        Checks that there are at most #MAXIMUM_NUMBER_OF_FIELDS_TO_RETURN field names and that each field name is valid.
        Parameters:
        fieldNames - the list of field names to check
        Returns:
        the checked list of field names
        Throws:
        IllegalArgumentException - if the field names list size exceeds the maximum, or some name is invalid

      • checkValid

        public static com.google.appengine.api.search.proto.SearchServicePb.SearchParams checkValid​(com.google.appengine.api.search.proto.SearchServicePb.SearchParams params)
        Checks the search options are valid, specifically, has a non-null number of documents to return specification, a valid cursor if present, valid sort specification list, a valid collection of field names for sorting, and a valid scorer specification.
        Parameters:
        params - the SearchParams to check
        Returns:
        this checked SearchParams
        Throws:
        IllegalArgumentException - if some part of the specification is invalid