com.luciad.model

LuciadLightspeedInterface ILcdTileProvider

All Known Implementing Classes:

ALcdTileProvider , TLcdDefaultTileProvider

Deprecated.

This API is only here to support deprecated formats.

@Deprecated
public interface ILcdTileProvider

Provider of tiles in a regular grid. Each tile can be queried through the ILcd2DBoundsInteractable interface.

Additional methods are provided to configure a tile provider, but these do not necessarily need to be supported by each tile provider.

Since:

V2.0

Method Summary

Modifier and Type	Method and Description
int	getNoOfCols() Deprecated. Returns the number of columns in this tile provider.
int	getNoOfRows() Deprecated. Returns the number of rows in this tile provider.
ILcd2DBoundsInteractable	getTile(int aRow, int aColumn) Deprecated. Returns the tile at the specified row and column.
void	loadProperties(String aPrefix, Properties aProperties) Deprecated. Initializes this tile provider with the specified properties.
void	setBasePath(String aBasePath) Deprecated. Sets the directory to be used as base path for the source files that contain the data of the tiles.
void	setTileDecoder(ILcdTileDecoder aTileDecoder) Deprecated. Sets the tile decoder to use for decoding the tiles from the source files.

Method Detail

getNoOfRows

int getNoOfRows()

Deprecated.

Returns the number of rows in this tile provider.

Returns:

the number of rows in this tile provider.

getNoOfCols

int getNoOfCols()

Deprecated.

Returns the number of columns in this tile provider.

Returns:

the number of columns in this tile provider.

getTile

ILcd2DBoundsInteractable getTile(int aRow,
                                 int aColumn)

Deprecated.

Returns the tile at the specified row and column. If no tile is available for the specified row and column, null is returned.

Parameters:

aRow - the row number of the tile to be returned.

aColumn - the column number of the tile to be returned.

Returns:

the tile at the specified row and column.

Throws:

IndexOutOfBoundsException - if aRow < 0 || aRow >= getNoOfRows() || aColumn < 0 || aColumn >= getNoOfCols()

loadProperties

void loadProperties(String aPrefix,
                    Properties aProperties)

Deprecated.

Initializes this tile provider with the specified properties. The exact contents of these properties are specified by the implementations of this interface.

Parameters:

aPrefix - a prefix that is used for the properties of this tile provider.

aProperties - the properties to initialize this tile provider with.

Throws:

NullPointerException - if aProperties == null.

setBasePath

void setBasePath(String aBasePath)

Deprecated.

Sets the directory to be used as base path for the source files that contain the data of the tiles. This base path is used to generate the full tile source names.

Parameters:

aBasePath - the directory that is the base path for the source files containing the data of the tiles.

setTileDecoder

void setTileDecoder(ILcdTileDecoder aTileDecoder)

Deprecated.

Sets the tile decoder to use for decoding the tiles from the source files.

Parameters:

aTileDecoder - the decoder to use for decoding an individual tile.