com.inrix.sdk

Class CompositeTileManager

java.lang.Object

com.inrix.sdk.CompositeTileManager

public class CompositeTileManager
extends Object

Manages asynchronous retrieval of tiles that contain composite graphical information, such as maps, traffic, and weather.

Use the following steps to obtain the composite tile:

1. Create a CompositeTileManager.CompositeTileMetadataOptions object.
2. Use it to call the CompositeTileManager.getMetadata(com.inrix.sdk.CompositeTileManager.CompositeTileMetadataOptions, com.inrix.sdk.CompositeTileManager.ICompositeTileMetadataListener) method.
3. From the listener, obtain a CompositeTileMetadata object.
4. From this object, obtain an image key.
5. Use the image key to create a CompositeTileManager.CompositeTileOptions object.
6. Use this object to call the CompositeTileManager.getUrl(com.inrix.sdk.CompositeTileManager.CompositeTileOptions) method.
7. Obtain the tile image from the received URL.

Nested Class Summary

Nested Classes

Modifier and Type	Class and Description
static class	CompositeTileManager.CompositeTileManagerException A exception that is thrown when there is an error with a CompositeTileManager operation.
static class	CompositeTileManager.CompositeTileMetadataOptions Contains options for requesting composite tile metadata, such as size and location.
static class	CompositeTileManager.CompositeTileOptions Contains options for getting a URL for a composite tile using an image key.
static interface	CompositeTileManager.ICompositeTileMetadataListener The response listener for retrieving composite tile metadata.
static class	CompositeTileManager.MapLocale Supported map locales.

Method Summary

Methods

Modifier and Type	Method and Description
ICancellable	getMetadata(CompositeTileManager.CompositeTileMetadataOptions options, CompositeTileManager.ICompositeTileMetadataListener listener) Gets the metadata for the requested composite tile, including route information, incidents, and the image key that is used in obtaining the composite tile image.
String	getUrl(CompositeTileManager.CompositeTileOptions options) Gets the URL for the composite tile based on specified options.

Methods inherited from class java.lang.Object

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

Method Detail

getMetadata

public final ICancellable getMetadata(CompositeTileManager.CompositeTileMetadataOptions options,
                       CompositeTileManager.ICompositeTileMetadataListener listener)

Gets the metadata for the requested composite tile, including route information, incidents, and the image key that is used in obtaining the composite tile image.

Parameters:

options - The composite tile metadata options.

listener - The response listener.

Returns:

An instance of ICancellable that can be used to cancel this request.

getUrl

public final String getUrl(CompositeTileManager.CompositeTileOptions options)

Gets the URL for the composite tile based on specified options.

The client needs to wait for the SDK to initialize in order for this method to work.

Parameters:

options - The composite tile request options.

Returns:

The composite tile URL or null if the SDK has not finished initializing.