com.esri.arcgis.carto
Interface IMosaicRule

All Superinterfaces:
Serializable
All Known Implementing Classes:
MosaicRule

public interface IMosaicRule
extends Serializable

Provides access to members that control a mosaic rule.

Description

IMosaicRule interface defines the mosaic rule for mosaicking requested images on the fly. It contains a mosaic method, its parameters, and a mosaic operation. In general, a mosaic rule is used to specify (1) the selection of rasters to participate in the mosaic; (2) how the selected rasters are ordered; (3) how overlapping pixels at the same location are resolved.

Product Availability

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


Method Summary
 IFIDSet getFIDs()
          The list of (selected) catalog item IDs.
 String getLockRasterID()
          The lock raster ID.
 int getMosaicMethod()
          The mosaic method.
 int getMosaicOperatorType()
          The type of mosaic operator for resolving overlapping pixels.
 Object getOrderByBaseValue()
          The Order By base value.
 String getOrderByFieldName()
          The Order By field on the source catalog.
 ITimeValue getTimeValue()
          The request time value.
 IPoint getViewpoint()
          The view point.
 String getWhereClause()
          The SQL selection where clause expression.
 boolean isAscending()
          Indicates whether the ascending flag of OrderBy.
 void setAscending(boolean pAscending)
          Indicates whether the ascending flag of OrderBy.
 void setFIDsByRef(IFIDSet ppFIDs)
          The list of (selected) catalog item IDs.
 void setLockRasterID(String pRasterID)
          The lock raster ID.
 void setMosaicMethod(int pMosaicMethod)
          The mosaic method.
 void setMosaicOperatorType(int type)
          The type of mosaic operator for resolving overlapping pixels.
 void setOrderByBaseValue(Object pValue)
          The Order By base value.
 void setOrderByFieldName(String pName)
          The Order By field on the source catalog.
 void setTimeValueByRef(ITimeValue ppTimeValue)
          The request time value.
 void setViewpointByRef(IPoint ppViewpoint)
          The view point.
 void setWhereClause(String pExpression)
          The SQL selection where clause expression.
 

Method Detail

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.

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.

Description

As a parameter for the mosaic method esriMosaicLockRaster, LockRasterIDs can take a single or a comma delimited list of raster IDs. All those rasters with the given list of raster IDs are selected to participate in the mosaic. An example of the LockRasterIDs string can be 12,15, 20. The rasters will be visible at all pixel sizes regardless of the minimum and maximum pixel size range of the locked rasters.

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.

Remarks

As a parameter for the esriMosaicViewpoint mosaic method, this property defines a viewpoint location on which the ordering is defined based on the distance from the viewpoint and the nadir of rasters.

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.

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.

Remarks

The name of the attribute field that is used, together with a constant OrderByBaseValue, to define the mosaicking order when the mosaic method is set to esriMosaicAttribute. The ordering is defined by the absolute value of the difference between the specified sort field value and the sort base value. For example, the sort field is Month, and the sort value is 7 (July), and the ordering is defined by ABS (Month 7).

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.

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.

Description

Indicates if sorting in an ascending (TRUE) order or a descending order.
This property applies to all mosaic methods where an ordering is defined except esriMosaicLockRaster and esriMosaicSeamline.

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 type of mosaic operator for resolving overlapping pixels.

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 type of mosaic operator for resolving overlapping pixels.

Remarks

MT_FIRST Takes the first value of all overlapping pixels
MT_LAST Takes the last value of all overlapping pixels
MT_MIN Takes the minimum value of all overlapping pixels
MT_MAX Takes the maximum value of all overlapping pixels
MT_MEAN Takes the mean value of all overlapping pixels
MT_BLEND Takes the blended value of all overlapping pixels

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.

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.

getFIDs

IFIDSet getFIDs()
                throws IOException,
                       AutomationException
The list of (selected) catalog item IDs.

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.

setFIDsByRef

void setFIDsByRef(IFIDSet ppFIDs)
                  throws IOException,
                         AutomationException
The list of (selected) catalog item IDs.

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.

getTimeValue

ITimeValue getTimeValue()
                        throws IOException,
                               AutomationException
The request time value.

Product Availability

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

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

setTimeValueByRef

void setTimeValueByRef(ITimeValue ppTimeValue)
                       throws IOException,
                              AutomationException
The request time value.

Product Availability

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

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