Package com.here.android.mpa.search

The search package provides classes for performing places and geocoder searches.

See: Description

Interface Summary

Interface	Description
ResultListener<T>	Represents an event listener that reports information about the completion of a request.

Class Summary

Class	Description
Address	Provides textual address information for a Location.
AddressFilter	Defines constraints used to filter results based on their address.
AroundRequest	The AroundRequest represents sets of places within a specific location context, usually the location of the user.
AutoSuggest	Represents the base class for suggested places and searches.
AutoSuggestPlace	Represents an AutoSuggestPlace which contains information about a suggested Place .
AutoSuggestQuery	Represents an AutoSuggest with suggested completion of the given string
AutoSuggestSearch	Represents an AutoSuggestSearch which contains information about a refined search link.
Category	Represents a category with which a Place can be associated.
CategoryFilter	Represents a filter used when performing a search for popular places within a specific geographic area.
ContactDetail	Represents detailed information about a contact for a Place.
DiscoveryLink	Represents a discovery-related API link, used to retrieve a DiscoveryResultPage.
DiscoveryRequest	Represents an extended Request used to retrieve a DiscoveryResultPage object by way of Places search services.
DiscoveryResult	Represents a base class for a DiscoveryResult found in a DiscoveryResultPage.
DiscoveryResultPage	Represents a paginated collection of results from a DiscoveryRequest search, explore, or here request.
EditorialMedia	Represents editorial content about a Place.
ExploreRequest	Creates a ExploreRequest using a specified location context and category filter.
ExtendedAttribute	Represents additional detailed information about a Place.
GeocodeRequest	The GeocodeRequest represents an extended Request used to retrieve GeocodeResult data by way of Geocoder search services.
GeocodeResult	Represents the result of a geocode request.
HereRequest	The HereRequest answers the questions "Where am I?" and "What's right here where I am standing?" The search results consist of a list of places with addresses that lie within the vicinity of the search location.
ImageMedia	Represents image content related to a Place.
Link	Represents a Link indicating that the application must make another request to retrieve the desired resource.
Location	Represents the physical location of a Place.
Media	Represents the base class for additional rich content about a Place.
MediaCollectionPage<T>	Represents a base class for a paginateable collection of Media objects of a specific type.
MediaCollectionPageRequest<T>	Represents an extended Request used to retrieve MediaCollectionPage information for a specific type of Media associated with a Place, by way of Places search services.
NavigationPosition	Represents a position that should be used when calculating routes for navigation.
Place	Represents a set of data about a physical place.
PlaceLink	Represents discovery information about a Place.
PlaceRequest	Represents an extended Request used to retrieve a Place object by way of Places search services.
RatingMedia	Represents rating content about a Place.
Ratings	Represents a summary of user-supplied ratings for a Place.
ReportingLink	Represents a ReportingLink for getting options for reporting on content if it contains inappropriate content.
Request<T>	Represents a base class for a search request.
ReverseGeocodeRequest	The ReverseGeocodeRequest represents an extended Request used to retrieve Location data by way of Geocoder search services.
ReviewMedia	Represents review content about a Place.
SearchRequest	The SearchRequest processes text string queries based on the user's input to find specific places.
SupplierLink	Represents a SupplierLink which contains meta-information about a supplier.
TextAutoSuggestionRequest	Represents an extended Request used to retrieve a List of suggested search terms, instants results and refined search links by way of Places search services.
TilesLink	Represents a list of URLs that can be used as base URLs for place tile requests.
TransitDeparture	Represents information about a single departure.
TransitDeparturesAttribute	Represents a Transit Departures Extended Attribute that is associated with public transport stop/station and contains information about scheduled departures from the place.
TransitDestination	Represents a destination served from station/stop.
TransitLine	Represents a public transport line.
TransitLineCategory	Represents the category information for the public transport line.
TransitLinesAttribute	Represents a Transit Lines Extended Attribute that is associated with public transport stop/station and contains information about the lines and destinations.
TransitLineStyle	Represents the styling guideline information for the public transport line.
TransitOperator	Represents a public transport operator.
TransitOperatorLink	Represents an additional link associated with transit operator.
TransitOperatorSupplier	Represents a supplier of the public transport operator's schedule.
TransitSchedulePage	Represents departure information for a public transport stop/station.
TransitSchedulePageRequest	Represents an extended Request used to retrieve TransitSchedulePage information associated with a Place, by way of Places search services.
UserLink	Represents a UserLink which contains additional attributes to describe a user.
ViaLink	Represents a ViaLink to an external website of the supplier of content.

Enum Summary

Enum	Description
AutoSuggest.Type	Represents values describing supported AutoSuggest types for a text suggestion.
Category.Global	Represents a set of fixed category filters on the resources of the Places search service.
DiscoveryResult.ResultType	Represents values describing possible DiscoveryResult types.
ErrorCode	Represents values describing possible search request errors.
Media.Type	Represents values describing supported Media types for a Place.
Request.Connectivity	Represents values describing possible types of connectivity that the request is performed.
ReverseGeocodeMode	Enumeration for ReverseGeocodeRequest customisation.
RichTextFormatting	Represents values describing possible formats for rich text content.
TextAutoSuggestionRequest.AutoSuggestFilterType	Represents values describing AutoSuggest response's result filter types that can be used to filter the AutoSuggest response.

Exception Summary

Exception	Description
HereRequest.UnsupportedFilterException	Thrown when a building filter is unsupported because the building identifier is missing or malformed.

Package com.here.android.mpa.search Description

The search package provides classes for performing places and geocoder searches.

• com.here.android.mpa.search.RequestCreator.Places provides methods to create new requests to search and explore places near a given position.
• com.here.android.mpa.search.RequestCreator.Geocoder provides methods to create new requests to perform address and reverse geocode searches.

The typical steps when perform a search are:

• Implement the ResultListener interface to handle the completion of the search
• Create a request using RequestCreator.Places or RequestCreator.Geocoder
• Start the search by invoking execute(ResultListener)
• When the search completes, the data returned in the ResultListener.onCompleted() callback is triggered

To use this feature, your application must include the google-gson library (release 2.2.4 or a compatible version) on its class path. This library can be downloaded from the google-gson project website at http://code.google.com/p/google-gson/. Attempting to use this feature without adding this library will cause runtime errors.

For more details on performing searches, please consult the "Places" section in the HERE SDK for Android Developer's Guide.