com.esri.arcgis.datasourcesraster
Class MosaicFunction

java.lang.Object
  extended by com.esri.arcgis.datasourcesraster.MosaicFunction
All Implemented Interfaces:
IMosaicFunction, IMosaicFunction2, IMosaicFunction3, IRasterFunction, com.esri.arcgis.interop.RemoteObjRef, IPersist, IPersistStream, IXMLSerialize, IXMLVersionSupport, java.io.Externalizable, java.io.Serializable

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

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

Description 'A class for a raster mosaic function.' Generator Options: PromptForTypeLibraries = False ClashPrefix = esri_ LowerCaseMemberNames = True IDispatchOnly = False RetryOnReject = False AwtForOcxs = True ArraysAsObjects = False DontRenameSameMethods = False ImplementConflictingInterfaces = True ReuseMethods = True RenameConflictingInterfaceMethods = True GenBeanInfo = True GenerateJavadoc =

See Also:
Serialized Form

Field Summary
static long serialVersionUID
           
 
Fields inherited from interface com.esri.arcgis.datasourcesraster.IRasterFunction
IID, IIDcf7b7f99_3698_4f1f_aff8_e3430e106b1e, xxDummy
 
Fields inherited from interface com.esri.arcgis.datasourcesraster.IMosaicFunction3
IID, IID9a90a3d9_9ed9_4df3_87b1_f1f563928c98, xxDummy
 
Fields inherited from interface com.esri.arcgis.datasourcesraster.IMosaicFunction2
IID9beaef50_906f_4bb9_a693_92c9a63baabc
 
Fields inherited from interface com.esri.arcgis.datasourcesraster.IMosaicFunction
IID2e7a3bb4_76e1_4b84_a359_68233d60450a
 
Fields inherited from interface com.esri.arcgis.system.IPersistStream
IID, IID00000109_0000_0000_c000_000000000046, xxDummy
 
Fields inherited from interface com.esri.arcgis.system.IPersist
IID0000010c_0000_0000_c000_000000000046
 
Fields inherited from interface com.esri.arcgis.system.IXMLSerialize
IID, IIDc8545045_6615_48e3_af27_52a0e5fc35e2, xxDummy
 
Fields inherited from interface com.esri.arcgis.system.IXMLVersionSupport
IID, IID72ca65b9_13de_48b7_8443_717b69b72a99, xxDummy
 
Constructor Summary
MosaicFunction()
          Constructs a MosaicFunction using ArcGIS Engine.
MosaicFunction(java.lang.Object obj)
          Deprecated. As of ArcGIS 9.2, replaced by normal Java casts.
MosaicFunction theMosaicFunction = (MosaicFunction) obj;
 
Method Summary
 void bind(java.lang.Object pArguments)
          Binds function arguments to this raster function.
 java.lang.String constructQueryExpression(IPoint pCellsize)
          Constructs a query expression (WHERE clause).
 void deserialize(IXMLSerializeData data)
          Deserializes an object from XML.
 boolean equals(java.lang.Object o)
          Compare this object with another
 IRaster getBackgroundRaster()
          The background raster.
 int getBlendingWidth()
          The blending width for Blend mosaic operator.
 double getBlendingWidth2()
          The blending width for Blend mosaic operator.
 int getBlendingWidthUnits()
          The units associated with the blending width for Blend mosaic operator.
 ITable getCatalog()
          The catalog.
 java.lang.String getCellsizeFieldName()
          The native raster cellsize field name.
 void getClassID(GUID[] pClassID)
          getClassID
static java.lang.String getClsid()
          getClsid.
 java.lang.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.
 java.lang.String getDescription()
          The raster function description.
 IFIDSet getFIDs()
          The current selection set on the source catalog.
 ISymbol getFootprintSymbol()
          The symbol used to draw footprints.
 com.esri.arcgis.interop.Dispatch getJintegraDispatch()
          Deprecated. Internal use only.
 java.lang.String getLockRasterFieldName()
          The lock raster ID field name in the source catalog.
 java.lang.String getLockRasterID()
          The lock raster ID.
 java.lang.String getLODFieldName()
          The LOD field name.
 IMosaicLODInfos getLODInfos()
          The current mosaic LOD information.
 int getMaxCellsizeFieldIndex()
          The maximum cellsize field index.
 java.lang.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.
 java.lang.String getMinCellsizeFieldName()
          The minimum cellsize field name.
 java.lang.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.
 java.lang.String getName()
          The raster function name.
 java.lang.Object getOrderByBaseValue()
          The Order By base value.
 java.lang.String getOrderByFieldName()
          The Order By field on the source catalog.
 int getPixelType()
          The output pixel type.
 int getRasterFieldIndex()
          The raster field index.
 java.lang.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.
 java.lang.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 isClipToBoundary()
          Indicates if the mosaic dataset will be clipped to its boundary.
 boolean isClipToFootprint()
          Indicates if individual images will be clipped to their footprints.
 void isDirty()
          isDirty
 boolean isDrawFootprint()
          Indicates if to draw footprints.
 boolean isFootprintMayContainNoData()
          Indicates whether the footprint geometry associated with each raster may contain NoData pixels.
 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(java.io.ObjectInput in)
           
 void release()
          Release a MosaicFunction.
 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 setBackgroundRasterByRef(IRaster ppRaster)
          The background raster.
 void setBlendingWidth(int pWidth)
          The blending width for Blend mosaic operator.
 void setBlendingWidth2(double pWidth)
          The blending width for Blend mosaic operator.
 void setBlendingWidthUnits(int units)
          The units associated with the blending width for Blend mosaic operator.
 void setCellsizeFieldName(java.lang.String pCellsizeFieldName)
          The native raster cellsize field name.
 void setClipToBoundary(boolean pClipping)
          Indicates if the mosaic dataset will be clipped to its boundary.
 void setClipToFootprint(boolean pClipping)
          Indicates if individual images will be clipped to their footprints.
 void setDefinitionExpression(java.lang.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(java.lang.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 setFootprintMayContainNoData(boolean pbFootprintMayContainNoData)
          Indicates whether the footprint geometry associated with each raster may contain NoData pixels.
 void setFootprintSymbolByRef(ISymbol ppSymbol)
          The symbol used to draw footprints.
 void setLockRasterFieldName(java.lang.String pLockFieldName)
          The lock raster ID field name in the source catalog.
 void setLockRasterID(java.lang.String pRasterID)
          The lock raster ID.
 void setLODFieldName(java.lang.String pLODFieldName)
          The LOD field name.
 void setLODInfosByRef(IMosaicLODInfos ppLODInfos)
          The current mosaic LOD information.
 void setMaxCellsizeFieldName(java.lang.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(java.lang.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(java.lang.String pName)
          The raster function name.
 void setOrderByBaseValue(java.lang.Object pValue)
          The Order By base value.
 void setOrderByFieldName(java.lang.String pName)
          The Order By field on the source catalog.
 void setPixelType(int pPixelType)
          The output pixel type.
 void setRasterFieldName(java.lang.String pRasterFieldName)
          The raster field name in the source catalog.
 void setViewpointByRef(IPoint ppViewpoint)
          The view point.
 void setWhereClause(java.lang.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(java.io.ObjectOutput out)
           
 
Methods inherited from class java.lang.Object
clone, finalize, getClass, notify, notifyAll, toString, wait, wait, wait
 

Field Detail

serialVersionUID

public static final long serialVersionUID
See Also:
Constant Field Values
Constructor Detail

MosaicFunction

public MosaicFunction()
               throws java.io.IOException,
                      java.net.UnknownHostException
Constructs a MosaicFunction using ArcGIS Engine.

Throws:
java.io.IOException - if there are interop problems
java.net.UnknownHostException - if there are interop problems

MosaicFunction

public MosaicFunction(java.lang.Object obj)
               throws java.io.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:
java.io.IOException - if there are interop problems
Method Detail

getClsid

public static java.lang.String getClsid()
getClsid.


equals

public boolean equals(java.lang.Object o)
Compare this object with another

Overrides:
equals in class java.lang.Object

hashCode

public int hashCode()
the hashcode for this object

Overrides:
hashCode in class java.lang.Object

getJintegraDispatch

public com.esri.arcgis.interop.Dispatch getJintegraDispatch()
Deprecated. Internal use only.

Specified by:
getJintegraDispatch in interface com.esri.arcgis.interop.RemoteObjRef

release

public void release()
Release a MosaicFunction.

Specified by:
release in interface com.esri.arcgis.interop.RemoteObjRef

getName

public java.lang.String getName()
                         throws java.io.IOException,
                                AutomationException
The raster function name.

Specified by:
getName in interface IRasterFunction
Returns:
The pName
Throws:
java.io.IOException - If there are interop problems.
AutomationException - If the ArcObject component throws an exception.

setName

public void setName(java.lang.String pName)
             throws java.io.IOException,
                    AutomationException
The raster function name.

Specified by:
setName in interface IRasterFunction
Parameters:
pName - The pName (in)
Throws:
java.io.IOException - If there are interop problems.
AutomationException - If the ArcObject component throws an exception.

getDescription

public java.lang.String getDescription()
                                throws java.io.IOException,
                                       AutomationException
The raster function description.

Specified by:
getDescription in interface IRasterFunction
Returns:
The pDescription
Throws:
java.io.IOException - If there are interop problems.
AutomationException - If the ArcObject component throws an exception.

setDescription

public void setDescription(java.lang.String pDescription)
                    throws java.io.IOException,
                           AutomationException
The raster function description.

Specified by:
setDescription in interface IRasterFunction
Parameters:
pDescription - The pDescription (in)
Throws:
java.io.IOException - If there are interop problems.
AutomationException - If the ArcObject component throws an exception.

getPixelType

public int getPixelType()
                 throws java.io.IOException,
                        AutomationException
The output pixel type.

Specified by:
getPixelType in interface IRasterFunction
Returns:
A com.esri.arcgis.geodatabase.rstPixelType constant
Throws:
java.io.IOException - If there are interop problems.
AutomationException - If the ArcObject component throws an exception.

setPixelType

public void setPixelType(int pPixelType)
                  throws java.io.IOException,
                         AutomationException
The output pixel type.

Specified by:
setPixelType in interface IRasterFunction
Parameters:
pPixelType - A com.esri.arcgis.geodatabase.rstPixelType constant (in)
Throws:
java.io.IOException - If there are interop problems.
AutomationException - If the ArcObject component throws an exception.

bind

public void bind(java.lang.Object pArguments)
          throws java.io.IOException,
                 AutomationException
Binds function arguments to this raster function.

Specified by:
bind in interface IRasterFunction
Parameters:
pArguments - A reference to another Object (IUnknown) (in)
Throws:
java.io.IOException - If there are interop problems.
AutomationException - If the ArcObject component throws an exception.

isValid

public boolean isValid()
                throws java.io.IOException,
                       AutomationException
Indicates if this function is valid, e.g. bound to an object, and etc.

Specified by:
isValid in interface IRasterFunction
Returns:
The pValid
Throws:
java.io.IOException - If there are interop problems.
AutomationException - If the ArcObject component throws an exception.

update

public void update()
            throws java.io.IOException,
                   AutomationException
Updates using newly available information from bound object.

Specified by:
update in interface IRasterFunction
Throws:
java.io.IOException - If there are interop problems.
AutomationException - If the ArcObject component throws an exception.

getRasterInfo

public IRasterInfo getRasterInfo()
                          throws java.io.IOException,
                                 AutomationException
The raster information after this function is applied to an object.

Specified by:
getRasterInfo in interface IRasterFunction
Returns:
A reference to a com.esri.arcgis.datasourcesraster.IRasterInfo
Throws:
java.io.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 java.io.IOException,
                 AutomationException
Reads a pixel block starting from the top left corner.

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:
java.io.IOException - If there are interop problems.
AutomationException - If the ArcObject component throws an exception.

getDefinitionExpression

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

Specified by:
getDefinitionExpression in interface IMosaicFunction
Returns:
The pExpression
Throws:
java.io.IOException - If there are interop problems.
AutomationException - If the ArcObject component throws an exception.

setDefinitionExpression

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

Specified by:
setDefinitionExpression in interface IMosaicFunction
Parameters:
pExpression - The pExpression (in)
Throws:
java.io.IOException - If there are interop problems.
AutomationException - If the ArcObject component throws an exception.

getDefinitionGeometry

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

Specified by:
getDefinitionGeometry in interface IMosaicFunction
Returns:
A reference to a com.esri.arcgis.geometry.IGeometry
Throws:
java.io.IOException - If there are interop problems.
AutomationException - If the ArcObject component throws an exception.

setDefinitionGeometryByRef

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

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

setDefinitionFIDsByRef

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

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

getDefinitionFIDs

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

Specified by:
getDefinitionFIDs in interface IMosaicFunction
Returns:
A reference to a com.esri.arcgis.geodatabase.IFIDSet
Throws:
java.io.IOException - If there are interop problems.
AutomationException - If the ArcObject component throws an exception.

getRasterFieldName

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

Specified by:
getRasterFieldName in interface IMosaicFunction
Returns:
The pRasterFieldName
Throws:
java.io.IOException - If there are interop problems.
AutomationException - If the ArcObject component throws an exception.

setRasterFieldName

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

Specified by:
setRasterFieldName in interface IMosaicFunction
Parameters:
pRasterFieldName - The pRasterFieldName (in)
Throws:
java.io.IOException - If there are interop problems.
AutomationException - If the ArcObject component throws an exception.

getCellsizeFieldName

public java.lang.String getCellsizeFieldName()
                                      throws java.io.IOException,
                                             AutomationException
The native raster cellsize field name.

Specified by:
getCellsizeFieldName in interface IMosaicFunction
Returns:
The pCellsizeFieldName
Throws:
java.io.IOException - If there are interop problems.
AutomationException - If the ArcObject component throws an exception.

setCellsizeFieldName

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

Specified by:
setCellsizeFieldName in interface IMosaicFunction
Parameters:
pCellsizeFieldName - The pCellsizeFieldName (in)
Throws:
java.io.IOException - If there are interop problems.
AutomationException - If the ArcObject component throws an exception.

getMinCellsizeFieldName

public java.lang.String getMinCellsizeFieldName()
                                         throws java.io.IOException,
                                                AutomationException
The minimum cellsize field name.

Specified by:
getMinCellsizeFieldName in interface IMosaicFunction
Returns:
The pMinCellsizeFieldName
Throws:
java.io.IOException - If there are interop problems.
AutomationException - If the ArcObject component throws an exception.

setMinCellsizeFieldName

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

Specified by:
setMinCellsizeFieldName in interface IMosaicFunction
Parameters:
pMinCellsizeFieldName - The pMinCellsizeFieldName (in)
Throws:
java.io.IOException - If there are interop problems.
AutomationException - If the ArcObject component throws an exception.

getMaxCellsizeFieldName

public java.lang.String getMaxCellsizeFieldName()
                                         throws java.io.IOException,
                                                AutomationException
The maximum cellsize field name.

Specified by:
getMaxCellsizeFieldName in interface IMosaicFunction
Returns:
The pMaxCellsizeFieldName
Throws:
java.io.IOException - If there are interop problems.
AutomationException - If the ArcObject component throws an exception.

setMaxCellsizeFieldName

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

Specified by:
setMaxCellsizeFieldName in interface IMosaicFunction
Parameters:
pMaxCellsizeFieldName - The pMaxCellsizeFieldName (in)
Throws:
java.io.IOException - If there are interop problems.
AutomationException - If the ArcObject component throws an exception.

getLODFieldName

public java.lang.String getLODFieldName()
                                 throws java.io.IOException,
                                        AutomationException
The LOD field name.

Specified by:
getLODFieldName in interface IMosaicFunction
Returns:
The pLODFieldName
Throws:
java.io.IOException - If there are interop problems.
AutomationException - If the ArcObject component throws an exception.

setLODFieldName

public void setLODFieldName(java.lang.String pLODFieldName)
                     throws java.io.IOException,
                            AutomationException
The LOD field name.

Specified by:
setLODFieldName in interface IMosaicFunction
Parameters:
pLODFieldName - The pLODFieldName (in)
Throws:
java.io.IOException - If there are interop problems.
AutomationException - If the ArcObject component throws an exception.

getLODInfos

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

Specified by:
getLODInfos in interface IMosaicFunction
Returns:
A reference to a com.esri.arcgis.datasourcesraster.IMosaicLODInfos
Throws:
java.io.IOException - If there are interop problems.
AutomationException - If the ArcObject component throws an exception.

setLODInfosByRef

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

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

getMaximumVisibleCellsize

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

Specified by:
getMaximumVisibleCellsize in interface IMosaicFunction
Returns:
A reference to a com.esri.arcgis.geodatabase.IPnt
Throws:
java.io.IOException - If there are interop problems.
AutomationException - If the ArcObject component throws an exception.

setMaximumVisibleCellsize

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

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

isDrawFootprint

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

Specified by:
isDrawFootprint in interface IMosaicFunction
Returns:
The pDraw
Throws:
java.io.IOException - If there are interop problems.
AutomationException - If the ArcObject component throws an exception.

setDrawFootprint

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

Specified by:
setDrawFootprint in interface IMosaicFunction
Parameters:
pDraw - The pDraw (in)
Throws:
java.io.IOException - If there are interop problems.
AutomationException - If the ArcObject component throws an exception.

getFootprintSymbol

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

Specified by:
getFootprintSymbol in interface IMosaicFunction
Returns:
A reference to a com.esri.arcgis.display.ISymbol
Throws:
java.io.IOException - If there are interop problems.
AutomationException - If the ArcObject component throws an exception.

setFootprintSymbolByRef

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

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

getMosaicMethod

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

Specified by:
getMosaicMethod in interface IMosaicFunction
Returns:
A com.esri.arcgis.datasourcesraster.esriMosaicMethod constant
Throws:
java.io.IOException - If there are interop problems.
AutomationException - If the ArcObject component throws an exception.

setMosaicMethod

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

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

getOrderByFieldName

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

Specified by:
getOrderByFieldName in interface IMosaicFunction
Returns:
The pName
Throws:
java.io.IOException - If there are interop problems.
AutomationException - If the ArcObject component throws an exception.

setOrderByFieldName

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

Specified by:
setOrderByFieldName in interface IMosaicFunction
Parameters:
pName - The pName (in)
Throws:
java.io.IOException - If there are interop problems.
AutomationException - If the ArcObject component throws an exception.

getOrderByBaseValue

public java.lang.Object getOrderByBaseValue()
                                     throws java.io.IOException,
                                            AutomationException
The Order By base value.

Specified by:
getOrderByBaseValue in interface IMosaicFunction
Returns:
A Variant
Throws:
java.io.IOException - If there are interop problems.
AutomationException - If the ArcObject component throws an exception.

setOrderByBaseValue

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

Specified by:
setOrderByBaseValue in interface IMosaicFunction
Parameters:
pValue - A Variant (in)
Throws:
java.io.IOException - If there are interop problems.
AutomationException - If the ArcObject component throws an exception.

getLockRasterFieldName

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

Specified by:
getLockRasterFieldName in interface IMosaicFunction
Returns:
The pLockFieldName
Throws:
java.io.IOException - If there are interop problems.
AutomationException - If the ArcObject component throws an exception.

setLockRasterFieldName

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

Specified by:
setLockRasterFieldName in interface IMosaicFunction
Parameters:
pLockFieldName - The pLockFieldName (in)
Throws:
java.io.IOException - If there are interop problems.
AutomationException - If the ArcObject component throws an exception.

getLockRasterID

public java.lang.String getLockRasterID()
                                 throws java.io.IOException,
                                        AutomationException
The lock raster ID.

Specified by:
getLockRasterID in interface IMosaicFunction
Returns:
The pRasterID
Throws:
java.io.IOException - If there are interop problems.
AutomationException - If the ArcObject component throws an exception.

setLockRasterID

public void setLockRasterID(java.lang.String pRasterID)
                     throws java.io.IOException,
                            AutomationException
The lock raster ID.

Specified by:
setLockRasterID in interface IMosaicFunction
Parameters:
pRasterID - The pRasterID (in)
Throws:
java.io.IOException - If there are interop problems.
AutomationException - If the ArcObject component throws an exception.

getViewpoint

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

Specified by:
getViewpoint in interface IMosaicFunction
Returns:
A reference to a com.esri.arcgis.geometry.IPoint
Throws:
java.io.IOException - If there are interop problems.
AutomationException - If the ArcObject component throws an exception.

setViewpointByRef

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

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

isAscending

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

Specified by:
isAscending in interface IMosaicFunction
Returns:
The pAscending
Throws:
java.io.IOException - If there are interop problems.
AutomationException - If the ArcObject component throws an exception.

setAscending

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

Specified by:
setAscending in interface IMosaicFunction
Parameters:
pAscending - The pAscending (in)
Throws:
java.io.IOException - If there are interop problems.
AutomationException - If the ArcObject component throws an exception.

getMosaicOperatorType

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

Specified by:
getMosaicOperatorType in interface IMosaicFunction
Returns:
A com.esri.arcgis.datasourcesraster.rstMosaicOperatorType constant
Throws:
java.io.IOException - If there are interop problems.
AutomationException - If the ArcObject component throws an exception.

setMosaicOperatorType

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

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

getMosaicOperator

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

Specified by:
getMosaicOperator in interface IMosaicFunction
Returns:
A reference to a com.esri.arcgis.datasourcesraster.IMosaicOperator
Throws:
java.io.IOException - If there are interop problems.
AutomationException - If the ArcObject component throws an exception.

setMosaicOperatorByRef

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

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

getWhereClause

public java.lang.String getWhereClause()
                                throws java.io.IOException,
                                       AutomationException
The SQL selection where clause expression.

Specified by:
getWhereClause in interface IMosaicFunction
Returns:
The pExpression
Throws:
java.io.IOException - If there are interop problems.
AutomationException - If the ArcObject component throws an exception.

setWhereClause

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

Specified by:
setWhereClause in interface IMosaicFunction
Parameters:
pExpression - The pExpression (in)
Throws:
java.io.IOException - If there are interop problems.
AutomationException - If the ArcObject component throws an exception.

setFIDsByRef

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

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

getFIDs

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

Specified by:
getFIDs in interface IMosaicFunction
Returns:
A reference to a com.esri.arcgis.geodatabase.IFIDSet
Throws:
java.io.IOException - If there are interop problems.
AutomationException - If the ArcObject component throws an exception.

lockCellsize

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

Specified by:
lockCellsize in interface IMosaicFunction
Parameters:
cellSize - The cellSize (in)
Throws:
java.io.IOException - If there are interop problems.
AutomationException - If the ArcObject component throws an exception.

unlockCellsize

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

Specified by:
unlockCellsize in interface IMosaicFunction
Throws:
java.io.IOException - If there are interop problems.
AutomationException - If the ArcObject component throws an exception.

getCatalog

public ITable getCatalog()
                  throws java.io.IOException,
                         AutomationException
The catalog.

Specified by:
getCatalog in interface IMosaicFunction
Returns:
A reference to a com.esri.arcgis.geodatabase.ITable
Throws:
java.io.IOException - If there are interop problems.
AutomationException - If the ArcObject component throws an exception.

getRasterFieldIndex

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

Specified by:
getRasterFieldIndex in interface IMosaicFunction
Returns:
The pRasterFieldIndex
Throws:
java.io.IOException - If there are interop problems.
AutomationException - If the ArcObject component throws an exception.

getMinCellsizeFieldIndex

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

Specified by:
getMinCellsizeFieldIndex in interface IMosaicFunction
Returns:
The pMinCellsizeFieldIndex
Throws:
java.io.IOException - If there are interop problems.
AutomationException - If the ArcObject component throws an exception.

getMaxCellsizeFieldIndex

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

Specified by:
getMaxCellsizeFieldIndex in interface IMosaicFunction
Returns:
The pMaxCellsizeFieldIndex
Throws:
java.io.IOException - If there are interop problems.
AutomationException - If the ArcObject component throws an exception.

isVisible

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

Specified by:
isVisible in interface IMosaicFunction
Parameters:
dx - The dx (in)
dy - The dy (in)
Returns:
The pvbVisible
Throws:
java.io.IOException - If there are interop problems.
AutomationException - If the ArcObject component throws an exception.

getMaxMosaicImageCount

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

Specified by:
getMaxMosaicImageCount in interface IMosaicFunction
Returns:
The pCount
Throws:
java.io.IOException - If there are interop problems.
AutomationException - If the ArcObject component throws an exception.

setMaxMosaicImageCount

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

Specified by:
setMaxMosaicImageCount in interface IMosaicFunction
Parameters:
pCount - The pCount (in)
Throws:
java.io.IOException - If there are interop problems.
AutomationException - If the ArcObject component throws an exception.

isClipToFootprint

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

Specified by:
isClipToFootprint in interface IMosaicFunction
Returns:
The pClipping
Throws:
java.io.IOException - If there are interop problems.
AutomationException - If the ArcObject component throws an exception.

setClipToFootprint

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

Specified by:
setClipToFootprint in interface IMosaicFunction
Parameters:
pClipping - The pClipping (in)
Throws:
java.io.IOException - If there are interop problems.
AutomationException - If the ArcObject component throws an exception.

isApplyColorCorrection

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

Specified by:
isApplyColorCorrection in interface IMosaicFunction
Returns:
The pApplyColorCorrection
Throws:
java.io.IOException - If there are interop problems.
AutomationException - If the ArcObject component throws an exception.

setApplyColorCorrection

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

Specified by:
setApplyColorCorrection in interface IMosaicFunction
Parameters:
pApplyColorCorrection - The pApplyColorCorrection (in)
Throws:
java.io.IOException - If there are interop problems.
AutomationException - If the ArcObject component throws an exception.

constructQueryExpression

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

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

search

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

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:
java.io.IOException - If there are interop problems.
AutomationException - If the ArcObject component throws an exception.

isClipToBoundary

public boolean isClipToBoundary()
                         throws java.io.IOException,
                                AutomationException
Indicates if the mosaic dataset will be clipped to its boundary.

Specified by:
isClipToBoundary in interface IMosaicFunction2
Returns:
The pClipping
Throws:
java.io.IOException - If there are interop problems.
AutomationException - If the ArcObject component throws an exception.

setClipToBoundary

public void setClipToBoundary(boolean pClipping)
                       throws java.io.IOException,
                              AutomationException
Indicates if the mosaic dataset will be clipped to its boundary.

Specified by:
setClipToBoundary in interface IMosaicFunction2
Parameters:
pClipping - The pClipping (in)
Throws:
java.io.IOException - If there are interop problems.
AutomationException - If the ArcObject component throws an exception.

getBackgroundRaster

public IRaster getBackgroundRaster()
                            throws java.io.IOException,
                                   AutomationException
The background raster.

Specified by:
getBackgroundRaster in interface IMosaicFunction2
Returns:
A reference to a com.esri.arcgis.geodatabase.IRaster
Throws:
java.io.IOException - If there are interop problems.
AutomationException - If the ArcObject component throws an exception.

setBackgroundRasterByRef

public void setBackgroundRasterByRef(IRaster ppRaster)
                              throws java.io.IOException,
                                     AutomationException
The background raster.

Specified by:
setBackgroundRasterByRef in interface IMosaicFunction2
Parameters:
ppRaster - A reference to a com.esri.arcgis.geodatabase.IRaster (in)
Throws:
java.io.IOException - If there are interop problems.
AutomationException - If the ArcObject component throws an exception.

getBlendingWidth

public int getBlendingWidth()
                     throws java.io.IOException,
                            AutomationException
The blending width for Blend mosaic operator.

Specified by:
getBlendingWidth in interface IMosaicFunction2
Returns:
The pWidth
Throws:
java.io.IOException - If there are interop problems.
AutomationException - If the ArcObject component throws an exception.

setBlendingWidth

public void setBlendingWidth(int pWidth)
                      throws java.io.IOException,
                             AutomationException
The blending width for Blend mosaic operator.

Specified by:
setBlendingWidth in interface IMosaicFunction2
Parameters:
pWidth - The pWidth (in)
Throws:
java.io.IOException - If there are interop problems.
AutomationException - If the ArcObject component throws an exception.

isFootprintMayContainNoData

public boolean isFootprintMayContainNoData()
                                    throws java.io.IOException,
                                           AutomationException
Indicates whether the footprint geometry associated with each raster may contain NoData pixels. Setting this property to false while clipping to fooptrint enables the system to assume that only valid pixels exist within a raster's footprint towards optimizing ?G?^??

Specified by:
isFootprintMayContainNoData in interface IMosaicFunction2
Returns:
The pbFootprintMayContainNoData
Throws:
java.io.IOException - If there are interop problems.
AutomationException - If the ArcObject component throws an exception.

setFootprintMayContainNoData

public void setFootprintMayContainNoData(boolean pbFootprintMayContainNoData)
                                  throws java.io.IOException,
                                         AutomationException
Indicates whether the footprint geometry associated with each raster may contain NoData pixels. Setting this property to false while clipping to fooptrint enables the system to assume that only valid pixels exist within a raster's footprint towards optimizing ?G?^??

Specified by:
setFootprintMayContainNoData in interface IMosaicFunction2
Parameters:
pbFootprintMayContainNoData - The pbFootprintMayContainNoData (in)
Throws:
java.io.IOException - If there are interop problems.
AutomationException - If the ArcObject component throws an exception.

getBlendingWidth2

public double getBlendingWidth2()
                         throws java.io.IOException,
                                AutomationException
The blending width for Blend mosaic operator.

Specified by:
getBlendingWidth2 in interface IMosaicFunction3
Returns:
The pWidth
Throws:
java.io.IOException - If there are interop problems.
AutomationException - If the ArcObject component throws an exception.

setBlendingWidth2

public void setBlendingWidth2(double pWidth)
                       throws java.io.IOException,
                              AutomationException
The blending width for Blend mosaic operator.

Specified by:
setBlendingWidth2 in interface IMosaicFunction3
Parameters:
pWidth - The pWidth (in)
Throws:
java.io.IOException - If there are interop problems.
AutomationException - If the ArcObject component throws an exception.

getBlendingWidthUnits

public int getBlendingWidthUnits()
                          throws java.io.IOException,
                                 AutomationException
The units associated with the blending width for Blend mosaic operator.

Specified by:
getBlendingWidthUnits in interface IMosaicFunction3
Returns:
A com.esri.arcgis.datasourcesraster.esriBlendWidthUnits constant
Throws:
java.io.IOException - If there are interop problems.
AutomationException - If the ArcObject component throws an exception.

setBlendingWidthUnits

public void setBlendingWidthUnits(int units)
                           throws java.io.IOException,
                                  AutomationException
The units associated with the blending width for Blend mosaic operator.

Specified by:
setBlendingWidthUnits in interface IMosaicFunction3
Parameters:
units - A com.esri.arcgis.datasourcesraster.esriBlendWidthUnits constant (in)
Throws:
java.io.IOException - If there are interop problems.
AutomationException - If the ArcObject component throws an exception.

getClassID

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

Specified by:
getClassID in interface IPersist
Parameters:
pClassID - A Structure: com.esri.arcgis.support.ms.stdole.GUID (out: use single element array)
Throws:
java.io.IOException - If there are interop problems.
AutomationException - If the ArcObject component throws an exception.

isDirty

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

Specified by:
isDirty in interface IPersistStream
Throws:
java.io.IOException - If there are interop problems.
AutomationException - If the ArcObject component throws an exception.

load

public void load(IStream pstm)
          throws java.io.IOException,
                 AutomationException
load

Specified by:
load in interface IPersistStream
Parameters:
pstm - A reference to a com.esri.arcgis.system.IStream (in)
Throws:
java.io.IOException - If there are interop problems.
AutomationException - If the ArcObject component throws an exception.

save

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

Specified by:
save in interface IPersistStream
Parameters:
pstm - A reference to a com.esri.arcgis.system.IStream (in)
fClearDirty - The fClearDirty (in)
Throws:
java.io.IOException - If there are interop problems.
AutomationException - If the ArcObject component throws an exception.

getSizeMax

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

Specified by:
getSizeMax in interface IPersistStream
Parameters:
pcbSize - A Structure: com.esri.arcgis.system._ULARGE_INTEGER (out: use single element array)
Throws:
java.io.IOException - If there are interop problems.
AutomationException - If the ArcObject component throws an exception.

serialize

public void serialize(IXMLSerializeData data)
               throws java.io.IOException,
                      AutomationException
Serializes an object to XML.

Specified by:
serialize in interface IXMLSerialize
Parameters:
data - A reference to a com.esri.arcgis.system.IXMLSerializeData (in)
Throws:
java.io.IOException - If there are interop problems.
AutomationException - If the ArcObject component throws an exception.

deserialize

public void deserialize(IXMLSerializeData data)
                 throws java.io.IOException,
                        AutomationException
Deserializes an object from XML.

Specified by:
deserialize in interface IXMLSerialize
Parameters:
data - A reference to a com.esri.arcgis.system.IXMLSerializeData (in)
Throws:
java.io.IOException - If there are interop problems.
AutomationException - If the ArcObject component throws an exception.

getMinNamespaceSupported

public java.lang.String getMinNamespaceSupported()
                                          throws java.io.IOException,
                                                 AutomationException
The minimum namespace the class can serialize to (eg the 90 namespace).

Specified by:
getMinNamespaceSupported in interface IXMLVersionSupport
Returns:
The namespaceURI
Throws:
java.io.IOException - If there are interop problems.
AutomationException - If the ArcObject component throws an exception.

writeExternal

public void writeExternal(java.io.ObjectOutput out)
                   throws java.io.IOException
Specified by:
writeExternal in interface java.io.Externalizable
Throws:
java.io.IOException

readExternal

public void readExternal(java.io.ObjectInput in)
                  throws java.io.IOException,
                         java.lang.ClassNotFoundException
Specified by:
readExternal in interface java.io.Externalizable
Throws:
java.io.IOException
java.lang.ClassNotFoundException