com.esri.arcgis.datasourcesraster
Class MosaicFunctionArguments

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

All Implemented Interfaces:

IMosaicFunctionArguments, IMosaicFunctionArguments2, IRasterFunctionArguments, com.esri.arcgis.interop.RemoteObjRef, IPersist, IPersistStream, IXMLSerialize, IXMLVersionSupport, Externalizable, Serializable

public class MosaicFunctionArguments
extends Object
implements com.esri.arcgis.interop.RemoteObjRef, IRasterFunctionArguments, IMosaicFunctionArguments, IMosaicFunctionArguments2, IPersist, IPersistStream, IXMLSerialize, IXMLVersionSupport, Externalizable

A class for raster mosaic function arguments.

Product Availability

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

See Also:

Serialized Form

Constructor Summary

MosaicFunctionArguments()
Constructs a MosaicFunctionArguments using ArcGIS Engine.

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

Method Summary

void	deserialize(IXMLSerializeData data) Deserializes an object from XML.
boolean	equals(Object o) Compare this object with another
Object	getBoundary() The mosaic boundary.
Object	getCatalog() The source catalog.
double	getCellSizeTolerance() The cellsize tolerance for sorting on cellsize.
void	getClassID(GUID[] pClassID) getClassID
static String	getClsid() getClsid.
Object	getDodgingTable() The color mapping information for color correction.
IStringArray	getFileList() The list of all files associated with the arguments.
String	getMinNamespaceSupported() The minimum namespace the class can serialize to (eg the 90 namespace).
IStringArray	getNames() The list of all argument names.
IRasterInfo	getRasterInfo() The raster info.
Object	getSeamline() The mosaic seamline table.
void	getSizeMax(_ULARGE_INTEGER[] pcbSize) getSizeMax
Object	getStereoTable() The stereo pair table.
Object	getValue(String name) Gets a named argument value.
IVariantArray	getValues() The list of all arguments.
int	hashCode() the hashcode for this object
void	isDirty() isDirty
void	load(IStream pstm) load
void	putValue(String name, Object value) Puts a named argument value.
void	readExternal(ObjectInput in)
void	remove(String name) Removes a named argument value.
void	removeAll() Removes all argument values.
void	resolve(IRow pRow, IPropertySet pPropertySet) Resolves function variables using a row and set of properties.
void	save(IStream pstm, int fClearDirty) save
void	serialize(IXMLSerializeData data) Serializes an object to XML.
void	setBoundaryByRef(Object ppBoundary) The mosaic boundary.
void	setCatalogByRef(Object ppCatalog) The source catalog.
void	setCellSizeTolerance(double pCellSizeTolerance) The cellsize tolerance for sorting on cellsize.
void	setDodgingTableByRef(Object ppDodgingTable) The color mapping information for color correction.
void	setRasterInfoByRef(IRasterInfo ppRasterInfo) The raster info.
void	setSeamlineByRef(Object ppSeamline) The mosaic seamline table.
void	setStereoTableByRef(Object ppStereoTable) The stereo pair table.
void	update(IRow pRow, IPropertySet pPropertySet, IRasterFunctionArguments pTemplateArguments) Updates function variables using a row and set of properties.
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

MosaicFunctionArguments

public MosaicFunctionArguments()
                        throws IOException,
                               UnknownHostException

Constructs a MosaicFunctionArguments using ArcGIS Engine.

Throws:

IOException - if there are interop problems

UnknownHostException - if there are interop problems

MosaicFunctionArguments

public MosaicFunctionArguments(Object obj)
                        throws IOException

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

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

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

getValue

public Object getValue(String name)
                throws IOException,
                       AutomationException

Gets a named argument value.

Product Availability

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

Specified by:

getValue in interface IRasterFunctionArguments

Parameters:

name - The name (in)

Returns:

A Variant

Throws:

IOException - If there are interop problems.

AutomationException - If the ArcObject component throws an exception.

putValue

public void putValue(String name,
                     Object value)
              throws IOException,
                     AutomationException

Puts a named argument value.

Product Availability

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

Specified by:

putValue in interface IRasterFunctionArguments

Parameters:

name - The name (in)

value - A Variant (in)

Throws:

IOException - If there are interop problems.

AutomationException - If the ArcObject component throws an exception.

remove

public void remove(String name)
            throws IOException,
                   AutomationException

Removes a named argument value.

Product Availability

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

Specified by:

remove in interface IRasterFunctionArguments

Parameters:

name - The name (in)

Throws:

IOException - If there are interop problems.

AutomationException - If the ArcObject component throws an exception.

removeAll

public void removeAll()
               throws IOException,
                      AutomationException

Removes all argument values.

Product Availability

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

Specified by:

removeAll in interface IRasterFunctionArguments

Throws:

IOException - If there are interop problems.

AutomationException - If the ArcObject component throws an exception.

getNames

public IStringArray getNames()
                      throws IOException,
                             AutomationException

The list of all argument names.

Product Availability

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

Specified by:

getNames in interface IRasterFunctionArguments

Returns:

A reference to a com.esri.arcgis.system.IStringArray

Throws:

IOException - If there are interop problems.

AutomationException - If the ArcObject component throws an exception.

getValues

public IVariantArray getValues()
                        throws IOException,
                               AutomationException

The list of all arguments.

Product Availability

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

Specified by:

getValues in interface IRasterFunctionArguments

Returns:

A reference to a com.esri.arcgis.system.IVariantArray

Throws:

IOException - If there are interop problems.

AutomationException - If the ArcObject component throws an exception.

getFileList

public IStringArray getFileList()
                         throws IOException,
                                AutomationException

The list of all files associated with the arguments.

Product Availability

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

Specified by:

getFileList in interface IRasterFunctionArguments

Returns:

A reference to a com.esri.arcgis.system.IStringArray

Throws:

IOException - If there are interop problems.

AutomationException - If the ArcObject component throws an exception.

resolve

public void resolve(IRow pRow,
                    IPropertySet pPropertySet)
             throws IOException,
                    AutomationException

Resolves function variables using a row and set of properties.

Product Availability

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

Specified by:

resolve in interface IRasterFunctionArguments

Parameters:

pRow - A reference to a com.esri.arcgis.geodatabase.IRow (in)

pPropertySet - A reference to a com.esri.arcgis.system.IPropertySet (in)

Throws:

IOException - If there are interop problems.

AutomationException - If the ArcObject component throws an exception.

update

public void update(IRow pRow,
                   IPropertySet pPropertySet,
                   IRasterFunctionArguments pTemplateArguments)
            throws IOException,
                   AutomationException

Updates function variables using a row and set of properties.

Product Availability

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

Specified by:

update in interface IRasterFunctionArguments

Parameters:

pRow - A reference to a com.esri.arcgis.geodatabase.IRow (in)

pPropertySet - A reference to a com.esri.arcgis.system.IPropertySet (in)

pTemplateArguments - A reference to a com.esri.arcgis.datasourcesraster.IRasterFunctionArguments (in)

Throws:

IOException - If there are interop problems.

AutomationException - If the ArcObject component throws an exception.

getCatalog

public Object getCatalog()
                  throws IOException,
                         AutomationException

The source catalog.

Product Availability

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

Specified by:

getCatalog in interface IMosaicFunctionArguments

Returns:

A reference to another Object (IUnknown)

Throws:

IOException - If there are interop problems.

AutomationException - If the ArcObject component throws an exception.

setCatalogByRef

public void setCatalogByRef(Object ppCatalog)
                     throws IOException,
                            AutomationException

The source catalog.

Product Availability

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

Specified by:

setCatalogByRef in interface IMosaicFunctionArguments

Parameters:

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

Throws:

IOException - If there are interop problems.

AutomationException - If the ArcObject component throws an exception.

getSeamline

public Object getSeamline()
                   throws IOException,
                          AutomationException

The mosaic seamline table.

Product Availability

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

Specified by:

getSeamline in interface IMosaicFunctionArguments

Returns:

A reference to another Object (IUnknown)

Throws:

IOException - If there are interop problems.

AutomationException - If the ArcObject component throws an exception.

setSeamlineByRef

public void setSeamlineByRef(Object ppSeamline)
                      throws IOException,
                             AutomationException

The mosaic seamline table.

Product Availability

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

Specified by:

setSeamlineByRef in interface IMosaicFunctionArguments

Parameters:

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

Throws:

IOException - If there are interop problems.

AutomationException - If the ArcObject component throws an exception.

getBoundary

public Object getBoundary()
                   throws IOException,
                          AutomationException

The mosaic boundary.

Product Availability

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

Specified by:

getBoundary in interface IMosaicFunctionArguments

Returns:

A reference to another Object (IUnknown)

Throws:

IOException - If there are interop problems.

AutomationException - If the ArcObject component throws an exception.

setBoundaryByRef

public void setBoundaryByRef(Object ppBoundary)
                      throws IOException,
                             AutomationException

The mosaic boundary.

Product Availability

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

Specified by:

setBoundaryByRef in interface IMosaicFunctionArguments

Parameters:

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

Throws:

IOException - If there are interop problems.

AutomationException - If the ArcObject component throws an exception.

getDodgingTable

public Object getDodgingTable()
                       throws IOException,
                              AutomationException

The color mapping information for color correction.

Product Availability

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

Specified by:

getDodgingTable in interface IMosaicFunctionArguments

Returns:

A reference to another Object (IUnknown)

Throws:

IOException - If there are interop problems.

AutomationException - If the ArcObject component throws an exception.

setDodgingTableByRef

public void setDodgingTableByRef(Object ppDodgingTable)
                          throws IOException,
                                 AutomationException

The color mapping information for color correction.

Product Availability

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

Specified by:

setDodgingTableByRef in interface IMosaicFunctionArguments

Parameters:

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

Throws:

IOException - If there are interop problems.

AutomationException - If the ArcObject component throws an exception.

getRasterInfo

public IRasterInfo getRasterInfo()
                          throws IOException,
                                 AutomationException

The raster info.

Product Availability

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

Specified by:

getRasterInfo in interface IMosaicFunctionArguments

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.

setRasterInfoByRef

public void setRasterInfoByRef(IRasterInfo ppRasterInfo)
                        throws IOException,
                               AutomationException

The raster info.

Product Availability

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

Specified by:

setRasterInfoByRef in interface IMosaicFunctionArguments

Parameters:

ppRasterInfo - A reference to a com.esri.arcgis.datasourcesraster.IRasterInfo (in)

Throws:

IOException - If there are interop problems.

AutomationException - If the ArcObject component throws an exception.

getStereoTable

public Object getStereoTable()
                      throws IOException,
                             AutomationException

The stereo pair table.

Product Availability

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

Specified by:

getStereoTable in interface IMosaicFunctionArguments

Returns:

A reference to another Object (IUnknown)

Throws:

IOException - If there are interop problems.

AutomationException - If the ArcObject component throws an exception.

setStereoTableByRef

public void setStereoTableByRef(Object ppStereoTable)
                         throws IOException,
                                AutomationException

The stereo pair table.

Product Availability

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

Specified by:

setStereoTableByRef in interface IMosaicFunctionArguments

Parameters:

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

Throws:

IOException - If there are interop problems.

AutomationException - If the ArcObject component throws an exception.

setCellSizeTolerance

public void setCellSizeTolerance(double pCellSizeTolerance)
                          throws IOException,
                                 AutomationException

The cellsize tolerance for sorting on cellsize.

Product Availability

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

Specified by:

setCellSizeTolerance in interface IMosaicFunctionArguments2

Parameters:

pCellSizeTolerance - The pCellSizeTolerance (in)

Throws:

IOException - If there are interop problems.

AutomationException - If the ArcObject component throws an exception.

getCellSizeTolerance

public double getCellSizeTolerance()
                            throws IOException,
                                   AutomationException

The cellsize tolerance for sorting on cellsize.

Product Availability

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

Specified by:

getCellSizeTolerance in interface IMosaicFunctionArguments2

Returns:

The pCellSizeTolerance

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