com.esri.arcgis.datasourcesraster
Interface IMosaicFunction

All Superinterfaces:
Serializable
All Known Implementing Classes:
MosaicFunction

public interface IMosaicFunction
extends Serializable

Provides access to members that control mosaic function.

Product Availability

Available with ArcGIS Engine, ArcGIS Desktop, and ArcGIS Server.


Method Summary
 String constructQueryExpression(IPoint pCellsize)
          Constructs a query expression (WHERE clause).
 ITable getCatalog()
          The catalog.
 String getCellsizeFieldName()
          The native raster cellsize field name.
 String getDefinitionExpression()
          The definition expression on the source catalog.
 IFIDSet getDefinitionFIDs()
          The definition selection set on the source catalog.
 IGeometry getDefinitionGeometry()
          The definition (spatial selection) geometry on the source catalog.
 IFIDSet getFIDs()
          The current selection set on the source catalog.
 ISymbol getFootprintSymbol()
          The symbol used to draw footprints.
 String getLockRasterFieldName()
          The lock raster ID field name in the source catalog.
 String getLockRasterID()
          The lock raster ID.
 String getLODFieldName()
          The LOD field name.
 IMosaicLODInfos getLODInfos()
          The current mosaic LOD information.
 int getMaxCellsizeFieldIndex()
          The maximum cellsize field index.
 String getMaxCellsizeFieldName()
          The maximum cellsize field name.
 IPnt getMaximumVisibleCellsize()
          The maximum visible cellsize.
 int getMaxMosaicImageCount()
          The maximum number of rasters used per request.
 int getMinCellsizeFieldIndex()
          The minimum cellsize field index.
 String getMinCellsizeFieldName()
          The minimum cellsize field name.
 int getMosaicMethod()
          The mosaic method.
 IMosaicOperator getMosaicOperator()
          The current mosaic operator.
 int getMosaicOperatorType()
          The current mosaic operator type.
 Object getOrderByBaseValue()
          The Order By base value.
 String getOrderByFieldName()
          The Order By field on the source catalog.
 int getRasterFieldIndex()
          The raster field index.
 String getRasterFieldName()
          The raster field name in the source catalog.
 IPoint getViewpoint()
          The view point.
 String getWhereClause()
          The SQL selection where clause expression.
 boolean isApplyColorCorrection()
          Indicates if color correction needs to be applied.
 boolean isAscending()
          Indicates whether the ascending flag of OrderBy.
 boolean isClipToFootprint()
          Indicates if individual images will be clipped to their footprints.
 boolean isDrawFootprint()
          Indicates if to draw footprints.
 boolean isVisible(double dx, double dy)
          Checks if a given pixel size is visible.
 void lockCellsize(double cellSize)
          Locks LOD at a given cellsize.
 ICursor search(IQueryFilter pQueryFilter, IPoint pCellsize)
          Searches the catalog using current mosaic rules.
 void setApplyColorCorrection(boolean pApplyColorCorrection)
          Indicates if color correction needs to be applied.
 void setAscending(boolean pAscending)
          Indicates whether the ascending flag of OrderBy.
 void setCellsizeFieldName(String pCellsizeFieldName)
          The native raster cellsize field name.
 void setClipToFootprint(boolean pClipping)
          Indicates if individual images will be clipped to their footprints.
 void setDefinitionExpression(String pExpression)
          The definition expression on the source catalog.
 void setDefinitionFIDsByRef(IFIDSet ppFIDs)
          The definition selection set on the source catalog.
 void setDefinitionGeometryByRef(IGeometry ppGeometry)
          The definition (spatial selection) geometry on the source catalog.
 void setDrawFootprint(boolean pDraw)
          Indicates if to draw footprints.
 void setFIDsByRef(IFIDSet ppFIDs)
          The current selection set on the source catalog.
 void setFootprintSymbolByRef(ISymbol ppSymbol)
          The symbol used to draw footprints.
 void setLockRasterFieldName(String pLockFieldName)
          The lock raster ID field name in the source catalog.
 void setLockRasterID(String pRasterID)
          The lock raster ID.
 void setLODFieldName(String pLODFieldName)
          The LOD field name.
 void setLODInfosByRef(IMosaicLODInfos ppLODInfos)
          The current mosaic LOD information.
 void setMaxCellsizeFieldName(String pMaxCellsizeFieldName)
          The maximum cellsize field name.
 void setMaximumVisibleCellsize(IPnt ppCellsize)
          The maximum visible cellsize.
 void setMaxMosaicImageCount(int pCount)
          The maximum number of rasters used per request.
 void setMinCellsizeFieldName(String pMinCellsizeFieldName)
          The minimum cellsize field name.
 void setMosaicMethod(int pMosaicMethod)
          The mosaic method.
 void setMosaicOperatorByRef(IMosaicOperator op)
          The current mosaic operator.
 void setMosaicOperatorType(int type)
          The current mosaic operator type.
 void setOrderByBaseValue(Object pValue)
          The Order By base value.
 void setOrderByFieldName(String pName)
          The Order By field on the source catalog.
 void setRasterFieldName(String pRasterFieldName)
          The raster field name in the source catalog.
 void setViewpointByRef(IPoint ppViewpoint)
          The view point.
 void setWhereClause(String pExpression)
          The SQL selection where clause expression.
 void unlockCellsize()
          Unlocks LOD from the locked cellsize.
 

Method Detail

getDefinitionExpression

String getDefinitionExpression()
                               throws IOException,
                                      AutomationException
The definition expression on the source catalog.

Product Availability

Available with ArcGIS Engine, ArcGIS Desktop, and ArcGIS Server.

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

setDefinitionExpression

void setDefinitionExpression(String pExpression)
                             throws IOException,
                                    AutomationException
The definition expression on the source catalog.

Product Availability

Available with ArcGIS Engine, ArcGIS Desktop, and ArcGIS Server.

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

getDefinitionGeometry

IGeometry getDefinitionGeometry()
                                throws IOException,
                                       AutomationException
The definition (spatial selection) geometry on the source catalog.

Product Availability

Available with ArcGIS Engine, ArcGIS Desktop, and ArcGIS Server.

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

setDefinitionGeometryByRef

void setDefinitionGeometryByRef(IGeometry ppGeometry)
                                throws IOException,
                                       AutomationException
The definition (spatial selection) geometry on the source catalog.

Product Availability

Available with ArcGIS Engine, ArcGIS Desktop, and ArcGIS Server.

Parameters:
ppGeometry - A reference to a com.esri.arcgis.geometry.IGeometry (in)
Throws:
IOException - If there are interop problems.
AutomationException - If the ArcObject component throws an exception.

setDefinitionFIDsByRef

void setDefinitionFIDsByRef(IFIDSet ppFIDs)
                            throws IOException,
                                   AutomationException
The definition selection set on the source catalog.

Product Availability

Available with ArcGIS Engine, ArcGIS Desktop, and ArcGIS Server.

Parameters:
ppFIDs - A reference to a com.esri.arcgis.geodatabase.IFIDSet (in)
Throws:
IOException - If there are interop problems.
AutomationException - If the ArcObject component throws an exception.

getDefinitionFIDs

IFIDSet getDefinitionFIDs()
                          throws IOException,
                                 AutomationException
The definition selection set on the source catalog.

Product Availability

Available with ArcGIS Engine, ArcGIS Desktop, and ArcGIS Server.

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

getRasterFieldName

String getRasterFieldName()
                          throws IOException,
                                 AutomationException
The raster field name in the source catalog.

Product Availability

Available with ArcGIS Engine, ArcGIS Desktop, and ArcGIS Server.

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

setRasterFieldName

void setRasterFieldName(String pRasterFieldName)
                        throws IOException,
                               AutomationException
The raster field name in the source catalog.

Product Availability

Available with ArcGIS Engine, ArcGIS Desktop, and ArcGIS Server.

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

getCellsizeFieldName

String getCellsizeFieldName()
                            throws IOException,
                                   AutomationException
The native raster cellsize field name.

Product Availability

Available with ArcGIS Engine, ArcGIS Desktop, and ArcGIS Server.

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

setCellsizeFieldName

void setCellsizeFieldName(String pCellsizeFieldName)
                          throws IOException,
                                 AutomationException
The native raster cellsize field name.

Product Availability

Available with ArcGIS Engine, ArcGIS Desktop, and ArcGIS Server.

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

getMinCellsizeFieldName

String getMinCellsizeFieldName()
                               throws IOException,
                                      AutomationException
The minimum cellsize field name.

Product Availability

Available with ArcGIS Engine, ArcGIS Desktop, and ArcGIS Server.

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

setMinCellsizeFieldName

void setMinCellsizeFieldName(String pMinCellsizeFieldName)
                             throws IOException,
                                    AutomationException
The minimum cellsize field name.

Product Availability

Available with ArcGIS Engine, ArcGIS Desktop, and ArcGIS Server.

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

getMaxCellsizeFieldName

String getMaxCellsizeFieldName()
                               throws IOException,
                                      AutomationException
The maximum cellsize field name.

Product Availability

Available with ArcGIS Engine, ArcGIS Desktop, and ArcGIS Server.

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

setMaxCellsizeFieldName

void setMaxCellsizeFieldName(String pMaxCellsizeFieldName)
                             throws IOException,
                                    AutomationException
The maximum cellsize field name.

Product Availability

Available with ArcGIS Engine, ArcGIS Desktop, and ArcGIS Server.

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

getLODFieldName

String getLODFieldName()
                       throws IOException,
                              AutomationException
The LOD field name.

Product Availability

Available with ArcGIS Engine, ArcGIS Desktop, and ArcGIS Server.

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

setLODFieldName

void setLODFieldName(String pLODFieldName)
                     throws IOException,
                            AutomationException
The LOD field name.

Product Availability

Available with ArcGIS Engine, ArcGIS Desktop, and ArcGIS Server.

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

getLODInfos

IMosaicLODInfos getLODInfos()
                            throws IOException,
                                   AutomationException
The current mosaic LOD information.

Product Availability

Available with ArcGIS Engine, ArcGIS Desktop, and ArcGIS Server.

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

setLODInfosByRef

void setLODInfosByRef(IMosaicLODInfos ppLODInfos)
                      throws IOException,
                             AutomationException
The current mosaic LOD information.

Product Availability

Available with ArcGIS Engine, ArcGIS Desktop, and ArcGIS Server.

Parameters:
ppLODInfos - A reference to a com.esri.arcgis.datasourcesraster.IMosaicLODInfos (in)
Throws:
IOException - If there are interop problems.
AutomationException - If the ArcObject component throws an exception.

getMaximumVisibleCellsize

IPnt getMaximumVisibleCellsize()
                               throws IOException,
                                      AutomationException
The maximum visible cellsize.

Product Availability

Available with ArcGIS Engine, ArcGIS Desktop, and ArcGIS Server.

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

setMaximumVisibleCellsize

void setMaximumVisibleCellsize(IPnt ppCellsize)
                               throws IOException,
                                      AutomationException
The maximum visible cellsize.

Product Availability

Available with ArcGIS Engine, ArcGIS Desktop, and ArcGIS Server.

Parameters:
ppCellsize - A reference to a com.esri.arcgis.geodatabase.IPnt (in)
Throws:
IOException - If there are interop problems.
AutomationException - If the ArcObject component throws an exception.

isDrawFootprint

boolean isDrawFootprint()
                        throws IOException,
                               AutomationException
Indicates if to draw footprints.

Product Availability

Available with ArcGIS Engine, ArcGIS Desktop, and ArcGIS Server.

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

setDrawFootprint

void setDrawFootprint(boolean pDraw)
                      throws IOException,
                             AutomationException
Indicates if to draw footprints.

Product Availability

Available with ArcGIS Engine, ArcGIS Desktop, and ArcGIS Server.

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

getFootprintSymbol

ISymbol getFootprintSymbol()
                           throws IOException,
                                  AutomationException
The symbol used to draw footprints.

Product Availability

Available with ArcGIS Engine, ArcGIS Desktop, and ArcGIS Server.

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

setFootprintSymbolByRef

void setFootprintSymbolByRef(ISymbol ppSymbol)
                             throws IOException,
                                    AutomationException
The symbol used to draw footprints.

Product Availability

Available with ArcGIS Engine, ArcGIS Desktop, and ArcGIS Server.

Parameters:
ppSymbol - A reference to a com.esri.arcgis.display.ISymbol (in)
Throws:
IOException - If there are interop problems.
AutomationException - If the ArcObject component throws an exception.

getMosaicMethod

int getMosaicMethod()
                    throws IOException,
                           AutomationException
The mosaic method.

Product Availability

Available with ArcGIS Engine, ArcGIS Desktop, and ArcGIS Server.

Returns:
A com.esri.arcgis.datasourcesraster.esriMosaicMethod constant
Throws:
IOException - If there are interop problems.
AutomationException - If the ArcObject component throws an exception.

setMosaicMethod

void setMosaicMethod(int pMosaicMethod)
                     throws IOException,
                            AutomationException
The mosaic method.

Product Availability

Available with ArcGIS Engine, ArcGIS Desktop, and ArcGIS Server.

Parameters:
pMosaicMethod - A com.esri.arcgis.datasourcesraster.esriMosaicMethod constant (in)
Throws:
IOException - If there are interop problems.
AutomationException - If the ArcObject component throws an exception.

getOrderByFieldName

String getOrderByFieldName()
                           throws IOException,
                                  AutomationException
The Order By field on the source catalog.

Product Availability

Available with ArcGIS Engine, ArcGIS Desktop, and ArcGIS Server.

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

setOrderByFieldName

void setOrderByFieldName(String pName)
                         throws IOException,
                                AutomationException
The Order By field on the source catalog.

Product Availability

Available with ArcGIS Engine, ArcGIS Desktop, and ArcGIS Server.

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

getOrderByBaseValue

Object getOrderByBaseValue()
                           throws IOException,
                                  AutomationException
The Order By base value.

Product Availability

Available with ArcGIS Engine, ArcGIS Desktop, and ArcGIS Server.

Returns:
A Variant
Throws:
IOException - If there are interop problems.
AutomationException - If the ArcObject component throws an exception.

setOrderByBaseValue

void setOrderByBaseValue(Object pValue)
                         throws IOException,
                                AutomationException
The Order By base value.

Product Availability

Available with ArcGIS Engine, ArcGIS Desktop, and ArcGIS Server.

Parameters:
pValue - A Variant (in)
Throws:
IOException - If there are interop problems.
AutomationException - If the ArcObject component throws an exception.

getLockRasterFieldName

String getLockRasterFieldName()
                              throws IOException,
                                     AutomationException
The lock raster ID field name in the source catalog.

Product Availability

Available with ArcGIS Engine, ArcGIS Desktop, and ArcGIS Server.

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

setLockRasterFieldName

void setLockRasterFieldName(String pLockFieldName)
                            throws IOException,
                                   AutomationException
The lock raster ID field name in the source catalog.

Product Availability

Available with ArcGIS Engine, ArcGIS Desktop, and ArcGIS Server.

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

getLockRasterID

String getLockRasterID()
                       throws IOException,
                              AutomationException
The lock raster ID.

Product Availability

Available with ArcGIS Engine, ArcGIS Desktop, and ArcGIS Server.

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

setLockRasterID

void setLockRasterID(String pRasterID)
                     throws IOException,
                            AutomationException
The lock raster ID.

Product Availability

Available with ArcGIS Engine, ArcGIS Desktop, and ArcGIS Server.

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

getViewpoint

IPoint getViewpoint()
                    throws IOException,
                           AutomationException
The view point.

Product Availability

Available with ArcGIS Engine, ArcGIS Desktop, and ArcGIS Server.

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

setViewpointByRef

void setViewpointByRef(IPoint ppViewpoint)
                       throws IOException,
                              AutomationException
The view point.

Product Availability

Available with ArcGIS Engine, ArcGIS Desktop, and ArcGIS Server.

Parameters:
ppViewpoint - A reference to a com.esri.arcgis.geometry.IPoint (in)
Throws:
IOException - If there are interop problems.
AutomationException - If the ArcObject component throws an exception.

isAscending

boolean isAscending()
                    throws IOException,
                           AutomationException
Indicates whether the ascending flag of OrderBy.

Product Availability

Available with ArcGIS Engine, ArcGIS Desktop, and ArcGIS Server.

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

setAscending

void setAscending(boolean pAscending)
                  throws IOException,
                         AutomationException
Indicates whether the ascending flag of OrderBy.

Product Availability

Available with ArcGIS Engine, ArcGIS Desktop, and ArcGIS Server.

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

getMosaicOperatorType

int getMosaicOperatorType()
                          throws IOException,
                                 AutomationException
The current mosaic operator type.

Product Availability

Available with ArcGIS Engine, ArcGIS Desktop, and ArcGIS Server.

Returns:
A com.esri.arcgis.datasourcesraster.rstMosaicOperatorType constant
Throws:
IOException - If there are interop problems.
AutomationException - If the ArcObject component throws an exception.

setMosaicOperatorType

void setMosaicOperatorType(int type)
                           throws IOException,
                                  AutomationException
The current mosaic operator type.

Product Availability

Available with ArcGIS Engine, ArcGIS Desktop, and ArcGIS Server.

Parameters:
type - A com.esri.arcgis.datasourcesraster.rstMosaicOperatorType constant (in)
Throws:
IOException - If there are interop problems.
AutomationException - If the ArcObject component throws an exception.

getMosaicOperator

IMosaicOperator getMosaicOperator()
                                  throws IOException,
                                         AutomationException
The current mosaic operator.

Product Availability

Available with ArcGIS Engine, ArcGIS Desktop, and ArcGIS Server.

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

setMosaicOperatorByRef

void setMosaicOperatorByRef(IMosaicOperator op)
                            throws IOException,
                                   AutomationException
The current mosaic operator.

Product Availability

Available with ArcGIS Engine, ArcGIS Desktop, and ArcGIS Server.

Parameters:
op - A reference to a com.esri.arcgis.datasourcesraster.IMosaicOperator (in)
Throws:
IOException - If there are interop problems.
AutomationException - If the ArcObject component throws an exception.

getWhereClause

String getWhereClause()
                      throws IOException,
                             AutomationException
The SQL selection where clause expression.

Product Availability

Available with ArcGIS Engine, ArcGIS Desktop, and ArcGIS Server.

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

setWhereClause

void setWhereClause(String pExpression)
                    throws IOException,
                           AutomationException
The SQL selection where clause expression.

Product Availability

Available with ArcGIS Engine, ArcGIS Desktop, and ArcGIS Server.

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

setFIDsByRef

void setFIDsByRef(IFIDSet ppFIDs)
                  throws IOException,
                         AutomationException
The current selection set on the source catalog.

Product Availability

Available with ArcGIS Engine, ArcGIS Desktop, and ArcGIS Server.

Parameters:
ppFIDs - A reference to a com.esri.arcgis.geodatabase.IFIDSet (in)
Throws:
IOException - If there are interop problems.
AutomationException - If the ArcObject component throws an exception.

getFIDs

IFIDSet getFIDs()
                throws IOException,
                       AutomationException
The current selection set on the source catalog.

Product Availability

Available with ArcGIS Engine, ArcGIS Desktop, and ArcGIS Server.

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

lockCellsize

void lockCellsize(double cellSize)
                  throws IOException,
                         AutomationException
Locks LOD at a given cellsize.

Product Availability

Available with ArcGIS Engine, ArcGIS Desktop, and ArcGIS Server.

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

unlockCellsize

void unlockCellsize()
                    throws IOException,
                           AutomationException
Unlocks LOD from the locked cellsize.

Product Availability

Available with ArcGIS Engine, ArcGIS Desktop, and ArcGIS Server.

Throws:
IOException - If there are interop problems.
AutomationException - If the ArcObject component throws an exception.

getCatalog

ITable getCatalog()
                  throws IOException,
                         AutomationException
The catalog.

Product Availability

Available with ArcGIS Engine, ArcGIS Desktop, and ArcGIS Server.

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

getRasterFieldIndex

int getRasterFieldIndex()
                        throws IOException,
                               AutomationException
The raster field index.

Product Availability

Available with ArcGIS Engine, ArcGIS Desktop, and ArcGIS Server.

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

getMinCellsizeFieldIndex

int getMinCellsizeFieldIndex()
                             throws IOException,
                                    AutomationException
The minimum cellsize field index.

Product Availability

Available with ArcGIS Engine, ArcGIS Desktop, and ArcGIS Server.

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

getMaxCellsizeFieldIndex

int getMaxCellsizeFieldIndex()
                             throws IOException,
                                    AutomationException
The maximum cellsize field index.

Product Availability

Available with ArcGIS Engine, ArcGIS Desktop, and ArcGIS Server.

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

isVisible

boolean isVisible(double dx,
                  double dy)
                  throws IOException,
                         AutomationException
Checks if a given pixel size is visible.

Product Availability

Available with ArcGIS Engine, ArcGIS Desktop, and ArcGIS Server.

Parameters:
dx - The dx (in)
dy - The dy (in)
Returns:
The pvbVisible
Throws:
IOException - If there are interop problems.
AutomationException - If the ArcObject component throws an exception.

getMaxMosaicImageCount

int getMaxMosaicImageCount()
                           throws IOException,
                                  AutomationException
The maximum number of rasters used per request.

Product Availability

Available with ArcGIS Engine, ArcGIS Desktop, and ArcGIS Server.

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

setMaxMosaicImageCount

void setMaxMosaicImageCount(int pCount)
                            throws IOException,
                                   AutomationException
The maximum number of rasters used per request.

Product Availability

Available with ArcGIS Engine, ArcGIS Desktop, and ArcGIS Server.

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

isClipToFootprint

boolean isClipToFootprint()
                          throws IOException,
                                 AutomationException
Indicates if individual images will be clipped to their footprints.

Product Availability

Available with ArcGIS Engine, ArcGIS Desktop, and ArcGIS Server.

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

setClipToFootprint

void setClipToFootprint(boolean pClipping)
                        throws IOException,
                               AutomationException
Indicates if individual images will be clipped to their footprints.

Product Availability

Available with ArcGIS Engine, ArcGIS Desktop, and ArcGIS Server.

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

isApplyColorCorrection

boolean isApplyColorCorrection()
                               throws IOException,
                                      AutomationException
Indicates if color correction needs to be applied.

Product Availability

Available with ArcGIS Engine, ArcGIS Desktop, and ArcGIS Server.

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

setApplyColorCorrection

void setApplyColorCorrection(boolean pApplyColorCorrection)
                             throws IOException,
                                    AutomationException
Indicates if color correction needs to be applied.

Product Availability

Available with ArcGIS Engine, ArcGIS Desktop, and ArcGIS Server.

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

constructQueryExpression

String constructQueryExpression(IPoint pCellsize)
                                throws IOException,
                                       AutomationException
Constructs a query expression (WHERE clause).

Product Availability

Available with ArcGIS Engine, ArcGIS Desktop, and ArcGIS Server.

Parameters:
pCellsize - A reference to a com.esri.arcgis.geometry.IPoint (in)
Returns:
The pQueryExpression
Throws:
IOException - If there are interop problems.
AutomationException - If the ArcObject component throws an exception.

search

ICursor search(IQueryFilter pQueryFilter,
               IPoint pCellsize)
               throws IOException,
                      AutomationException
Searches the catalog using current mosaic rules.

Product Availability

Available with ArcGIS Engine, ArcGIS Desktop, and ArcGIS Server.

Parameters:
pQueryFilter - A reference to a com.esri.arcgis.geodatabase.IQueryFilter (in)
pCellsize - A reference to a com.esri.arcgis.geometry.IPoint (in)
Returns:
A reference to a com.esri.arcgis.geodatabase.ICursor
Throws:
IOException - If there are interop problems.
AutomationException - If the ArcObject component throws an exception.