com.inrix.sdk

Class CompositeTileManager.CompositeTileMetadataOptions

java.lang.Object

com.inrix.sdk.CompositeTileManager.CompositeTileMetadataOptions

Enclosing class:

CompositeTileManager

public static final class CompositeTileManager.CompositeTileMetadataOptions
extends Object

Contains options for requesting composite tile metadata, such as size and location.

See Also:

CompositeTileManager.getMetadata(com.inrix.sdk.CompositeTileManager.CompositeTileMetadataOptions, com.inrix.sdk.CompositeTileManager.ICompositeTileMetadataListener)

Field Summary

Fields

Modifier and Type	Field and Description
static int	DEFAULT_HEIGHT Default height of the tile.
static int	DEFAULT_QUALITY Default quality of the tile.
static int	DEFAULT_WIDTH Default width of the tile.
static String	MAP_STYLE_DAY Day map style.
static String	MAP_STYLE_NIGHT Night map style.
static int	MAX_HEIGHT Maximum height of the tile.
static int	MAX_MAX_ALTERNATES Maximum number of route alternates.
static int	MAX_QUALITY Maximum quality of the tile.
static int	MAX_WIDTH Maximum width of the tile.
static int	MIN_HEIGHT Minimum height of the tile.
static int	MIN_MAX_ALTERNATES Minimum number of route alternates.
static int	MIN_QUALITY Minimum quality of the tile.
static int	MIN_WIDTH Minimum width of the tile.

Constructor Summary

Constructors

Constructor and Description
CompositeTileMetadataOptions(GeoPoint center, BoundingBox boundingBox) Initializes a new instance of the CompositeTileManager.CompositeTileMetadataOptions class using a center point on a zoom level.
CompositeTileMetadataOptions(GeoPoint start, GeoPoint end) Initializes a new instance of the CompositeTileManager.CompositeTileMetadataOptions class using two points.

Method Summary

Methods

Modifier and Type	Method and Description
CompositeTileManager.CompositeTileMetadataOptions	setBoundingBox(BoundingBox value) Sets the bounding box describing requested area.
CompositeTileManager.CompositeTileMetadataOptions	setEnd(GeoPoint value) Sets the route ending location.
CompositeTileManager.CompositeTileMetadataOptions	setHeight(int value) Sets the height of the requested tile.
CompositeTileManager.CompositeTileMetadataOptions	setLocale(CompositeTileManager.MapLocale value) Sets the map locale.
CompositeTileManager.CompositeTileMetadataOptions	setMapStyle(String value) Sets the map style.
CompositeTileManager.CompositeTileMetadataOptions	setMaxAlternateRoutes(int value) Sets the maximum number of alternate routes displayed on the map.
CompositeTileManager.CompositeTileMetadataOptions	setQuality(int value) Sets the image quality for images in JPG format.
CompositeTileManager.CompositeTileMetadataOptions	setStart(GeoPoint value) Sets the route starting location.
CompositeTileManager.CompositeTileMetadataOptions	setWidth(int value) Sets the width of the requested tile.
String	toString()

Methods inherited from class java.lang.Object

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

Field Detail

DEFAULT_WIDTH

public static final int DEFAULT_WIDTH

Default width of the tile.

See Also:

Constant Field Values

MIN_WIDTH

public static final int MIN_WIDTH

Minimum width of the tile.

See Also:

Constant Field Values

MAX_WIDTH

public static final int MAX_WIDTH

Maximum width of the tile.

See Also:

Constant Field Values

DEFAULT_HEIGHT

public static final int DEFAULT_HEIGHT

Default height of the tile.

See Also:

Constant Field Values

MIN_HEIGHT

public static final int MIN_HEIGHT

Minimum height of the tile.

See Also:

Constant Field Values

MAX_HEIGHT

public static final int MAX_HEIGHT

Maximum height of the tile.

See Also:

Constant Field Values

DEFAULT_QUALITY

public static final int DEFAULT_QUALITY

Default quality of the tile.

See Also:

Constant Field Values

MIN_QUALITY

public static final int MIN_QUALITY

Minimum quality of the tile.

See Also:

Constant Field Values

MAX_QUALITY

public static final int MAX_QUALITY

Maximum quality of the tile.

See Also:

Constant Field Values

MIN_MAX_ALTERNATES

public static final int MIN_MAX_ALTERNATES

Minimum number of route alternates.

See Also:

Constant Field Values

MAX_MAX_ALTERNATES

public static final int MAX_MAX_ALTERNATES

Maximum number of route alternates.

See Also:

Constant Field Values

MAP_STYLE_DAY

public static final String MAP_STYLE_DAY

Day map style.

See Also:

Constant Field Values

MAP_STYLE_NIGHT

public static final String MAP_STYLE_NIGHT

Night map style.

See Also:

Constant Field Values

Constructor Detail

CompositeTileMetadataOptions

public CompositeTileMetadataOptions(GeoPoint start,
                            GeoPoint end)

Initializes a new instance of the CompositeTileManager.CompositeTileMetadataOptions class using two points.

Parameters:

start - The starting location of the route.

end - The ending location of the route.

CompositeTileMetadataOptions

public CompositeTileMetadataOptions(GeoPoint center,
                            BoundingBox boundingBox)

Initializes a new instance of the CompositeTileManager.CompositeTileMetadataOptions class using a center point on a zoom level.

Parameters:

center - Center location.

boundingBox - Bounding box representing requested area.

Method Detail

setStart

public CompositeTileManager.CompositeTileMetadataOptions setStart(GeoPoint value)

Sets the route starting location.

Parameters:

value - The route start location.

Returns:

This instance of the CompositeTileManager.CompositeTileMetadataOptions class.

Throws:

CompositeTileManager.CompositeTileManagerException - when the specified start location is invalid.

setEnd

public CompositeTileManager.CompositeTileMetadataOptions setEnd(GeoPoint value)

Sets the route ending location.

This parameter is optional, but the zoom level must be set if the end location is omitted or set to null.

Parameters:

value - The route ending location.

Returns:

This instance of the CompositeTileManager.CompositeTileMetadataOptions class.

Throws:

CompositeTileManager.CompositeTileManagerException - when the specified end location is invalid.

setBoundingBox

public CompositeTileManager.CompositeTileMetadataOptions setBoundingBox(BoundingBox value)

Sets the bounding box describing requested area.

Parameters:

value - The bounding box.

Returns:

This instance of the CompositeTileManager.CompositeTileMetadataOptions class.

Throws:

CompositeTileManager.CompositeTileManagerException - when the specified zoom level is invalid or out of range.

setWidth

public CompositeTileManager.CompositeTileMetadataOptions setWidth(int value)

Sets the width of the requested tile.

The default is 256. value must be between 64 and 1024.

Parameters:

value - The width in pixels.

Returns:

This instance of the CompositeTileManager.CompositeTileMetadataOptions class.

Throws:

CompositeTileManager.CompositeTileManagerException - when the specified width is invalid or out of range.

setHeight

public CompositeTileManager.CompositeTileMetadataOptions setHeight(int value)

Sets the height of the requested tile.

The default is 256. value must be between 64 and 1024.

Parameters:

value - The height in pixels.

Returns:

This instance of the CompositeTileManager.CompositeTileMetadataOptions class.

Throws:

CompositeTileManager.CompositeTileManagerException - when the specified height is invalid or out of range.

setQuality

public CompositeTileManager.CompositeTileMetadataOptions setQuality(int value)

Sets the image quality for images in JPG format.

Image quality for images in JPG format is in a range from 0 to 100. The default is 80. For images in PNG format, this value is ignored.

Parameters:

value - The image quality.

Returns:

This instance of the CompositeTileManager.CompositeTileMetadataOptions class.

Throws:

CompositeTileManager.CompositeTileManagerException - when the quality is invalid or out of range.

setMapStyle

public CompositeTileManager.CompositeTileMetadataOptions setMapStyle(String value)

Sets the map style.

Valid values are CompositeTileManager.CompositeTileMetadataOptions.MAP_STYLE_DAY or CompositeTileManager.CompositeTileMetadataOptions.MAP_STYLE_NIGHT, and the default is CompositeTileManager.CompositeTileMetadataOptions.MAP_STYLE_DAY.

Parameters:

value - The map style.

Returns:

This instance of the CompositeTileManager.CompositeTileMetadataOptions class.

Throws:

CompositeTileManager.CompositeTileManagerException - when the specified map style is invalid.

setLocale

public CompositeTileManager.CompositeTileMetadataOptions setLocale(CompositeTileManager.MapLocale value)

Sets the map locale.

The default value is CompositeTileManager.MapLocale.EN.

Parameters:

value - The map locale.

Returns:

This instance of the CompositeTileManager.CompositeTileMetadataOptions class.

Throws:

CompositeTileManager.CompositeTileManagerException - when the specified locale is invalid.

setMaxAlternateRoutes

public CompositeTileManager.CompositeTileMetadataOptions setMaxAlternateRoutes(int value)

Sets the maximum number of alternate routes displayed on the map.

The default value is 0. value should be between 0 and 1.

Parameters:

value - The maximum number of alternate routes to be displayed.

Returns:

This instance of the CompositeTileManager.CompositeTileMetadataOptions class.

Throws:

CompositeTileManager.CompositeTileManagerException - when the specified value is out of range.

toString

public String toString()

Overrides:

toString in class Object