com.esri.arcgis.datasourcesraster
Class MosaicFunction

java.lang.Object
  com.esri.arcgis.datasourcesraster.MosaicFunction

All Implemented Interfaces:

IMosaicFunction, IRasterFunction, com.esri.arcgis.interop.RemoteObjRef, IPersist, IPersistStream, IXMLSerialize, IXMLVersionSupport, Externalizable, Serializable

public class MosaicFunction
extends Object
implements com.esri.arcgis.interop.RemoteObjRef, IRasterFunction, IMosaicFunction, IPersist, IPersistStream, IXMLSerialize, IXMLVersionSupport, Externalizable

A class for a raster mosaic function.

Product Availability

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

See Also:

Serialized Form

Constructor Summary

MosaicFunction()
Constructs a MosaicFunction using ArcGIS Engine.

MosaicFunction(Object obj)
Deprecated. As of ArcGIS 9.2, replaced by normal Java casts.
MosaicFunction theMosaicFunction = (MosaicFunction) obj;

Method Summary

void	bind(Object pArguments) Binds function arguments to this raster function.
String	constructQueryExpression(IPoint pCellsize) Constructs a query expression (WHERE clause).
void	deserialize(IXMLSerializeData data) Deserializes an object from XML.
boolean	equals(Object o) Compare this object with another
ITable	getCatalog() The catalog.
String	getCellsizeFieldName() The native raster cellsize field name.
void	getClassID(GUID[] pClassID) getClassID
static String	getClsid() getClsid.
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.
String	getDescription() The raster function description.
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.
String	getMinNamespaceSupported() The minimum namespace the class can serialize to (eg the 90 namespace).
int	getMosaicMethod() The mosaic method.
IMosaicOperator	getMosaicOperator() The current mosaic operator.
int	getMosaicOperatorType() The current mosaic operator type.
String	getName() The raster function name.
Object	getOrderByBaseValue() The Order By base value.
String	getOrderByFieldName() The Order By field on the source catalog.
int	getPixelType() The output pixel type.
int	getRasterFieldIndex() The raster field index.
String	getRasterFieldName() The raster field name in the source catalog.
IRasterInfo	getRasterInfo() The raster information after this function is applied to an object.
void	getSizeMax(_ULARGE_INTEGER[] pcbSize) getSizeMax
IPoint	getViewpoint() The view point.
String	getWhereClause() The SQL selection where clause expression.
int	hashCode() the hashcode for this object
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.
void	isDirty() isDirty
boolean	isDrawFootprint() Indicates if to draw footprints.
boolean	isValid() Indicates if this function is valid, e.g.
boolean	isVisible(double dx, double dy) Checks if a given pixel size is visible.
void	load(IStream pstm) load
void	lockCellsize(double cellSize) Locks LOD at a given cellsize.
void	read(IPnt pTlc, IRaster pRaster, IPixelBlock pPixelBlock) Reads a pixel block starting from the top left corner.
void	readExternal(ObjectInput in)
void	save(IStream pstm, int fClearDirty) save
ICursor	search(IQueryFilter pQueryFilter, IPoint pCellsize) Searches the catalog using current mosaic rules.
void	serialize(IXMLSerializeData data) Serializes an object to XML.
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	setDescription(String pDescription) The raster function description.
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	setName(String pName) The raster function name.
void	setOrderByBaseValue(Object pValue) The Order By base value.
void	setOrderByFieldName(String pName) The Order By field on the source catalog.
void	setPixelType(int pPixelType) The output pixel type.
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.
void	update() Updates using newly available information from bound object.
void	writeExternal(ObjectOutput out)

Methods inherited from class java.lang.Object

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

Methods inherited from interface com.esri.arcgis.interop.RemoteObjRef

getJintegraDispatch, release

Constructor Detail

MosaicFunction

public MosaicFunction()
               throws IOException,
                      UnknownHostException

Constructs a MosaicFunction using ArcGIS Engine.

Throws:

IOException - if there are interop problems

UnknownHostException - if there are interop problems

MosaicFunction

public MosaicFunction(Object obj)
               throws IOException

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

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

Parameters:

obj - an object returned from ArcGIS Engine or Server

Throws:

IOException - if there are interop problems

Method Detail

getClsid

public static String getClsid()

getClsid.

equals

public boolean equals(Object o)

Compare this object with another

Overrides:

equals in class Object

hashCode

public int hashCode()

the hashcode for this object

Overrides:

hashCode in class Object

getName

public String getName()
               throws IOException,
                      AutomationException

The raster function name.

Product Availability

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

Specified by:

getName in interface IRasterFunction

Returns:

The pName

Throws:

IOException - If there are interop problems.

AutomationException - If the ArcObject component throws an exception.

setName

public void setName(String pName)
             throws IOException,
                    AutomationException

The raster function name.

Product Availability

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

Specified by:

setName in interface IRasterFunction

Parameters:

pName - The pName (in)

Throws:

IOException - If there are interop problems.

AutomationException - If the ArcObject component throws an exception.

getDescription

public String getDescription()
                      throws IOException,
                             AutomationException

The raster function description.

Product Availability

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

Specified by:

getDescription in interface IRasterFunction

Returns:

The pDescription

Throws:

IOException - If there are interop problems.

AutomationException - If the ArcObject component throws an exception.

setDescription

public void setDescription(String pDescription)
                    throws IOException,
                           AutomationException

The raster function description.

Product Availability

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

Specified by:

setDescription in interface IRasterFunction

Parameters:

pDescription - The pDescription (in)

Throws:

IOException - If there are interop problems.

AutomationException - If the ArcObject component throws an exception.

getPixelType

public int getPixelType()
                 throws IOException,
                        AutomationException

The output pixel type.

Product Availability

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

Specified by:

getPixelType in interface IRasterFunction

Returns:

A com.esri.arcgis.geodatabase.rstPixelType constant

Throws:

IOException - If there are interop problems.

AutomationException - If the ArcObject component throws an exception.

setPixelType

public void setPixelType(int pPixelType)
                  throws IOException,
                         AutomationException

The output pixel type.

Product Availability

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

Specified by:

setPixelType in interface IRasterFunction

Parameters:

pPixelType - A com.esri.arcgis.geodatabase.rstPixelType constant (in)

Throws:

IOException - If there are interop problems.

AutomationException - If the ArcObject component throws an exception.

bind

public void bind(Object pArguments)
          throws IOException,
                 AutomationException

Binds function arguments to this raster function.

Product Availability

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

Specified by:

bind in interface IRasterFunction

Parameters:

pArguments - A reference to another Object (IUnknown) (in)

Throws:

IOException - If there are interop problems.

AutomationException - If the ArcObject component throws an exception.

isValid

public boolean isValid()
                throws IOException,
                       AutomationException

Indicates if this function is valid, e.g. bound to an object, and etc.

Product Availability

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

Specified by:

isValid in interface IRasterFunction

Returns:

The pValid

Throws:

IOException - If there are interop problems.

AutomationException - If the ArcObject component throws an exception.

update

public void update()
            throws IOException,
                   AutomationException

Updates using newly available information from bound object.

Product Availability

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

Specified by:

update in interface IRasterFunction

Throws:

IOException - If there are interop problems.

AutomationException - If the ArcObject component throws an exception.

getRasterInfo

public IRasterInfo getRasterInfo()
                          throws IOException,
                                 AutomationException

The raster information after this function is applied to an object.

Product Availability

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

Specified by:

getRasterInfo in interface IRasterFunction

Returns:

A reference to a com.esri.arcgis.datasourcesraster.IRasterInfo

Throws:

IOException - If there are interop problems.

AutomationException - If the ArcObject component throws an exception.

read

public void read(IPnt pTlc,
                 IRaster pRaster,
                 IPixelBlock pPixelBlock)
          throws IOException,
                 AutomationException

Reads a pixel block starting from the top left corner.

Product Availability

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

Specified by:

read in interface IRasterFunction

Parameters:

pTlc - A reference to a com.esri.arcgis.geodatabase.IPnt (in)

pRaster - A reference to a com.esri.arcgis.geodatabase.IRaster (in)

pPixelBlock - A reference to a com.esri.arcgis.geodatabase.IPixelBlock (in)

Throws:

IOException - If there are interop problems.

AutomationException - If the ArcObject component throws an exception.

getDefinitionExpression

public String getDefinitionExpression()
                               throws IOException,
                                      AutomationException

The definition expression on the source catalog.

Product Availability

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

Specified by:

getDefinitionExpression in interface IMosaicFunction

Returns:

The pExpression

Throws:

IOException - If there are interop problems.

AutomationException - If the ArcObject component throws an exception.

setDefinitionExpression

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

Specified by:

setDefinitionExpression in interface IMosaicFunction

Parameters:

pExpression - The pExpression (in)

Throws:

IOException - If there are interop problems.

AutomationException - If the ArcObject component throws an exception.

getDefinitionGeometry

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

Specified by:

getDefinitionGeometry in interface IMosaicFunction

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

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

Specified by:

setDefinitionGeometryByRef in interface IMosaicFunction

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

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

Specified by:

setDefinitionFIDsByRef in interface IMosaicFunction

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

public IFIDSet getDefinitionFIDs()
                          throws IOException,
                                 AutomationException

The definition selection set on the source catalog.

Product Availability

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

Specified by:

getDefinitionFIDs in interface IMosaicFunction

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

public String getRasterFieldName()
                          throws IOException,
                                 AutomationException

The raster field name in the source catalog.

Product Availability

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

Specified by:

getRasterFieldName in interface IMosaicFunction

Returns:

The pRasterFieldName

Throws:

IOException - If there are interop problems.

AutomationException - If the ArcObject component throws an exception.

setRasterFieldName

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

Specified by:

setRasterFieldName in interface IMosaicFunction

Parameters:

pRasterFieldName - The pRasterFieldName (in)

Throws:

IOException - If there are interop problems.

AutomationException - If the ArcObject component throws an exception.

getCellsizeFieldName

public String getCellsizeFieldName()
                            throws IOException,
                                   AutomationException

The native raster cellsize field name.

Product Availability

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

Specified by:

getCellsizeFieldName in interface IMosaicFunction

Returns:

The pCellsizeFieldName

Throws:

IOException - If there are interop problems.

AutomationException - If the ArcObject component throws an exception.

setCellsizeFieldName

public void setCellsizeFieldName(String pCellsizeFieldName)
                          throws IOException,
                                 AutomationException

The native raster cellsize field name.

Product Availability

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

Specified by:

setCellsizeFieldName in interface IMosaicFunction

Parameters:

pCellsizeFieldName - The pCellsizeFieldName (in)

Throws:

IOException - If there are interop problems.

AutomationException - If the ArcObject component throws an exception.

getMinCellsizeFieldName

public String getMinCellsizeFieldName()
                               throws IOException,
                                      AutomationException

The minimum cellsize field name.

Product Availability

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

Specified by:

getMinCellsizeFieldName in interface IMosaicFunction

Returns:

The pMinCellsizeFieldName

Throws:

IOException - If there are interop problems.

AutomationException - If the ArcObject component throws an exception.

setMinCellsizeFieldName

public void setMinCellsizeFieldName(String pMinCellsizeFieldName)
                             throws IOException,
                                    AutomationException

The minimum cellsize field name.

Product Availability

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

Specified by:

setMinCellsizeFieldName in interface IMosaicFunction

Parameters:

pMinCellsizeFieldName - The pMinCellsizeFieldName (in)

Throws:

IOException - If there are interop problems.

AutomationException - If the ArcObject component throws an exception.

getMaxCellsizeFieldName

public String getMaxCellsizeFieldName()
                               throws IOException,
                                      AutomationException

The maximum cellsize field name.

Product Availability

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

Specified by:

getMaxCellsizeFieldName in interface IMosaicFunction

Returns:

The pMaxCellsizeFieldName

Throws:

IOException - If there are interop problems.

AutomationException - If the ArcObject component throws an exception.

setMaxCellsizeFieldName

public void setMaxCellsizeFieldName(String pMaxCellsizeFieldName)
                             throws IOException,
                                    AutomationException

The maximum cellsize field name.

Product Availability

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

Specified by:

setMaxCellsizeFieldName in interface IMosaicFunction

Parameters:

pMaxCellsizeFieldName - The pMaxCellsizeFieldName (in)

Throws:

IOException - If there are interop problems.

AutomationException - If the ArcObject component throws an exception.

getLODFieldName

public String getLODFieldName()
                       throws IOException,
                              AutomationException

The LOD field name.

Product Availability

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

Specified by:

getLODFieldName in interface IMosaicFunction

Returns:

The pLODFieldName

Throws:

IOException - If there are interop problems.

AutomationException - If the ArcObject component throws an exception.

setLODFieldName

public void setLODFieldName(String pLODFieldName)
                     throws IOException,
                            AutomationException

The LOD field name.

Product Availability

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

Specified by:

setLODFieldName in interface IMosaicFunction

Parameters:

pLODFieldName - The pLODFieldName (in)

Throws:

IOException - If there are interop problems.

AutomationException - If the ArcObject component throws an exception.

getLODInfos

public IMosaicLODInfos getLODInfos()
                            throws IOException,
                                   AutomationException

The current mosaic LOD information.

Product Availability

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

Specified by:

getLODInfos in interface IMosaicFunction

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

public void setLODInfosByRef(IMosaicLODInfos ppLODInfos)
                      throws IOException,
                             AutomationException

The current mosaic LOD information.

Product Availability

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

Specified by:

setLODInfosByRef in interface IMosaicFunction

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

public IPnt getMaximumVisibleCellsize()
                               throws IOException,
                                      AutomationException

The maximum visible cellsize.

Product Availability

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

Specified by:

getMaximumVisibleCellsize in interface IMosaicFunction

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

public void setMaximumVisibleCellsize(IPnt ppCellsize)
                               throws IOException,
                                      AutomationException

The maximum visible cellsize.

Product Availability

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

Specified by:

setMaximumVisibleCellsize in interface IMosaicFunction

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

public boolean isDrawFootprint()
                        throws IOException,
                               AutomationException

Indicates if to draw footprints.

Product Availability

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

Specified by:

isDrawFootprint in interface IMosaicFunction

Returns:

The pDraw

Throws:

IOException - If there are interop problems.

AutomationException - If the ArcObject component throws an exception.

setDrawFootprint

public void setDrawFootprint(boolean pDraw)
                      throws IOException,
                             AutomationException

Indicates if to draw footprints.

Product Availability

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

Specified by:

setDrawFootprint in interface IMosaicFunction

Parameters:

pDraw - The pDraw (in)

Throws:

IOException - If there are interop problems.

AutomationException - If the ArcObject component throws an exception.

getFootprintSymbol

public ISymbol getFootprintSymbol()
                           throws IOException,
                                  AutomationException

The symbol used to draw footprints.

Product Availability

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

Specified by:

getFootprintSymbol in interface IMosaicFunction

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

public void setFootprintSymbolByRef(ISymbol ppSymbol)
                             throws IOException,
                                    AutomationException

The symbol used to draw footprints.

Product Availability

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

Specified by:

setFootprintSymbolByRef in interface IMosaicFunction

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

public int getMosaicMethod()
                    throws IOException,
                           AutomationException

The mosaic method.

Product Availability

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

Specified by:

getMosaicMethod in interface IMosaicFunction

Returns:

A com.esri.arcgis.datasourcesraster.esriMosaicMethod constant

Throws:

IOException - If there are interop problems.

AutomationException - If the ArcObject component throws an exception.

setMosaicMethod

public void setMosaicMethod(int pMosaicMethod)
                     throws IOException,
                            AutomationException

The mosaic method.

Product Availability

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

Specified by:

setMosaicMethod in interface IMosaicFunction

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

public String getOrderByFieldName()
                           throws IOException,
                                  AutomationException

The Order By field on the source catalog.

Product Availability

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

Specified by:

getOrderByFieldName in interface IMosaicFunction

Returns:

The pName

Throws:

IOException - If there are interop problems.

AutomationException - If the ArcObject component throws an exception.

setOrderByFieldName

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

Specified by:

setOrderByFieldName in interface IMosaicFunction

Parameters:

pName - The pName (in)

Throws:

IOException - If there are interop problems.

AutomationException - If the ArcObject component throws an exception.

getOrderByBaseValue

public Object getOrderByBaseValue()
                           throws IOException,
                                  AutomationException

The Order By base value.

Product Availability

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

Specified by:

getOrderByBaseValue in interface IMosaicFunction

Returns:

A Variant

Throws:

IOException - If there are interop problems.

AutomationException - If the ArcObject component throws an exception.

setOrderByBaseValue

public void setOrderByBaseValue(Object pValue)
                         throws IOException,
                                AutomationException

The Order By base value.

Product Availability

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

Specified by:

setOrderByBaseValue in interface IMosaicFunction

Parameters:

pValue - A Variant (in)

Throws:

IOException - If there are interop problems.

AutomationException - If the ArcObject component throws an exception.

getLockRasterFieldName

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

Specified by:

getLockRasterFieldName in interface IMosaicFunction

Returns:

The pLockFieldName

Throws:

IOException - If there are interop problems.

AutomationException - If the ArcObject component throws an exception.

setLockRasterFieldName

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

Specified by:

setLockRasterFieldName in interface IMosaicFunction

Parameters:

pLockFieldName - The pLockFieldName (in)

Throws:

IOException - If there are interop problems.

AutomationException - If the ArcObject component throws an exception.

getLockRasterID

public String getLockRasterID()
                       throws IOException,
                              AutomationException

The lock raster ID.

Product Availability

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

Specified by:

getLockRasterID in interface IMosaicFunction

Returns:

The pRasterID

Throws:

IOException - If there are interop problems.

AutomationException - If the ArcObject component throws an exception.

setLockRasterID

public void setLockRasterID(String pRasterID)
                     throws IOException,
                            AutomationException

The lock raster ID.

Product Availability

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

Specified by:

setLockRasterID in interface IMosaicFunction

Parameters:

pRasterID - The pRasterID (in)

Throws:

IOException - If there are interop problems.

AutomationException - If the ArcObject component throws an exception.

getViewpoint

public IPoint getViewpoint()
                    throws IOException,
                           AutomationException

The view point.

Product Availability

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

Specified by:

getViewpoint in interface IMosaicFunction

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

public void setViewpointByRef(IPoint ppViewpoint)
                       throws IOException,
                              AutomationException

The view point.

Product Availability

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

Specified by:

setViewpointByRef in interface IMosaicFunction

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

public boolean isAscending()
                    throws IOException,
                           AutomationException

Indicates whether the ascending flag of OrderBy.

Product Availability

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

Specified by:

isAscending in interface IMosaicFunction

Returns:

The pAscending

Throws:

IOException - If there are interop problems.

AutomationException - If the ArcObject component throws an exception.

setAscending

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

Specified by:

setAscending in interface IMosaicFunction

Parameters:

pAscending - The pAscending (in)

Throws:

IOException - If there are interop problems.

AutomationException - If the ArcObject component throws an exception.

getMosaicOperatorType

public int getMosaicOperatorType()
                          throws IOException,
                                 AutomationException

The current mosaic operator type.

Product Availability

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

Specified by:

getMosaicOperatorType in interface IMosaicFunction

Returns:

A com.esri.arcgis.datasourcesraster.rstMosaicOperatorType constant

Throws:

IOException - If there are interop problems.

AutomationException - If the ArcObject component throws an exception.

setMosaicOperatorType

public void setMosaicOperatorType(int type)
                           throws IOException,
                                  AutomationException

The current mosaic operator type.

Product Availability

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

Specified by:

setMosaicOperatorType in interface IMosaicFunction

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

public IMosaicOperator getMosaicOperator()
                                  throws IOException,
                                         AutomationException

The current mosaic operator.

Product Availability

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

Specified by:

getMosaicOperator in interface IMosaicFunction

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

public void setMosaicOperatorByRef(IMosaicOperator op)
                            throws IOException,
                                   AutomationException

The current mosaic operator.

Product Availability

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

Specified by:

setMosaicOperatorByRef in interface IMosaicFunction

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

public String getWhereClause()
                      throws IOException,
                             AutomationException

The SQL selection where clause expression.

Product Availability

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

Specified by:

getWhereClause in interface IMosaicFunction

Returns:

The pExpression

Throws:

IOException - If there are interop problems.

AutomationException - If the ArcObject component throws an exception.

setWhereClause

public void setWhereClause(String pExpression)
                    throws IOException,
                           AutomationException

The SQL selection where clause expression.

Product Availability

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

Specified by:

setWhereClause in interface IMosaicFunction

Parameters:

pExpression - The pExpression (in)

Throws:

IOException - If there are interop problems.

AutomationException - If the ArcObject component throws an exception.

setFIDsByRef

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

Specified by:

setFIDsByRef in interface IMosaicFunction

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

public IFIDSet getFIDs()
                throws IOException,
                       AutomationException

The current selection set on the source catalog.

Product Availability

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

Specified by:

getFIDs in interface IMosaicFunction

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

public void lockCellsize(double cellSize)
                  throws IOException,
                         AutomationException

Locks LOD at a given cellsize.

Product Availability

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

Specified by:

lockCellsize in interface IMosaicFunction

Parameters:

cellSize - The cellSize (in)

Throws:

IOException - If there are interop problems.

AutomationException - If the ArcObject component throws an exception.

unlockCellsize

public void unlockCellsize()
                    throws IOException,
                           AutomationException

Unlocks LOD from the locked cellsize.

Product Availability

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

Specified by:

unlockCellsize in interface IMosaicFunction

Throws:

IOException - If there are interop problems.

AutomationException - If the ArcObject component throws an exception.

getCatalog

public ITable getCatalog()
                  throws IOException,
                         AutomationException

The catalog.

Product Availability

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

Specified by:

getCatalog in interface IMosaicFunction

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

public int getRasterFieldIndex()
                        throws IOException,
                               AutomationException

The raster field index.

Product Availability

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

Specified by:

getRasterFieldIndex in interface IMosaicFunction

Returns:

The pRasterFieldIndex

Throws:

IOException - If there are interop problems.

AutomationException - If the ArcObject component throws an exception.

getMinCellsizeFieldIndex

public int getMinCellsizeFieldIndex()
                             throws IOException,
                                    AutomationException

The minimum cellsize field index.

Product Availability

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

Specified by:

getMinCellsizeFieldIndex in interface IMosaicFunction

Returns:

The pMinCellsizeFieldIndex

Throws:

IOException - If there are interop problems.

AutomationException - If the ArcObject component throws an exception.

getMaxCellsizeFieldIndex

public int getMaxCellsizeFieldIndex()
                             throws IOException,
                                    AutomationException

The maximum cellsize field index.

Product Availability

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

Specified by:

getMaxCellsizeFieldIndex in interface IMosaicFunction

Returns:

The pMaxCellsizeFieldIndex

Throws:

IOException - If there are interop problems.

AutomationException - If the ArcObject component throws an exception.

isVisible

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

Specified by:

isVisible in interface IMosaicFunction

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

public int getMaxMosaicImageCount()
                           throws IOException,
                                  AutomationException

The maximum number of rasters used per request.

Product Availability

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

Specified by:

getMaxMosaicImageCount in interface IMosaicFunction

Returns:

The pCount

Throws:

IOException - If there are interop problems.

AutomationException - If the ArcObject component throws an exception.

setMaxMosaicImageCount

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

Specified by:

setMaxMosaicImageCount in interface IMosaicFunction

Parameters:

pCount - The pCount (in)

Throws:

IOException - If there are interop problems.

AutomationException - If the ArcObject component throws an exception.

isClipToFootprint

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

Specified by:

isClipToFootprint in interface IMosaicFunction

Returns:

The pClipping

Throws:

IOException - If there are interop problems.

AutomationException - If the ArcObject component throws an exception.

setClipToFootprint

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

Specified by:

setClipToFootprint in interface IMosaicFunction

Parameters:

pClipping - The pClipping (in)

Throws:

IOException - If there are interop problems.

AutomationException - If the ArcObject component throws an exception.

isApplyColorCorrection

public boolean isApplyColorCorrection()
                               throws IOException,
                                      AutomationException

Indicates if color correction needs to be applied.

Product Availability

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

Specified by:

isApplyColorCorrection in interface IMosaicFunction

Returns:

The pApplyColorCorrection

Throws:

IOException - If there are interop problems.

AutomationException - If the ArcObject component throws an exception.

setApplyColorCorrection

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

Specified by:

setApplyColorCorrection in interface IMosaicFunction

Parameters:

pApplyColorCorrection - The pApplyColorCorrection (in)

Throws:

IOException - If there are interop problems.

AutomationException - If the ArcObject component throws an exception.

constructQueryExpression

public String constructQueryExpression(IPoint pCellsize)
                                throws IOException,
                                       AutomationException

Constructs a query expression (WHERE clause).

Product Availability

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

Specified by:

constructQueryExpression in interface IMosaicFunction

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

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

Specified by:

search in interface IMosaicFunction

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.

getClassID

public void getClassID(GUID[] pClassID)
                throws IOException,
                       AutomationException

getClassID

Description

IPersist is a Microsoft interface. Please refer to MSDN for information about this interface.

Product Availability

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

Supported Platforms

Windows, Solaris, Linux

Specified by:

getClassID in interface IPersist

Parameters:

pClassID - A Structure: com.esri.arcgis.support.ms.stdole.GUID (out: use single element array)

Throws:

IOException - If there are interop problems.

AutomationException - If the ArcObject component throws an exception.

isDirty

public void isDirty()
             throws IOException,
                    AutomationException

isDirty

Description

IPersistStream is a Microsoft interface. Please refer to MSDN for information about this interface.

Product Availability

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

Supported Platforms

Windows, Solaris, Linux

Specified by:

isDirty in interface IPersistStream

Throws:

IOException - If there are interop problems.

AutomationException - If the ArcObject component throws an exception.

load

public void load(IStream pstm)
          throws IOException,
                 AutomationException

load

Description

IPersistStream is a Microsoft interface. Please refer to MSDN for information about this interface.

Product Availability

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

Supported Platforms

Windows, Solaris, Linux

Specified by:

load in interface IPersistStream

Parameters:

pstm - A reference to a com.esri.arcgis.system.IStream (in)

Throws:

IOException - If there are interop problems.

AutomationException - If the ArcObject component throws an exception.

save

public void save(IStream pstm,
                 int fClearDirty)
          throws IOException,
                 AutomationException

save

Description

IPersistStream is a Microsoft interface. Please refer to MSDN for information about this interface.

Product Availability

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

Supported Platforms

Windows, Solaris, Linux

Specified by:

save in interface IPersistStream

Parameters:

pstm - A reference to a com.esri.arcgis.system.IStream (in)

fClearDirty - The fClearDirty (in)

Throws:

IOException - If there are interop problems.

AutomationException - If the ArcObject component throws an exception.

getSizeMax

public void getSizeMax(_ULARGE_INTEGER[] pcbSize)
                throws IOException,
                       AutomationException

getSizeMax

Description

IPersistStream is a Microsoft interface. Please refer to MSDN for information about this interface.

Product Availability

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

Supported Platforms

Windows, Solaris, Linux

Specified by:

getSizeMax in interface IPersistStream

Parameters:

pcbSize - A Structure: com.esri.arcgis.system._ULARGE_INTEGER (out: use single element array)

Throws:

IOException - If there are interop problems.

AutomationException - If the ArcObject component throws an exception.

serialize

public void serialize(IXMLSerializeData data)
               throws IOException,
                      AutomationException

Serializes an object to XML.

Product Availability

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

Supported Platforms

Windows, Solaris, Linux

Specified by:

serialize in interface IXMLSerialize

Parameters:

data - A reference to a com.esri.arcgis.system.IXMLSerializeData (in)

Throws:

IOException - If there are interop problems.

AutomationException - If the ArcObject component throws an exception.

deserialize

public void deserialize(IXMLSerializeData data)
                 throws IOException,
                        AutomationException

Deserializes an object from XML.

Product Availability

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

Supported Platforms

Windows, Solaris, Linux

Specified by:

deserialize in interface IXMLSerialize

Parameters:

data - A reference to a com.esri.arcgis.system.IXMLSerializeData (in)

Throws:

IOException - If there are interop problems.

AutomationException - If the ArcObject component throws an exception.

getMinNamespaceSupported

public String getMinNamespaceSupported()
                                throws IOException,
                                       AutomationException

The minimum namespace the class can serialize to (eg the 90 namespace).

Product Availability

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

Specified by:

getMinNamespaceSupported in interface IXMLVersionSupport

Returns:

The namespaceURI

Throws:

IOException - If there are interop problems.

AutomationException - If the ArcObject component throws an exception.

writeExternal

public void writeExternal(ObjectOutput out)
                   throws IOException

Specified by:

writeExternal in interface Externalizable

Throws:

IOException

readExternal

public void readExternal(ObjectInput in)
                  throws IOException,
                         ClassNotFoundException

Specified by:

readExternal in interface Externalizable

Throws:

IOException

ClassNotFoundException