com.esri.arcgis.carto
Interface IDynamicCacheLayerManager

All Superinterfaces:

java.io.Serializable

All Known Subinterfaces:

IDynamicCacheLayerManager2

All Known Implementing Classes:

DynamicCacheLayerManager, IDynamicCacheLayerManager2Proxy, IDynamicCacheLayerManagerProxy

public interface IDynamicCacheLayerManager
extends java.io.Serializable

COM Interface 'IDynamicCacheLayerManager'. Generated 3/19/2015 1:20:54 PM from 'C:\ArcGIS\COM\esriCarto.olb'

Description: 'Provides access to dynamic layers cache management.' Generator Options: PromptForTypeLibraries = False ClashPrefix = esri_ LowerCaseMemberNames = True IDispatchOnly = False RetryOnReject = False AwtForOcxs = True ArraysAsObjects = False DontRenameSameMethods = False ImplementConflictingInterfaces = True ReuseMethods = True RenameConflictingInterfaceMethods = True GenBeanInfo = True GenerateJavadoc =

Field Summary

static java.lang.String	IID Deprecated. Internal use only
static int	IIDeda39ce4_100f_4817_9d38_0c62db03b2b1
static int	xxDummy Deprecated. Internal use only

Method Summary

void	connect(java.lang.String newFolderPath, java.lang.String newFolderName) Try to connect the given layer to a cache.
void	delete() Delete the cache structure and tiles from the disk.
double	getDetailsThreshold() The threshold to determine the level of detail to use.
java.lang.String	getFolderName() If cache exists, returns the layername plus guid.
java.lang.String	getFolderPath() The full path of the cache parent directory if the the cache exists.
java.lang.String	getFormat() The name of the tile format which is used by the cache.
double	getMaxCacheScale() The maximum scale by which tiles are to be generated.
int	getProgressiveDrawingLevels() Number of coarse level data to draw while the current LOD tiles are being processed.
int	getProgressiveFetchingLevels() Number of coarse level data to fetch while the current LOD tiles are being processed.
void	init(IMap map, ILayer layer) Initialize the cache manager with the given map and layer.
void	invalidate(IEnvelope extent, boolean doubleBuffer) Invalidate a certain area of the cache, according to the given extent.
boolean	isAlwaysDrawCoarsestLevel() Indicates whether to use the default coarse texture while the requested tile is being processed.
boolean	isCacheable() Indicates whether the layer can have a dynamic cache.
boolean	isConsolidatedGroupLayer() Indicates whether the given composite layer cache is consolidated.
boolean	isStrictOnDemandMode() Indicates whether to use a coarse grained drawing in case where there is nothing else to render while waiting for the current map scale data to be cooked.
void	setAlwaysDrawCoarsestLevel(boolean alwaysDrawCoarsestLevel) Indicates whether to use the default coarse texture while the requested tile is being processed.
void	setConsolidatedGroupLayer(boolean consolidated) Indicates whether the given composite layer cache is consolidated.
void	setDetailsThreshold(double threshold) The threshold to determine the level of detail to use.
void	setFolderPath(java.lang.String folderPath) The full path of the cache parent directory if the the cache exists.
void	setFormat(java.lang.String format) The name of the tile format which is used by the cache.
void	setMaxCacheScale(double maxScale) The maximum scale by which tiles are to be generated.
void	setProgressiveDrawingLevels(int numOfProgressiveLevels) Number of coarse level data to draw while the current LOD tiles are being processed.
void	setProgressiveFetchingLevels(int numOfProgressiveLevels) Number of coarse level data to fetch while the current LOD tiles are being processed.
void	setStrictOnDemandMode(boolean strictOnDemandMode) Indicates whether to use a coarse grained drawing in case where there is nothing else to render while waiting for the current map scale data to be cooked.
void	update(IEnvelope extent, double fromMapScale, double targetMapScale, int updateMode) Update the cache associated with the layer according to the given extent, between the from-scale to the target-scale and according to the update-mode.

Field Detail

IIDeda39ce4_100f_4817_9d38_0c62db03b2b1

static final int IIDeda39ce4_100f_4817_9d38_0c62db03b2b1

See Also:

Constant Field Values

xxDummy

static final int xxDummy

Deprecated. Internal use only

See Also:

Constant Field Values

IID

static final java.lang.String IID

Deprecated. Internal use only

See Also:

Constant Field Values

Method Detail

init

void init(IMap map,
          ILayer layer)
          throws java.io.IOException,
                 AutomationException

Initialize the cache manager with the given map and layer.

Parameters:

map - A reference to a com.esri.arcgis.carto.IMap (in)

layer - A reference to a com.esri.arcgis.carto.ILayer (in)

Throws:

java.io.IOException - If there are interop problems.

AutomationException - If the ArcObject component throws an exception.

getFolderName

java.lang.String getFolderName()
                               throws java.io.IOException,
                                      AutomationException

If cache exists, returns the layername plus guid. If cache does not exists, returns nothing.

Returns:

The cacheFolderName

Throws:

java.io.IOException - If there are interop problems.

AutomationException - If the ArcObject component throws an exception.

getFolderPath

java.lang.String getFolderPath()
                               throws java.io.IOException,
                                      AutomationException

The full path of the cache parent directory if the the cache exists.

Returns:

The folderPath

Throws:

java.io.IOException - If there are interop problems.

AutomationException - If the ArcObject component throws an exception.

setFolderPath

void setFolderPath(java.lang.String folderPath)
                   throws java.io.IOException,
                          AutomationException

The full path of the cache parent directory if the the cache exists.

Parameters:

folderPath - The folderPath (in)

Throws:

java.io.IOException - If there are interop problems.

AutomationException - If the ArcObject component throws an exception.

isCacheable

boolean isCacheable()
                    throws java.io.IOException,
                           AutomationException

Indicates whether the layer can have a dynamic cache.

Returns:

The cacheable

Throws:

java.io.IOException - If there are interop problems.

AutomationException - If the ArcObject component throws an exception.

delete

void delete()
            throws java.io.IOException,
                   AutomationException

Delete the cache structure and tiles from the disk.

Throws:

java.io.IOException - If there are interop problems.

AutomationException - If the ArcObject component throws an exception.

invalidate

void invalidate(IEnvelope extent,
                boolean doubleBuffer)
                throws java.io.IOException,
                       AutomationException

Invalidate a certain area of the cache, according to the given extent. If the input extent is null, invalidates the entire cache. Duoble-buffer does not show changes until new tiles are available.

Parameters:

extent - A reference to a com.esri.arcgis.geometry.IEnvelope (in)

doubleBuffer - The doubleBuffer (in)

Throws:

java.io.IOException - If there are interop problems.

AutomationException - If the ArcObject component throws an exception.

getFormat

java.lang.String getFormat()
                           throws java.io.IOException,
                                  AutomationException

The name of the tile format which is used by the cache.

Returns:

The format

Throws:

java.io.IOException - If there are interop problems.

AutomationException - If the ArcObject component throws an exception.

setFormat

void setFormat(java.lang.String format)
               throws java.io.IOException,
                      AutomationException

The name of the tile format which is used by the cache.

Parameters:

format - The format (in)

Throws:

java.io.IOException - If there are interop problems.

AutomationException - If the ArcObject component throws an exception.

connect

void connect(java.lang.String newFolderPath,
             java.lang.String newFolderName)
             throws java.io.IOException,
                    AutomationException

Try to connect the given layer to a cache.

Parameters:

newFolderPath - The newFolderPath (in)

newFolderName - The newFolderName (in)

Throws:

java.io.IOException - If there are interop problems.

AutomationException - If the ArcObject component throws an exception.

update

void update(IEnvelope extent,
            double fromMapScale,
            double targetMapScale,
            int updateMode)
            throws java.io.IOException,
                   AutomationException

Update the cache associated with the layer according to the given extent, between the from-scale to the target-scale and according to the update-mode.

Parameters:

extent - A reference to a com.esri.arcgis.geometry.IEnvelope (in)

fromMapScale - The fromMapScale (in)

targetMapScale - The targetMapScale (in)

updateMode - A com.esri.arcgis.carto.esriMapCacheUpdateMode constant (in)

Throws:

java.io.IOException - If there are interop problems.

AutomationException - If the ArcObject component throws an exception.

isConsolidatedGroupLayer

boolean isConsolidatedGroupLayer()
                                 throws java.io.IOException,
                                        AutomationException

Indicates whether the given composite layer cache is consolidated.

Returns:

The consolidated

Throws:

java.io.IOException - If there are interop problems.

AutomationException - If the ArcObject component throws an exception.

setConsolidatedGroupLayer

void setConsolidatedGroupLayer(boolean consolidated)
                               throws java.io.IOException,
                                      AutomationException

Indicates whether the given composite layer cache is consolidated.

Parameters:

consolidated - The consolidated (in)

Throws:

java.io.IOException - If there are interop problems.

AutomationException - If the ArcObject component throws an exception.

isStrictOnDemandMode

boolean isStrictOnDemandMode()
                             throws java.io.IOException,
                                    AutomationException

Indicates whether to use a coarse grained drawing in case where there is nothing else to render while waiting for the current map scale data to be cooked.

Returns:

The strictOnDemandMode

Throws:

java.io.IOException - If there are interop problems.

AutomationException - If the ArcObject component throws an exception.

setStrictOnDemandMode

void setStrictOnDemandMode(boolean strictOnDemandMode)
                           throws java.io.IOException,
                                  AutomationException

Indicates whether to use a coarse grained drawing in case where there is nothing else to render while waiting for the current map scale data to be cooked.

Parameters:

strictOnDemandMode - The strictOnDemandMode (in)

Throws:

java.io.IOException - If there are interop problems.

AutomationException - If the ArcObject component throws an exception.

getMaxCacheScale

double getMaxCacheScale()
                        throws java.io.IOException,
                               AutomationException

The maximum scale by which tiles are to be generated.

Returns:

The maxScale

Throws:

java.io.IOException - If there are interop problems.

AutomationException - If the ArcObject component throws an exception.

setMaxCacheScale

void setMaxCacheScale(double maxScale)
                      throws java.io.IOException,
                             AutomationException

The maximum scale by which tiles are to be generated.

Parameters:

maxScale - The maxScale (in)

Throws:

java.io.IOException - If there are interop problems.

AutomationException - If the ArcObject component throws an exception.

getDetailsThreshold

double getDetailsThreshold()
                           throws java.io.IOException,
                                  AutomationException

The threshold to determine the level of detail to use. Values range from 0 to 100, where 100 means always choose coarse data.

Returns:

The threshold

Throws:

java.io.IOException - If there are interop problems.

AutomationException - If the ArcObject component throws an exception.

setDetailsThreshold

void setDetailsThreshold(double threshold)
                         throws java.io.IOException,
                                AutomationException

The threshold to determine the level of detail to use. Values range from 0 to 100, where 100 means always choose coarse data.

Parameters:

threshold - The threshold (in)

Throws:

java.io.IOException - If there are interop problems.

AutomationException - If the ArcObject component throws an exception.

getProgressiveDrawingLevels

int getProgressiveDrawingLevels()
                                throws java.io.IOException,
                                       AutomationException

Number of coarse level data to draw while the current LOD tiles are being processed.

Returns:

The numOfProgressiveLevels

Throws:

java.io.IOException - If there are interop problems.

AutomationException - If the ArcObject component throws an exception.

setProgressiveDrawingLevels

void setProgressiveDrawingLevels(int numOfProgressiveLevels)
                                 throws java.io.IOException,
                                        AutomationException

Number of coarse level data to draw while the current LOD tiles are being processed.

Parameters:

numOfProgressiveLevels - The numOfProgressiveLevels (in)

Throws:

java.io.IOException - If there are interop problems.

AutomationException - If the ArcObject component throws an exception.

getProgressiveFetchingLevels

int getProgressiveFetchingLevels()
                                 throws java.io.IOException,
                                        AutomationException

Number of coarse level data to fetch while the current LOD tiles are being processed.

Returns:

The numOfProgressiveLevels

Throws:

java.io.IOException - If there are interop problems.

AutomationException - If the ArcObject component throws an exception.

setProgressiveFetchingLevels

void setProgressiveFetchingLevels(int numOfProgressiveLevels)
                                  throws java.io.IOException,
                                         AutomationException

Number of coarse level data to fetch while the current LOD tiles are being processed.

Parameters:

numOfProgressiveLevels - The numOfProgressiveLevels (in)

Throws:

java.io.IOException - If there are interop problems.

AutomationException - If the ArcObject component throws an exception.

isAlwaysDrawCoarsestLevel

boolean isAlwaysDrawCoarsestLevel()
                                  throws java.io.IOException,
                                         AutomationException

Indicates whether to use the default coarse texture while the requested tile is being processed.

Returns:

The alwaysDrawCoarsestLevel

Throws:

java.io.IOException - If there are interop problems.

AutomationException - If the ArcObject component throws an exception.

setAlwaysDrawCoarsestLevel

void setAlwaysDrawCoarsestLevel(boolean alwaysDrawCoarsestLevel)
                                throws java.io.IOException,
                                       AutomationException

Indicates whether to use the default coarse texture while the requested tile is being processed.

Parameters:

alwaysDrawCoarsestLevel - The alwaysDrawCoarsestLevel (in)

Throws:

java.io.IOException - If there are interop problems.

AutomationException - If the ArcObject component throws an exception.