Overview  Package   Class  Tree  Deprecated  Index  Help 
 PREV CLASS   NEXT CLASS FRAMES    NO FRAMES    
SUMMARY: NESTED | FIELD | CONSTR | METHOD DETAIL: FIELD | CONSTR | METHOD

com.esri.arcgis.carto
Interface IImageCooker

All Superinterfaces:
java.io.Serializable
All Known Implementing Classes:
IImageCookerProxy, ImageCooker
public interface IImageCooker
extends java.io.Serializable

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

Description: 'AIS cache reader object.' 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 IIDc254d4a2_97b2_469e_b463_f51811f4b4cf
           
static int xxDummy
          Deprecated. Internal use only
 
Method Summary
 void clear(IEnvelope pExtent, ITrackCancel pTrackCancel)
          Clears cache tiles with a given extent.
 void connect(java.lang.String location, IImageServer pImageServer)
          Connects an image server object to its cache location.
 void getCacheDirectory(java.lang.String[] pCacheDir)
          Gets the cache directory/location.
 double getMaximumImageCellsize()
          The maximum source image cellsize below which data are available.
 IName getServerObjectName()
          The ArcGIS server object to run the image cooker.
 int getThreadCount()
          The number of Image Cooker instances for building tile cache.
 byte[] getTile(int level, int row, int column)
          Gets a tile at a given LOD, and column and row location.
 void putTile(int level, int row, int column, byte[] ppTile)
          Puts a tile at a given LOD, and column and row location.
 void setMaximumImageCellsize(double pMaxPS)
          The maximum source image cellsize below which data are available.
 void setServerObjectNameByRef(IName ppName)
          The ArcGIS server object to run the image cooker.
 void setThreadCount(int pThreadCount)
          The number of Image Cooker instances for building tile cache.
 void update(IImageServer pImageServer, IEnvelope pExtent, ILongArray pLevels, int updateMode, ITrackCancel pTrackCancel)
          Updates cache within a given extent.
 void updateByGeometry(IImageServer pImageServer, IGeometry pGeometry, ILongArray pLevels, int updateMode, ITrackCancel pTrackCancel)
          Updates cache within an area of interest defined by a given geometry.
 

Field Detail

IIDc254d4a2_97b2_469e_b463_f51811f4b4cf

static final int IIDc254d4a2_97b2_469e_b463_f51811f4b4cf
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

connect

void connect(java.lang.String location,
             IImageServer pImageServer)
             throws java.io.IOException,
                    AutomationException
Connects an image server object to its cache location.

Parameters:
location - The location (in)
pImageServer - A reference to a com.esri.arcgis.carto.IImageServer (in)
Throws:
java.io.IOException - If there are interop problems.
AutomationException - If the ArcObject component throws an exception.

clear

void clear(IEnvelope pExtent,
           ITrackCancel pTrackCancel)
           throws java.io.IOException,
                  AutomationException
Clears cache tiles with a given extent.

Parameters:
pExtent - A reference to a com.esri.arcgis.geometry.IEnvelope (in)
pTrackCancel - A reference to a com.esri.arcgis.system.ITrackCancel (in)
Throws:
java.io.IOException - If there are interop problems.
AutomationException - If the ArcObject component throws an exception.

getTile

byte[] getTile(int level,
               int row,
               int column)
               throws java.io.IOException,
                      AutomationException
Gets a tile at a given LOD, and column and row location.

Parameters:
level - The level (in)
row - The row (in)
column - The column (in)
Returns:
An unsigned byte
Throws:
java.io.IOException - If there are interop problems.
AutomationException - If the ArcObject component throws an exception.

putTile

void putTile(int level,
             int row,
             int column,
             byte[] ppTile)
             throws java.io.IOException,
                    AutomationException
Puts a tile at a given LOD, and column and row location.

Parameters:
level - The level (in)
row - The row (in)
column - The column (in)
ppTile - An unsigned byte (in)
Throws:
java.io.IOException - If there are interop problems.
AutomationException - If the ArcObject component throws an exception.

getCacheDirectory

void getCacheDirectory(java.lang.String[] pCacheDir)
                       throws java.io.IOException,
                              AutomationException
Gets the cache directory/location.

Parameters:
pCacheDir - The pCacheDir (out: use single element array)
Throws:
java.io.IOException - If there are interop problems.
AutomationException - If the ArcObject component throws an exception.

update

void update(IImageServer pImageServer,
            IEnvelope pExtent,
            ILongArray pLevels,
            int updateMode,
            ITrackCancel pTrackCancel)
            throws java.io.IOException,
                   AutomationException
Updates cache within a given extent.

Parameters:
pImageServer - A reference to a com.esri.arcgis.carto.IImageServer (in)
pExtent - A reference to a com.esri.arcgis.geometry.IEnvelope (in)
pLevels - A reference to a com.esri.arcgis.system.ILongArray (in)
updateMode - A com.esri.arcgis.carto.esriMapCacheUpdateMode constant (in)
pTrackCancel - A reference to a com.esri.arcgis.system.ITrackCancel (in)
Throws:
java.io.IOException - If there are interop problems.
AutomationException - If the ArcObject component throws an exception.

updateByGeometry

void updateByGeometry(IImageServer pImageServer,
                      IGeometry pGeometry,
                      ILongArray pLevels,
                      int updateMode,
                      ITrackCancel pTrackCancel)
                      throws java.io.IOException,
                             AutomationException
Updates cache within an area of interest defined by a given geometry.

Parameters:
pImageServer - A reference to a com.esri.arcgis.carto.IImageServer (in)
pGeometry - A reference to a com.esri.arcgis.geometry.IGeometry (in)
pLevels - A reference to a com.esri.arcgis.system.ILongArray (in)
updateMode - A com.esri.arcgis.carto.esriMapCacheUpdateMode constant (in)
pTrackCancel - A reference to a com.esri.arcgis.system.ITrackCancel (in)
Throws:
java.io.IOException - If there are interop problems.
AutomationException - If the ArcObject component throws an exception.

getThreadCount

int getThreadCount()
                   throws java.io.IOException,
                          AutomationException
The number of Image Cooker instances for building tile cache.

Returns:
The pThreadCount
Throws:
java.io.IOException - If there are interop problems.
AutomationException - If the ArcObject component throws an exception.

setThreadCount

void setThreadCount(int pThreadCount)
                    throws java.io.IOException,
                           AutomationException
The number of Image Cooker instances for building tile cache.

Parameters:
pThreadCount - The pThreadCount (in)
Throws:
java.io.IOException - If there are interop problems.
AutomationException - If the ArcObject component throws an exception.

getMaximumImageCellsize

double getMaximumImageCellsize()
                               throws java.io.IOException,
                                      AutomationException
The maximum source image cellsize below which data are available.

Returns:
The pMaxPS
Throws:
java.io.IOException - If there are interop problems.
AutomationException - If the ArcObject component throws an exception.

setMaximumImageCellsize

void setMaximumImageCellsize(double pMaxPS)
                             throws java.io.IOException,
                                    AutomationException
The maximum source image cellsize below which data are available.

Parameters:
pMaxPS - The pMaxPS (in)
Throws:
java.io.IOException - If there are interop problems.
AutomationException - If the ArcObject component throws an exception.

getServerObjectName

IName getServerObjectName()
                          throws java.io.IOException,
                                 AutomationException
The ArcGIS server object to run the image cooker.

Returns:
A reference to a com.esri.arcgis.system.IName
Throws:
java.io.IOException - If there are interop problems.
AutomationException - If the ArcObject component throws an exception.

setServerObjectNameByRef

void setServerObjectNameByRef(IName ppName)
                              throws java.io.IOException,
                                     AutomationException
The ArcGIS server object to run the image cooker.

Parameters:
ppName - A reference to a com.esri.arcgis.system.IName (in)
Throws:
java.io.IOException - If there are interop problems.
AutomationException - If the ArcObject component throws an exception.
Overview  Package   Class  Tree  Deprecated  Index  Help 
 PREV CLASS   NEXT CLASS FRAMES    NO FRAMES    
SUMMARY: NESTED | FIELD | CONSTR | METHOD DETAIL: FIELD | CONSTR | METHOD