Package com.here.sdk.search

Class CategoryQuery

  • java.lang.Object
    • com.here.sdk.search.CategoryQuery
  • public final class CategoryQuery
extends java.lang.Object

    The options to specify a query by categories.

    • Field Detail

      • categories

        @NonNull
public java.util.List<PlaceCategory> categories

        List of categories to be included. A place can be assigned multiple categories. If any of them is in CategoryQuery.categories, but none are in CategoryQuery.excludeCategories, that place will be included in the response.

      • excludeCategories

        @NonNull
public java.util.List<PlaceCategory> excludeCategories

        List of categories and subcategories to be excluded. A place can be assigned multiple categories. If any of them is in CategoryQuery.excludeCategories, that place will not be included in the response, regardless of whether any of its assigned categories have been included in CategoryQuery.categories. In short, an exclusion will always win over an inclusion. This is especially useful for excluding specific subcategories from the main category.

      • includeChains

        @NonNull
public java.util.List<PlaceChain> includeChains

        List of chains to be included. A place can be assigned multiple chains. If any of them is in CategoryQuery.includeChains, but none are in CategoryQuery.excludeChains, that place will be included in the response.

      • excludeChains

        @NonNull
public java.util.List<PlaceChain> excludeChains

        List of chains to be excluded. A place can be assigned multiple chains. If any of them is in CategoryQuery.excludeChains, that place will not be included in the response, regardless of whether any of its assigned chains have been included in CategoryQuery.includeChains. In short, an exclusion will always win over an inclusion.

      • includeFoodTypes

        @NonNull
public java.util.List<PlaceFoodType> includeFoodTypes

        List of food types to be included. A place can be assigned multiple food types. If any of them is in CategoryQuery.includeFoodTypes, but none are in CategoryQuery.excludeFoodTypes, that place will be included in the response.

      • excludeFoodTypes

        @NonNull
public java.util.List<PlaceFoodType> excludeFoodTypes

        List of food types to be excluded. A place can be assigned multiple food types. If any of them is in CategoryQuery.excludeFoodTypes, that place will not be included in the response, regardless of whether any of its assigned food types have been included in CategoryQuery.includeFoodTypes. In short, an exclusion will always win over an inclusion.

      • filter

        @Nullable
public java.lang.String filter

        Full-text filter on POI names/titles. Results with a partial match are included in the response. By default the value is set to null and results will be based on other parameters provided.

      • placeFilter

        @NonNull
public PlaceFilter placeFilter

        The filter options to specify a place in query. Consists of fuel and truck options.

      • area

        @NonNull
public CategoryQuery.Area area

        Area in which to provide the most relevant places.

    • Constructor Detail

      • CategoryQuery

        public CategoryQuery​(@NonNull
                     PlaceCategory category,
                     @NonNull
                     CategoryQuery.Area area)

        Constructs a new instance of this class from provided parameters.

        Parameters:
        category -

        Category for query

        area -

        Area in which to provide the most relevant places.

      • CategoryQuery

        public CategoryQuery​(@NonNull
                     java.util.List<PlaceCategory> categories,
                     @NonNull
                     CategoryQuery.Area area)

        Constructs a new instance of this class from provided parameters.

        Parameters:
        categories -

        List of categories.

        area -

        Area in which to provide the most relevant places.

      • CategoryQuery

        public CategoryQuery​(@NonNull
                     PlaceCategory category,
                     @NonNull
                     java.lang.String filter,
                     @NonNull
                     CategoryQuery.Area area)

        Constructs a new instance of this class from provided parameters.

        Parameters:
        category -

        Category for query

        filter -

        Full-text filter on POI names/titles. Results with a partial match are included in the response.

        area -

        Area in which to provide the most relevant places.

      • CategoryQuery

        public CategoryQuery​(@NonNull
                     java.util.List<PlaceCategory> categories,
                     @NonNull
                     java.lang.String filter,
                     @NonNull
                     CategoryQuery.Area area)

        Constructs a new instance of this class from provided parameters.

        Parameters:
        categories -

        List of categories.

        filter -

        Full-text filter on POI names/titles. Results with a partial match are included in the response.

        area -

        Area in which to provide the most relevant places.

    • Method Detail

      • equals

        public boolean equals​(java.lang.Object obj)
        Overrides:
        equals in class java.lang.Object

      • hashCode

        public int hashCode()
        Overrides:
        hashCode in class java.lang.Object