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

SearchQueryBuilder

Search query builder. The search is performed on the global index and local segment indexes, where a segment is a subdivision of the global map. The process of selecting segments for search is done as follows (in descending priority order):

  • If an area is explicitly specified as a polygon in the request (spatial_restriction), it is taken into account first. The methods below in priority are disabled, but used to consider distances in the search relevancy.
  • When specifying a rectangular area of interest (bounding_rect), the search is performed in its neighbourhood.
  • If no higher-priority parameters are specified, the user's position is taken into account.

    • TODO: This condition is not working yet. It will be fixed in upcoming releases.

  • When mentioning a widely known object (city, region, or other toponym) in the search query, the segment that contains the point of the found object from the global index is added to the search.
  • If nothing from the above is specified, then the search is performed on the global index.

    • 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 viewing area.

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

    Set the object types allowed in the query result.

    By default is all 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

    default 10

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

    Set filtering for the search query.

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

    Set sorting for the 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