Package com.esri.arcgisruntime.raster

Class MosaicDatasetRaster

java.lang.Object

com.esri.arcgisruntime.raster.Raster

com.esri.arcgisruntime.raster.MosaicDatasetRaster

All Implemented Interfaces:

Loadable

public final class MosaicDatasetRaster
extends Raster

Represents a geodatabase model designed for managing collection of images.

This format provides many benefits such as dynamic mosaicking, managing large image collections, etc.

Since:

100.0.0

Constructor Summary

Constructors

Constructor	Description
MosaicDatasetRaster(String databasePath, String rasterName)	Creates a mosaic dataset raster from a mosaic dataset in an existing SQLite database.

Method Summary

Modifier and Type	Method	Description
ListenableFuture<Void>	addRastersAsync(AddRastersParameters parameters)	Asynchronously adds raster data to this mosaic dataset raster.
static MosaicDatasetRaster	create(Geodatabase geodatabase, String rasterName, SpatialReference spatialReference)	Creates a new mosaic dataset raster with the specified raster name hosted in the specified geodatabase.
static MosaicDatasetRaster	create(String databasePath, String rasterName, SpatialReference spatialReference)	Creates a new mosaic dataset raster with the specified raster name hosted in a new SQLite database which will be located at the specified database path.
static List<String>	getNames(String databasePath)	Gets names of all rasters in the database.
static void	remove(Geodatabase geodatabase, String rasterName)	Deletes a mosaic dataset raster from the specified geodatabase.

Methods inherited from class com.esri.arcgisruntime.raster.Raster

addDoneLoadingListener, addLoadStatusChangedListener, cancelLoad, getLoadError, getLoadStatus, getPath, getRasterFunction, loadAsync, removeDoneLoadingListener, removeLoadStatusChangedListener, retryLoadAsync

Methods inherited from class java.lang.Object

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

Constructor Detail

MosaicDatasetRaster

public MosaicDatasetRaster(String databasePath,
                           String rasterName)

Creates a mosaic dataset raster from a mosaic dataset in an existing SQLite database.

Parameters:

databasePath - path of the SQLite file that contains the mosaic dataset, can be a local path or network path

rasterName - name of the mosaic dataset raster in the database

Throws:

IllegalArgumentException - if databasePath is null or empty

IllegalArgumentException - if rasterName is null or empty

Since:

100.0.0

Method Detail

create

public static MosaicDatasetRaster create(String databasePath,
                                         String rasterName,
                                         SpatialReference spatialReference)

Creates a new mosaic dataset raster with the specified raster name hosted in a new SQLite database which will be located at the specified database path. The SQLite database is created when the MosaicDatasetRaster is loaded.

Parameters:

databasePath - absolute path of the SQLite file to be created that will contain the mosaic dataset raster. The path needs to contain the database filename with the file extension ".sqlite". The folder that is going to contain the file must exist on the file system.

rasterName - name of the mosaic dataset raster to be created

spatialReference - the spatial reference of the mosaic dataset raster to be created

Returns:

the new mosaic dataset raster

Throws:

IllegalArgumentException - if databasePath is null or empty

IllegalArgumentException - if rasterName is null or empty

IllegalArgumentException - if spatialReference is null

Since:

100.2.0

create

public static MosaicDatasetRaster create(Geodatabase geodatabase,
                                         String rasterName,
                                         SpatialReference spatialReference)

Creates a new mosaic dataset raster with the specified raster name hosted in the specified geodatabase.

Parameters:

geodatabase - the geodatabase that will contain the new mosaic dataset raster

rasterName - name of the mosaic dataset raster to be created

spatialReference - the spatial reference of the mosaic dataset raster to be created

Returns:

the new mosaic dataset raster

Throws:

IllegalArgumentException - if geodatabase is null

IllegalArgumentException - if rasterName is null or empty

IllegalArgumentException - if spatialReference is null

Since:

100.2.0

addRastersAsync

public ListenableFuture<Void> addRastersAsync(AddRastersParameters parameters)

Asynchronously adds raster data to this mosaic dataset raster.

Parameters:

parameters - the parameters that specify the raster data to be added

Returns:

a ListenableFuture for tracking when the asynchronous operation is done and getting the result

Throws:

IllegalArgumentException - if parameters is null

Since:

100.2.0

remove

public static void remove(Geodatabase geodatabase,
                          String rasterName)

Deletes a mosaic dataset raster from the specified geodatabase.

Parameters:

geodatabase - the geodatabase that contains the mosaic dataset raster to be deleted

rasterName - the name of the mosaic dataset raster to be deleted

Throws:

IllegalArgumentException - if geodatabase is null

IllegalArgumentException - if rasterName is null or empty

Since:

100.2.0

getNames

public static List<String> getNames(String databasePath)

Gets names of all rasters in the database.

Parameters:

databasePath - absolute file path to the raster file on device

Returns:

an unmodifiable list of names of all rasters in the database.

Throws:

IllegalArgumentException - if databasePath is null or empty

Since:

100.0.0