com.luciad.model

LuciadLightspeedClass ALcdTileProvider

java.lang.Object

com.luciad.model.ALcdTileProvider

All Implemented Interfaces:

ILcdTileProvider

Direct Known Subclasses:

TLcdDefaultTileProvider

Deprecated.

This API is only here to support deprecated formats.

@Deprecated
public abstract class ALcdTileProvider
extends Object
implements 
ILcdTileProvider

A skeleton implementation of ILcdTileProvider.

Extensions of this class should only implement the createTileSourceName(int, int) method to complete this tile provider.

A SoftReference is kept to tiles that are already decoded.

Since:

V2.0

Field Summary

Fields

Modifier and Type	Field and Description
static String	NO_OF_TILE_COLUMNS Deprecated. Name of the property holding the number of columns for this ALcdTileProvider.
static String	NO_OF_TILE_ROWS Deprecated. Name of the property holding the number of rows for this ALcdTileProvider.

Constructor Summary

Constructors

Constructor and Description
ALcdTileProvider() Deprecated.

Method Summary

Modifier and Type	Method and Description
protected abstract String	createTileSourceName(int aRow, int aColumn) Deprecated. Returns the full tile source name for the specified row and column, or null if no tile exists for the specified (row, column) combination.
String	getBasePath() Deprecated. Returns the directory to be used as base path for the source files that contain the data of the tiles.
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 aCol) Deprecated. Returns the tile at the specified row and column.
boolean	isTraceOn() Deprecated. This method has been deprecated. It is recommended to use the standard Java logging framework directly.
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.
void	setTraceOn(boolean aTraceOn) Deprecated. This method has been deprecated. It is recommended to use the standard Java logging framework directly.

Methods inherited from class java.lang.Object

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

Field Detail

NO_OF_TILE_ROWS

public static final String NO_OF_TILE_ROWS

Deprecated.

Name of the property holding the number of rows for this ALcdTileProvider.

See Also:

Constant Field Values

NO_OF_TILE_COLUMNS

public static final String NO_OF_TILE_COLUMNS

Deprecated.

Name of the property holding the number of columns for this ALcdTileProvider.

See Also:

Constant Field Values

Constructor Detail

ALcdTileProvider

public ALcdTileProvider()

Deprecated.

Method Detail

isTraceOn

public boolean isTraceOn()

Deprecated. This method has been deprecated. It is recommended to use the standard Java logging framework directly.

Returns true if tracing is enabled for this class.

Returns:

true if tracing is enabled for this class, false otherwise.

setTraceOn

public void setTraceOn(boolean aTraceOn)

Deprecated. This method has been deprecated. It is recommended to use the standard Java logging framework directly.

Enables tracing for this class instance. Calling this method with either true or false as argument automatically turns off tracing for all other class instances for which setTraceOn has not been called. If the argument is false then only the informative, warning and error log messages are recorded.

Parameters:

aTraceOn - if true then all log messages are recorded for this instance. If false, then only the informative, warning and error log messages are recorded.

setBasePath

public 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.

Specified by:

setBasePath in interface ILcdTileProvider

Parameters:

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

See Also:

getBasePath()

getBasePath

public String getBasePath()

Deprecated.

Returns the directory to be used as base path for the source files that contain the data of the tiles.

Returns:

the directory to be used as base path for the source files that contain the data of the tiles.

See Also:

setBasePath(java.lang.String)

setTileDecoder

public void setTileDecoder(ILcdTileDecoder aTileDecoder)

Deprecated.

Description copied from interface: ILcdTileProvider

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

Specified by:

setTileDecoder in interface ILcdTileProvider

Parameters:

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

getNoOfRows

public int getNoOfRows()

Deprecated.

Description copied from interface: ILcdTileProvider

Returns the number of rows in this tile provider.

Specified by:

getNoOfRows in interface ILcdTileProvider

Returns:

the number of rows in this tile provider.

getNoOfCols

public int getNoOfCols()

Deprecated.

Description copied from interface: ILcdTileProvider

Returns the number of columns in this tile provider.

Specified by:

getNoOfCols in interface ILcdTileProvider

Returns:

the number of columns in this tile provider.

getTile

public ILcd2DBoundsInteractable getTile(int aRow,
                                        int aCol)

Deprecated.

Description copied from interface: ILcdTileProvider

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

Specified by:

getTile in interface ILcdTileProvider

Parameters:

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

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

Returns:

the tile at the specified row and column.

loadProperties

public 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.

This abstract implementation only gets the properties that specify the number of rows and the number of columns. Overwrite this method to load properties that are specific to your ILcdTileProvider implementation. First call super.loadProperties to get the number of rows and columns.

Specified by:

loadProperties in interface ILcdTileProvider

Parameters:

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

aProperties - the properties to initialize this tile provider with.

createTileSourceName

protected abstract String createTileSourceName(int aRow,
                                               int aColumn)

Deprecated.

Returns the full tile source name for the specified row and column, or null if no tile exists for the specified (row, column) combination.

Parameters:

aRow - the row number of the tile.

aColumn - the column number of the tile.

Returns:

the full tile source name for the specified row and column, or null if no tile exists for the specified (row, column) combination..