com.luciad.earth.tileset.util

LuciadLightspeedClass ALcdEarthTileSetWrapper

java.lang.Object

com.luciad.earth.tileset.util.ALcdEarthTileSetWrapper

All Implemented Interfaces:

ILcdEarthTileSet, ILcdBounded, ILcdDisposable, AutoCloseable

Direct Known Subclasses:

ALcdEarthCoverageFilterTileSet, ALcdEarthTileSetMultilevelRaster, TLcdEarthAsynchronousTileSet, TLcdEarthLevelFallbackTileSet, TLcdEarthMemoryCachingTileSet, TLcdEarthMultiTileSet, TLcdEarthThreadSafeTileSet

public abstract class ALcdEarthTileSetWrapper
extends Object
implements ILcdEarthTileSet

Base class for wrappers around an ILcdEarthTileSet. This class implements all required methods, so that derived classes need only override the methods they are interested in and do not need to manually delegate all other methods to the wrapped tileset. Note that this class is abstract, as instantiating it directly would be pointless.

Care should be taken when overriding the produceTile(com.luciad.earth.tileset.ILcdEarthTileSetCoverage, int, long, long, com.luciad.reference.ILcdGeoReference, com.luciad.earth.tileset.TLcdEarthTileFormat, com.luciad.earth.tileset.TLcdEarthTileOperationMode, com.luciad.earth.tileset.ILcdEarthTileSetCallback, java.lang.Object) or updateTile(com.luciad.earth.tileset.ALcdEarthTile, com.luciad.earth.tileset.TLcdEarthTileOperationMode, com.luciad.earth.tileset.ILcdEarthTileSetCallback, java.lang.Object) method. These methods have 2 versions (a regular one and a callback based one) which should both be overridden in most cases to provide a consistent view on the tile set.

Since:

8.2

Constructor Summary

Constructors

Constructor and Description
ALcdEarthTileSetWrapper(ILcdEarthTileSet aDelegate) Creates a new wrapper around the specified tileset.

Method Summary

Modifier and Type	Method and Description
void	cancelTile(int aLevel, long aTileX, long aTileY, ILcdEarthTileSetCoverage aCoverage, ILcdGeoReference aGeoReference, TLcdEarthTileFormat aFormat, ILcdEarthTileSetCallback aCallback, Object aContext) This method should be overridden if the produceTile and/or updateTile is overridden and the new implementation calls the implementation of this class using different parameters than passed to it.
boolean	containsTile(ILcdEarthTileSetCoverage aCoverage, int aLevel, long aX, long aY, Object aContext) Returns true if the repository contains the specified tile.
boolean	containsTileSetCoverage(String aCoverageName) Returns true if the repository contains a coverage with the specified name.
void	dispose() This method releases all resources held by the repository, such as file locks, threads or server connections.
ILcdBounds	getBounds() Returns the bounds of this tile set, expressed in the model reference of the model that contains this tile set.
ILcdEarthTileSet	getDelegateTileSet() Returns the wrapped tileset.
int	getLevelCount() Returns the number of available detail levels.
long	getTileColumnCount(int aLevel) Returns the number of columns in the tile grid at the given level.
long	getTileRowCount(int aLevel) Returns the number of rows in the tile grid at the given level.
ILcdEarthTileSetCoverage	getTileSetCoverage(int aIndex) Returns the coverage at the specified index.
ILcdEarthTileSetCoverage	getTileSetCoverage(String aCoverageName) Returns the tileset coverage with the specified name.
int	getTileSetCoverageCount() Returns the number of coverages this tileset contains.
boolean	isFormatSupported(ILcdEarthTileSetCoverage aCoverage, TLcdEarthTileFormat aFormat) Returns true if the tileset can produce tiles for the given coverage in the given format.
boolean	isGeoReferenceSupported(ILcdEarthTileSetCoverage aCoverage, ILcdGeoReference aGeoReference) Returns true if the tileset can produce tiles for the given coverage in the given reference system.
ALcdEarthTile	produceTile(ILcdEarthTileSetCoverage aCoverage, int aLevel, long aX, long aY, ILcdGeoReference aGeoReference, TLcdEarthTileFormat aFormat, Object aContext) Gets a tile from the repository.
void	produceTile(ILcdEarthTileSetCoverage aCoverage, int aLevel, long aTileX, long aTileY, ILcdGeoReference aGeoReference, TLcdEarthTileFormat aFormat, TLcdEarthTileOperationMode aMode, ILcdEarthTileSetCallback aCallback, Object aContext) Produces the requested tile, and invoke the supplied callback when done.
ALcdEarthTile	updateTile(ALcdEarthTile aEarthTile, Object aContext) Returns an updated version of the specified tile.
void	updateTile(ALcdEarthTile aTile, TLcdEarthTileOperationMode aMode, ILcdEarthTileSetCallback aCallback, Object aContext) Produces an updated version of the given tile, if necessary.

Methods inherited from class java.lang.Object

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

Methods inherited from interface com.luciad.util.ILcdDisposable

close

Constructor Detail

ALcdEarthTileSetWrapper

public ALcdEarthTileSetWrapper(ILcdEarthTileSet aDelegate)

Creates a new wrapper around the specified tileset.

Parameters:

aDelegate - the wrapped tileset

Method Detail

getDelegateTileSet

public ILcdEarthTileSet getDelegateTileSet()

Returns the wrapped tileset.

Returns:

the wrapped tileset

produceTile

public void produceTile(ILcdEarthTileSetCoverage aCoverage,
                        int aLevel,
                        long aTileX,
                        long aTileY,
                        ILcdGeoReference aGeoReference,
                        TLcdEarthTileFormat aFormat,
                        TLcdEarthTileOperationMode aMode,
                        ILcdEarthTileSetCallback aCallback,
                        Object aContext)

Description copied from interface: ILcdEarthTileSet

Produces the requested tile, and invoke the supplied callback when done. The resulting tile is passed to the call back's tileAvailable() method. If the tile cannot be produced for some reason, the method tileNotAvailable() should be called instead.

If the tileset supports it and aMode is TLcdEarthTileOperationMode.PREFER_ASYNCHRONOUS, the tile request may be executed asynchronously. However, the callback must be invoked at some point in time, unless the cancelTile() method is used to cancel the tile request before it is executed. If aMode is TLcdEarthTileOperationMode.FORCE_SYNCHRONOUS, the request must be executed synchronously and the callback must be invoked before produceTile() returns.

Tiles may be requested in reference systems other than the native geo reference of the underlying data, provided that the isGeoReferenceSupported() method returns true for the requested reference. If this is not the case, the tileset should call tileNotAvailable(). If the tileset calls tileAvailable(), the geo reference of the resulting tile must be equal to aGeoReference, and the tile's bounds must likewise be expressed in this reference.

Similarly, tiles may be requested in different data formats, as described by TLcdEarthTileFormat. The format determines the type of the data object that will be contained in the requested tile. To check if a format is supported, use isFormatSupported(). If the specified format is not supported, the tileset should call tileNotAvailable().

The context parameter may be used to pass application-specific data into the tileset. If it is not needed, its value may be null.

Specified by:

produceTile in interface ILcdEarthTileSet

Parameters:

aCoverage - the coverage from which the tile is requested

aLevel - the level from which the tile is requested

aTileX - the column index of the requested tile

aTileY - the row index of the requested tile

aGeoReference - the reference system in which the tile should be returned

aFormat - the desired format of the tile's data

aMode - controls the synchronous or asynchronous behaviour of the tileset

aCallback - will be invoked when the tile is available to be used

aContext - application-specific data to be used by the tileset, if any

dispose

public void dispose()

Description copied from interface: ILcdEarthTileSet

This method releases all resources held by the repository, such as file locks, threads or server connections.

Specified by:

dispose in interface ILcdEarthTileSet

Specified by:

dispose in interface ILcdDisposable

getBounds

public ILcdBounds getBounds()

Description copied from interface: ILcdEarthTileSet

Returns the bounds of this tile set, expressed in the model reference of the model that contains this tile set.

Specified by:

getBounds in interface ILcdEarthTileSet

Specified by:

getBounds in interface ILcdBounded

Returns:

the bounds of this tile set

See Also:

ILcdBounded.getBounds()

getLevelCount

public int getLevelCount()

Description copied from interface: ILcdEarthTileSet

Returns the number of available detail levels. Level 0 is the coarsest level.

Specified by:

getLevelCount in interface ILcdEarthTileSet

Returns:

the number of available detail levels

getTileRowCount

public long getTileRowCount(int aLevel)

Description copied from interface: ILcdEarthTileSet

Returns the number of rows in the tile grid at the given level. Each level should have twice the number of rows of the previous one.

Specified by:

getTileRowCount in interface ILcdEarthTileSet

Parameters:

aLevel - the level to be queried

Returns:

the number of tile rows on the specified level

getTileColumnCount

public long getTileColumnCount(int aLevel)

Description copied from interface: ILcdEarthTileSet

Returns the number of columns in the tile grid at the given level. Each level should have twice the number of columns of the previous one.

Specified by:

getTileColumnCount in interface ILcdEarthTileSet

Parameters:

aLevel - the level to be queried

Returns:

the number of tile columns on the specified level

getTileSetCoverageCount

public int getTileSetCoverageCount()

Description copied from interface: ILcdEarthTileSet

Returns the number of coverages this tileset contains.

Specified by:

getTileSetCoverageCount in interface ILcdEarthTileSet

Returns:

the number of coverages this tileset contains

getTileSetCoverage

public ILcdEarthTileSetCoverage getTileSetCoverage(int aIndex)

Description copied from interface: ILcdEarthTileSet

Returns the coverage at the specified index.

Specified by:

getTileSetCoverage in interface ILcdEarthTileSet

Parameters:

aIndex - the index of the coverage to return

Returns:

the requested ILcdEarthTileSetCoverage

containsTileSetCoverage

public boolean containsTileSetCoverage(String aCoverageName)

Description copied from interface: ILcdEarthTileSet

Returns true if the repository contains a coverage with the specified name.

Specified by:

containsTileSetCoverage in interface ILcdEarthTileSet

Parameters:

aCoverageName - the name of the coverage to look for

Returns:

true if the repository contains a coverage with the specified name, false otherwise

getTileSetCoverage

public ILcdEarthTileSetCoverage getTileSetCoverage(String aCoverageName)

Description copied from interface: ILcdEarthTileSet

Returns the tileset coverage with the specified name.

Specified by:

getTileSetCoverage in interface ILcdEarthTileSet

Parameters:

aCoverageName - the name of the coverage to look for

Returns:

the tileset coverage with the specified name

updateTile

public void updateTile(ALcdEarthTile aTile,
                       TLcdEarthTileOperationMode aMode,
                       ILcdEarthTileSetCallback aCallback,
                       Object aContext)

Description copied from interface: ILcdEarthTileSet

Produces an updated version of the given tile, if necessary. Produces the same tile if the given tile is up to date.

Specified by:

updateTile in interface ILcdEarthTileSet

Parameters:

aTile - tile to check

aMode - controls the synchronous or asynchronous behaviour of the tileset

aCallback - will be invoked when the tile is available to be used

aContext - application-specific data to be used by the tileset, if any

cancelTile

public void cancelTile(int aLevel,
                       long aTileX,
                       long aTileY,
                       ILcdEarthTileSetCoverage aCoverage,
                       ILcdGeoReference aGeoReference,
                       TLcdEarthTileFormat aFormat,
                       ILcdEarthTileSetCallback aCallback,
                       Object aContext)

This method should be overridden if the produceTile and/or updateTile is overridden and the new implementation calls the implementation of this class using different parameters than passed to it.

If the produceTile is overridden as

 super.produceTile( myCoverage, aLevel, aTileX, aTileY, aGeoReference, aFormat, aMode, new MyTileSetCallback( aCallback ), aContext );
 

this method should be overridden as

 super.cancelTile( aLevel, aTileX, aTileY, myCoverage, aGeoReference, aFormat, new MyTileSetCallback( aCallback ), aContext );
 

where MyTileSetCallback instances with the same delegate callback are equal.

Specified by:

cancelTile in interface ILcdEarthTileSet

Parameters:

aLevel - the level from which the tile is requested

aTileX - the column index of the requested tile

aTileY - the row index of the requested tile

aCoverage - the coverage from which the tile is requested

aGeoReference - the reference system in which the tile is requested

aFormat - the format in which the tile is requested

aCallback - would be invoked when the tile would have been available to be used

aContext - application-specific data to be used by the tileset, if any

produceTile

public ALcdEarthTile produceTile(ILcdEarthTileSetCoverage aCoverage,
                                 int aLevel,
                                 long aX,
                                 long aY,
                                 ILcdGeoReference aGeoReference,
                                 TLcdEarthTileFormat aFormat,
                                 Object aContext)
                          throws IOException

Description copied from interface: ILcdEarthTileSet

Gets a tile from the repository.

Specified by:

produceTile in interface ILcdEarthTileSet

Parameters:

aCoverage - the coverage from which to query a tile

aLevel - the detail level for which to query a tile

aX - the column index at which to query a tile

aY - the row index at which to query a tile

aGeoReference - the georeference of the requested tile

aFormat - the format of the requested tile

aContext - application-specific data to be used by the tileset, if any

Returns:

the requested tile, or null if the repository does not contain this tile

Throws:

IOException - if the tile cannot be produced

isGeoReferenceSupported

public boolean isGeoReferenceSupported(ILcdEarthTileSetCoverage aCoverage,
                                       ILcdGeoReference aGeoReference)

Description copied from interface: ILcdEarthTileSet

Returns true if the tileset can produce tiles for the given coverage in the given reference system. Note that any reference other than the native reference may result in reduced performance.

This method must always return true for the native reference of the coverage. If it returns true for any other georeference, then the tileset must be able to handle the georeference in question in its produceTile() method.

Specified by:

isGeoReferenceSupported in interface ILcdEarthTileSet

Parameters:

aCoverage - the coverage to check for

aGeoReference - the reference to check for

Returns:

true if the given coverage can be queried with the given reference

isFormatSupported

public boolean isFormatSupported(ILcdEarthTileSetCoverage aCoverage,
                                 TLcdEarthTileFormat aFormat)

Description copied from interface: ILcdEarthTileSet

Returns true if the tileset can produce tiles for the given coverage in the given format. Note that any format other than the native format may result in reduced performance.

This method must always return true for the native format of the coverage. If it returns true for any other format, then the tileset must be able to handle the format in question in its produceTile() method.

Specified by:

isFormatSupported in interface ILcdEarthTileSet

Parameters:

aCoverage - the coverage to check for

aFormat - the format to check for

Returns:

true if the given coverage can be queried with the given format

containsTile

public boolean containsTile(ILcdEarthTileSetCoverage aCoverage,
                            int aLevel,
                            long aX,
                            long aY,
                            Object aContext)

Description copied from interface: ILcdEarthTileSet

Returns true if the repository contains the specified tile.

Specified by:

containsTile in interface ILcdEarthTileSet

Parameters:

aCoverage - the coverage from which to query a tile

aLevel - the detail level for which to query a tile

aX - the column index at which to query a tile

aY - the row index at which to query a tile

aContext - application-specific data to be used by the tileset, if any

Returns:

true if the repository contains the requested tile

updateTile

public ALcdEarthTile updateTile(ALcdEarthTile aEarthTile,
                                Object aContext)
                         throws IOException

Description copied from interface: ILcdEarthTileSet

Returns an updated version of the specified tile.

Specified by:

updateTile in interface ILcdEarthTileSet

Parameters:

aEarthTile - the tile to check

aContext - application-specific data to be used by the tileset, if any

Returns:

the tile itself or a new, updated version

Throws:

IOException - if the tile cannot be updated