com.tomtom.online.sdk.search.data.alongroute

Class AlongRouteSearchQueryBuilder

java.lang.Object

com.tomtom.online.sdk.search.data.alongroute.AlongRouteSearchQueryBuilder

All Implemented Interfaces:

IAlongRouteSearchQuery

public class AlongRouteSearchQueryBuilder
extends java.lang.Object
implements IAlongRouteSearchQuery

Builder class used to create AlongRouteSearchQuery.

Constructor Summary

Constructors

Constructor and Description
AlongRouteSearchQueryBuilder(java.lang.String term, java.util.List<LatLng> route, java.lang.Integer maxDetourTime)

Method Summary

Modifier and Type	Method and Description
AlongRouteSearchQuery	build() Creates a new instance of AlongRouteSearchQuery.
static AlongRouteSearchQueryBuilder	create(java.lang.String term, java.util.List<LatLng> route, java.lang.Integer maxDetourTime) Builder used to create an instance of AlongRouteSearchQuery.
AlongRouteSearchQueryBuilder	withBrandSet(java.lang.String brandSet) A comma-separated list of brand names which could be used to restrict the result to Points Of Interest of specific brands.
AlongRouteSearchQueryBuilder	withCategorySet(java.util.List<java.lang.Long> categorySet) Restricts the results to the categories of provided POIs.
AlongRouteSearchQueryBuilder	withDetourOffset() Turns on the calculation of the distance between the start of the route and the starting point of the detour to a POI.
AlongRouteSearchQueryBuilder	withEVConnectorSetFilter(java.lang.String EVConnectorSetFilter) A comma-separated list of connector types which could be used to restrict the result to Points Of Interest of type Electric Vehicle Station, supporting specific connector types.
AlongRouteSearchQueryBuilder	withGeopoliticalView(java.lang.String geopoliticalView)
AlongRouteSearchQueryBuilder	withLimit(java.lang.Integer limit) The upper limit of the number of results.
AlongRouteSearchQueryBuilder	withMapCodes(java.util.Set<MapCodeType> mapCodes) Enables the return of mapcodes.
AlongRouteSearchQueryBuilder	withOpeningHours(OpeningHoursMode openingHours) When used includes a list of opening hours for a POI (Points of Interest).
AlongRouteSearchQueryBuilder	withSortBy(SortBy sortBy) Sorts the returned results by the provided criteria.
AlongRouteSearchQueryBuilder	withSpreadingMode(SpreadingMode spreadingMode) Enables the spreading of returned results evenly along the route.
AlongRouteSearchQueryBuilder	withTimeZone(TimeZoneType timeZone) When used includes POIs' time zones.

Methods inherited from class java.lang.Object

clone, equals, finalize, getClass, hashCode, notify, notifyAll, toString, wait, wait, wait

Constructor Detail

AlongRouteSearchQueryBuilder

public AlongRouteSearchQueryBuilder(java.lang.String term,
                                    java.util.List<LatLng> route,
                                    java.lang.Integer maxDetourTime)

Method Detail

withLimit

@NonNull
public AlongRouteSearchQueryBuilder withLimit(java.lang.Integer limit)

Description copied from interface: IAlongRouteSearchQuery

The upper limit of the number of results.

Specified by:

withLimit in interface IAlongRouteSearchQuery

Parameters:

limit - The upper limit of the number of results.

Returns:

The builder of the query with a new value for the limit set.

withGeopoliticalView

@NonNull
public AlongRouteSearchQueryBuilder withGeopoliticalView(java.lang.String geopoliticalView)

withEVConnectorSetFilter

@NonNull
public AlongRouteSearchQueryBuilder withEVConnectorSetFilter(java.lang.String EVConnectorSetFilter)

Description copied from interface: IAlongRouteSearchQuery

A comma-separated list of connector types which could be used to restrict the result to Points Of Interest of type Electric Vehicle Station, supporting specific connector types.

Specified by:

withEVConnectorSetFilter in interface IAlongRouteSearchQuery

Parameters:

EVConnectorSetFilter - A comma-separated list of connector types.

Returns:

The builder of the query with a new value for evConnectorSet.

withBrandSet

@NonNull
public AlongRouteSearchQueryBuilder withBrandSet(java.lang.String brandSet)

Description copied from interface: IAlongRouteSearchQuery

A comma-separated list of brand names which could be used to restrict the result to Points Of Interest of specific brands.

Specified by:

withBrandSet in interface IAlongRouteSearchQuery

Parameters:

brandSet - A comma-separated list of brand names.

Returns:

The builder of the query with a new value for brand set set.

withDetourOffset

@NonNull
public AlongRouteSearchQueryBuilder withDetourOffset()

Description copied from interface: IAlongRouteSearchQuery

Turns on the calculation of the distance between the start of the route and the starting point of the detour to a POI. When specified, the detourOffset is present in the response.

Specified by:

withDetourOffset in interface IAlongRouteSearchQuery

Returns:

The builder of the query with the enabled detour offset calculation.

withSortBy

@NonNull
public AlongRouteSearchQueryBuilder withSortBy(SortBy sortBy)

Description copied from interface: IAlongRouteSearchQuery

Sorts the returned results by the provided criteria. If the method is not called, the results by default are sorted using the distance criteria.

Specified by:

withSortBy in interface IAlongRouteSearchQuery

Parameters:

sortBy - The enum indicating the sorting criteria.

Returns:

The builder of the query with a new value for sortBy.

withSpreadingMode

@NonNull
public AlongRouteSearchQueryBuilder withSpreadingMode(SpreadingMode spreadingMode)

Description copied from interface: IAlongRouteSearchQuery

Enables the spreading of returned results evenly along the route.

Specified by:

withSpreadingMode in interface IAlongRouteSearchQuery

Parameters:

spreadingMode - The enum indicating the spreading mode.

Returns:

The builder of the query with a new value for spreadingMode.

withCategorySet

@NonNull
public AlongRouteSearchQueryBuilder withCategorySet(java.util.List<java.lang.Long> categorySet)

Description copied from interface: IAlongRouteSearchQuery

Restricts the results to the categories of provided POIs.

Specified by:

withCategorySet in interface IAlongRouteSearchQuery

Parameters:

categorySet - Restricts the POIs in the Response to those whose id is listed in the categorySet.

Returns:

The builder of the query with a new value for categorySet.

withOpeningHours

@NonNull
public AlongRouteSearchQueryBuilder withOpeningHours(OpeningHoursMode openingHours)

Description copied from interface: IAlongRouteSearchQuery

When used includes a list of opening hours for a POI (Points of Interest).

Specified by:

withOpeningHours in interface IAlongRouteSearchQuery

Parameters:

openingHours - The opening hours scope.

Returns:

A reference to the builder object.

withMapCodes

@NonNull
public AlongRouteSearchQueryBuilder withMapCodes(java.util.Set<MapCodeType> mapCodes)

Description copied from interface: IAlongRouteSearchQuery

Enables the return of mapcodes.

Specified by:

withMapCodes in interface IAlongRouteSearchQuery

Parameters:

mapCodes - The enum type indicating supported MapCodes.

Returns:

A reference to the builder object.

withTimeZone

public AlongRouteSearchQueryBuilder withTimeZone(TimeZoneType timeZone)

Description copied from interface: IAlongRouteSearchQuery

When used includes POIs' time zones.

Specified by:

withTimeZone in interface IAlongRouteSearchQuery

Parameters:

timeZone - The enum indicating the type of the time zone.

Returns:

A reference to the builder object.

create

public static AlongRouteSearchQueryBuilder create(java.lang.String term,
                                                  java.util.List<LatLng> route,
                                                  java.lang.Integer maxDetourTime)

Builder used to create an instance of AlongRouteSearchQuery. Once constructed, the user cannot change the field values.

Returns:

A newly created builder object for AlongRouteSearchQuery to be used for further processing.

build

public AlongRouteSearchQuery build()

Creates a new instance of AlongRouteSearchQuery.