com.esri.arcgis.carto
Class DynamicCacheLayerManager

java.lang.Object
  com.esri.arcgis.carto.DynamicCacheLayerManager

All Implemented Interfaces:

IDynamicCacheLayerManager, IDynamicCacheLayerManager2, com.esri.arcgis.interop.RemoteObjRef, java.io.Serializable

public class DynamicCacheLayerManager
extends java.lang.Object
implements com.esri.arcgis.interop.RemoteObjRef, IDynamicCacheLayerManager, IDynamicCacheLayerManager2

COM Class 'DynamicCacheLayerManager'. Generated 3/19/2015 1:20:42 PM from 'C:\ArcGIS\COM\esriCarto.olb'

Description 'Dynamic cache layer management utility class.' 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 =

See Also:

Serialized Form

Field Summary

Fields inherited from interface com.esri.arcgis.carto.IDynamicCacheLayerManager2

IID, IIDe5aec75c_5866_4d71_bcce_9d331e679027, xxDummy

Fields inherited from interface com.esri.arcgis.carto.IDynamicCacheLayerManager

IIDeda39ce4_100f_4817_9d38_0c62db03b2b1

Constructor Summary

DynamicCacheLayerManager()
Constructs a DynamicCacheLayerManager using ArcGIS Engine.

DynamicCacheLayerManager(java.lang.Object obj)
Deprecated. As of ArcGIS 9.2, replaced by normal Java casts.
DynamicCacheLayerManager theDynamicCacheLayerManager = (DynamicCacheLayerManager) obj;

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.
boolean	equals(java.lang.Object o) Compare this object with another
static java.lang.String	getClsid() getClsid.
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.
com.esri.arcgis.interop.Dispatch	getJintegraDispatch() Deprecated. Internal use only.
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.
int	hashCode() the hashcode for this object
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	isCached() Indicates whether the layer is drawing while in cached mode.
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	release() Release a DynamicCacheLayerManager.
void	setAlwaysDrawCoarsestLevel(boolean alwaysDrawCoarsestLevel) Indicates whether to use the default coarse texture while the requested tile is being processed.
void	setCached(boolean cached) Indicates whether the layer is drawing while in cached mode.
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.

Methods inherited from class java.lang.Object

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

Constructor Detail

DynamicCacheLayerManager

public DynamicCacheLayerManager()
                         throws java.io.IOException,
                                java.net.UnknownHostException

Constructs a DynamicCacheLayerManager using ArcGIS Engine.

Throws:

java.io.IOException - if there are interop problems

java.net.UnknownHostException - if there are interop problems

DynamicCacheLayerManager

public DynamicCacheLayerManager(java.lang.Object obj)
                         throws java.io.IOException

Deprecated. As of ArcGIS 9.2, replaced by normal Java casts.
DynamicCacheLayerManager theDynamicCacheLayerManager = (DynamicCacheLayerManager) obj;

Construct a DynamicCacheLayerManager using a reference to such an object returned from ArcGIS Engine or Server. This is semantically equivalent to casting obj to DynamicCacheLayerManager.

Parameters:

obj - an object returned from ArcGIS Engine or Server

Throws:

java.io.IOException - if there are interop problems

Method Detail

getClsid

public static java.lang.String getClsid()

getClsid.

equals

public boolean equals(java.lang.Object o)

Compare this object with another

Overrides:

equals in class java.lang.Object

hashCode

public int hashCode()

the hashcode for this object

Overrides:

hashCode in class java.lang.Object

getJintegraDispatch

public com.esri.arcgis.interop.Dispatch getJintegraDispatch()

Deprecated. Internal use only.

Specified by:

getJintegraDispatch in interface com.esri.arcgis.interop.RemoteObjRef

release

public void release()

Release a DynamicCacheLayerManager.

Specified by:

release in interface com.esri.arcgis.interop.RemoteObjRef

init

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

Initialize the cache manager with the given map and layer.

Specified by:

init in interface IDynamicCacheLayerManager

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

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

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

Specified by:

getFolderName in interface IDynamicCacheLayerManager

Returns:

The cacheFolderName

Throws:

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

AutomationException - If the ArcObject component throws an exception.

getFolderPath

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

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

Specified by:

getFolderPath in interface IDynamicCacheLayerManager

Returns:

The folderPath

Throws:

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

AutomationException - If the ArcObject component throws an exception.

setFolderPath

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

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

Specified by:

setFolderPath in interface IDynamicCacheLayerManager

Parameters:

folderPath - The folderPath (in)

Throws:

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

AutomationException - If the ArcObject component throws an exception.

isCacheable

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

Indicates whether the layer can have a dynamic cache.

Specified by:

isCacheable in interface IDynamicCacheLayerManager

Returns:

The cacheable

Throws:

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

AutomationException - If the ArcObject component throws an exception.

delete

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

Delete the cache structure and tiles from the disk.

Specified by:

delete in interface IDynamicCacheLayerManager

Throws:

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

AutomationException - If the ArcObject component throws an exception.

invalidate

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

Specified by:

invalidate in interface IDynamicCacheLayerManager

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

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

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

Specified by:

getFormat in interface IDynamicCacheLayerManager

Returns:

The format

Throws:

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

AutomationException - If the ArcObject component throws an exception.

setFormat

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

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

Specified by:

setFormat in interface IDynamicCacheLayerManager

Parameters:

format - The format (in)

Throws:

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

AutomationException - If the ArcObject component throws an exception.

connect

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

Try to connect the given layer to a cache.

Specified by:

connect in interface IDynamicCacheLayerManager

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

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

Specified by:

update in interface IDynamicCacheLayerManager

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

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

Indicates whether the given composite layer cache is consolidated.

Specified by:

isConsolidatedGroupLayer in interface IDynamicCacheLayerManager

Returns:

The consolidated

Throws:

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

AutomationException - If the ArcObject component throws an exception.

setConsolidatedGroupLayer

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

Indicates whether the given composite layer cache is consolidated.

Specified by:

setConsolidatedGroupLayer in interface IDynamicCacheLayerManager

Parameters:

consolidated - The consolidated (in)

Throws:

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

AutomationException - If the ArcObject component throws an exception.

isStrictOnDemandMode

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

Specified by:

isStrictOnDemandMode in interface IDynamicCacheLayerManager

Returns:

The strictOnDemandMode

Throws:

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

AutomationException - If the ArcObject component throws an exception.

setStrictOnDemandMode

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

Specified by:

setStrictOnDemandMode in interface IDynamicCacheLayerManager

Parameters:

strictOnDemandMode - The strictOnDemandMode (in)

Throws:

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

AutomationException - If the ArcObject component throws an exception.

getMaxCacheScale

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

The maximum scale by which tiles are to be generated.

Specified by:

getMaxCacheScale in interface IDynamicCacheLayerManager

Returns:

The maxScale

Throws:

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

AutomationException - If the ArcObject component throws an exception.

setMaxCacheScale

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

The maximum scale by which tiles are to be generated.

Specified by:

setMaxCacheScale in interface IDynamicCacheLayerManager

Parameters:

maxScale - The maxScale (in)

Throws:

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

AutomationException - If the ArcObject component throws an exception.

getDetailsThreshold

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

Specified by:

getDetailsThreshold in interface IDynamicCacheLayerManager

Returns:

The threshold

Throws:

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

AutomationException - If the ArcObject component throws an exception.

setDetailsThreshold

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

Specified by:

setDetailsThreshold in interface IDynamicCacheLayerManager

Parameters:

threshold - The threshold (in)

Throws:

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

AutomationException - If the ArcObject component throws an exception.

getProgressiveDrawingLevels

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

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

Specified by:

getProgressiveDrawingLevels in interface IDynamicCacheLayerManager

Returns:

The numOfProgressiveLevels

Throws:

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

AutomationException - If the ArcObject component throws an exception.

setProgressiveDrawingLevels

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

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

Specified by:

setProgressiveDrawingLevels in interface IDynamicCacheLayerManager

Parameters:

numOfProgressiveLevels - The numOfProgressiveLevels (in)

Throws:

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

AutomationException - If the ArcObject component throws an exception.

getProgressiveFetchingLevels

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

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

Specified by:

getProgressiveFetchingLevels in interface IDynamicCacheLayerManager

Returns:

The numOfProgressiveLevels

Throws:

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

AutomationException - If the ArcObject component throws an exception.

setProgressiveFetchingLevels

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

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

Specified by:

setProgressiveFetchingLevels in interface IDynamicCacheLayerManager

Parameters:

numOfProgressiveLevels - The numOfProgressiveLevels (in)

Throws:

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

AutomationException - If the ArcObject component throws an exception.

isAlwaysDrawCoarsestLevel

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

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

Specified by:

isAlwaysDrawCoarsestLevel in interface IDynamicCacheLayerManager

Returns:

The alwaysDrawCoarsestLevel

Throws:

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

AutomationException - If the ArcObject component throws an exception.

setAlwaysDrawCoarsestLevel

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

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

Specified by:

setAlwaysDrawCoarsestLevel in interface IDynamicCacheLayerManager

Parameters:

alwaysDrawCoarsestLevel - The alwaysDrawCoarsestLevel (in)

Throws:

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

AutomationException - If the ArcObject component throws an exception.

isCached

public boolean isCached()
                 throws java.io.IOException,
                        AutomationException

Indicates whether the layer is drawing while in cached mode.

Specified by:

isCached in interface IDynamicCacheLayerManager2

Returns:

The cached

Throws:

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

AutomationException - If the ArcObject component throws an exception.

setCached

public void setCached(boolean cached)
               throws java.io.IOException,
                      AutomationException

Indicates whether the layer is drawing while in cached mode.

Specified by:

setCached in interface IDynamicCacheLayerManager2

Parameters:

cached - The cached (in)

Throws:

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

AutomationException - If the ArcObject component throws an exception.