ru.dgis.sdk.directory.SearchQueryBuilder | Android SDK | 2GIS Documentation
Android SDK
Maps
Search
Navigation
On-Premise
Urbi Pro

SearchQueryBuilder

Search query builder. The search is carried out by the global index, as well as by the local indexes of the segments, where the segment is some piece of the global map partition. The procedure for selecting segments for the search is carried out in the following ways (in descending order of priority):

  • If an area is explicitly specified as a polygon in the request (spatial_restriction), then it is taken into account first. Methods lower in priority are disabled, but are used to take into account distances in search relevance.
  • When specifying a rectangular region of interest (bounding_rect), the search is carried out in some of its neighborhood.
  • If no superior methods are specified priority parameters, then the user's position point is taken into account.

    • TODO: This condition does not work yet. It will be fixed in the next releases.

  • When a well-known object (city, region or other toponym) is mentioned in the query text, the segment where the point of the found object from the global index falls into is added to the search.
  • If none of the above is specified, then the global index is searched.

    • Extends: ru.dgis.sdk.NativeObject
    Methods
    fun setSpatialRestriction(spatialRestriction: List?<GeoPoint>): SearchQueryBuilder

    Set the search area limit in the form of a polygon. The first and the last points of the polygon do not have to match.

    No limit by default.

    Parameters
    spatialRestriction
    Returns
    fun setAreaOfInterest(rect: GeoRect?): SearchQueryBuilder

    Set a rectangular region of interest in geographic coordinates. A typical value is visible_rect from ICamera - the enclosing rectangle of the viewport.

    Parameters
    rect
    Returns
    fun setAllowedResultTypes(allowedResultTypes: List<ObjectType>): SearchQueryBuilder

    Set the object types allowed in the query result.

    The default set includes all types except Route.

    Parameters
    allowedResultTypes
    Returns
    fun setPageSize(pageSize: Int): SearchQueryBuilder

    Set your preferred number of elements on the results page. Valid values are 1;50

    The default one is 10.

    Parameters
    pageSize
    Returns
    fun setDirectoryFilter(filter: DirectoryFilter): SearchQueryBuilder

    Set filtering for a search query.

    Parameters
    filter
    Returns
    fun setSortingType(sortingType: SortingType): SearchQueryBuilder

    Set sorting for a search query.

    Parameters
    sortingType
    Returns
    fun build(): SearchQuery

    Create a search query.

    Returns
    @JvmStatic
fun fromQueryText(queryText: String): SearchQueryBuilder

    Start building a text search query with the specified text.

    Parameters
    queryText
    Returns
    @JvmStatic
fun fromQuery(query: SearchQuery): SearchQueryBuilder

    Start building a query based on #query to change some of the parameters.

    The original #query remains unchanged.

    Parameters
    query
    Returns