com.esri.arcgis.carto

Class MosaicRule

java.lang.Object

com.esri.arcgis.carto.MosaicRule

All Implemented Interfaces:

IMosaicRule, com.esri.arcgis.interop.RemoteObjRef, IClone, IPersist, IPersistStream, IXMLSerialize, IXMLVersionSupport, java.io.Externalizable, java.io.Serializable

public class MosaicRule
extends java.lang.Object
implements com.esri.arcgis.interop.RemoteObjRef, IMosaicRule, IClone, IPersist, IPersistStream, IXMLSerialize, IXMLVersionSupport, java.io.Externalizable

COM Class 'MosaicRule'. Generated 5/5/2025 2:28:33 PM from 'X:\ArcGIS\com\server\esriCarto.tlb'

Description 'A mosaic rule class.' 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

Fields

Modifier and Type	Field and Description
static long	serialVersionUID

Fields inherited from interface com.esri.arcgis.carto.IMosaicRule

IID, IID0ae8d2e0_78f8_4a7c_9bc9_b16f42c6fbf9, xxDummy

Fields inherited from interface com.esri.arcgis.system.IClone

IID, IID9bff8aeb_e415_11d0_943c_080009eebecb, xxDummy

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

Constructors

Constructor and Description
MosaicRule() Constructs a MosaicRule using ArcGIS Engine.
MosaicRule(java.lang.Object obj) Deprecated. As of ArcGIS 9.2, replaced by normal Java casts. MosaicRule theMosaicRule = (MosaicRule) obj;

Method Summary

Modifier and Type	Method and Description
void	assign(IClone src) Assigns the properties of src to the receiver.
void	deserialize(IXMLSerializeData data) Deserializes an object from XML.
boolean	equals(java.lang.Object o) Compare this object with another
IClone	esri_clone() Clones the receiver and assigns the result to *clone.
void	getClassID(GUID[] pClassID) getClassID
static java.lang.String	getClsid() getClsid.
IFIDSet	getFIDs() The list of (selected) catalog item IDs.
com.esri.arcgis.interop.Dispatch	getJintegraDispatch() Gets a reference to a com.esri.arcgis.interop.Dispatch which can be used to access the COM object that support for this interface indicates the implementing class references.
java.lang.String	getLockRasterID() The lock raster ID.
java.lang.String	getMinNamespaceSupported() The minimum namespace the class can serialize to (eg the 90 namespace).
int	getMosaicMethod() The mosaic method.
int	getMosaicOperatorType() The type of mosaic operator for resolving overlapping pixels.
java.lang.Object	getOrderByBaseValue() The Order By base value.
java.lang.String	getOrderByFieldName() The Order By field on the source catalog.
void	getSizeMax(_ULARGE_INTEGER[] pcbSize) getSizeMax
ITimeValue	getTimeValue() The request time value.
IPoint	getViewpoint() The view point.
java.lang.String	getWhereClause() The SQL selection where clause expression.
int	hashCode() the hashcode for this object
boolean	isAscending() Indicates whether the ascending flag of OrderBy.
void	isDirty() isDirty
boolean	isEqual(IClone other) Indicates if the receiver and other have the same properties.
boolean	isIdentical(IClone other) Indicates if the receiver and other are the same object.
void	load(IStream pstm) load
void	readExternal(java.io.ObjectInput in)
void	release() Release this COM object reference
void	save(IStream pstm, int fClearDirty) save
void	serialize(IXMLSerializeData data) Serializes an object to XML.
void	setAscending(boolean pAscending) Indicates whether the ascending flag of OrderBy.
void	setFIDsByRef(IFIDSet ppFIDs) The list of (selected) catalog item IDs.
void	setLockRasterID(java.lang.String pRasterID) The lock raster ID.
void	setMosaicMethod(int mm) The mosaic method.
void	setMosaicOperatorType(int type) The type of mosaic operator for resolving overlapping pixels.
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	setTimeValueByRef(ITimeValue ppTimeValue) The request time value.
void	setViewpointByRef(IPoint ppViewpoint) The view point.
void	setWhereClause(java.lang.String pExpression) The SQL selection where clause expression.
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

MosaicRule

public MosaicRule()
           throws java.io.IOException,
                  java.net.UnknownHostException

Constructs a MosaicRule using ArcGIS Engine.

Throws:

java.io.IOException - if there are interop problems

java.net.UnknownHostException - if there are interop problems

MosaicRule

public MosaicRule(java.lang.Object obj)
           throws java.io.IOException

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

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

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()

Gets a reference to a com.esri.arcgis.interop.Dispatch which can be used to access the COM object that support for this interface indicates the implementing class references.

Specified by:

getJintegraDispatch in interface com.esri.arcgis.interop.RemoteObjRef

Returns:

the COM object reference

release

public void release()

Release this COM object reference

Specified by:

release in interface com.esri.arcgis.interop.RemoteObjRef

getMosaicMethod

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

The mosaic method.

Specified by:

getMosaicMethod in interface IMosaicRule

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 mm)
                     throws java.io.IOException,
                            AutomationException

The mosaic method.

Specified by:

setMosaicMethod in interface IMosaicRule

Parameters:

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

getLockRasterID

public java.lang.String getLockRasterID()
                                 throws java.io.IOException,
                                        AutomationException

The lock raster ID.

Specified by:

getLockRasterID in interface IMosaicRule

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 IMosaicRule

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 IMosaicRule

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 IMosaicRule

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.

getOrderByFieldName

public java.lang.String getOrderByFieldName()
                                     throws java.io.IOException,
                                            AutomationException

The Order By field on the source catalog.

Specified by:

getOrderByFieldName in interface IMosaicRule

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 IMosaicRule

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 IMosaicRule

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 IMosaicRule

Parameters:

pValue - A Variant (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 IMosaicRule

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 IMosaicRule

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

Specified by:

getMosaicOperatorType in interface IMosaicRule

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

Specified by:

setMosaicOperatorType in interface IMosaicRule

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.

getWhereClause

public java.lang.String getWhereClause()
                                throws java.io.IOException,
                                       AutomationException

The SQL selection where clause expression.

Specified by:

getWhereClause in interface IMosaicRule

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 IMosaicRule

Parameters:

pExpression - The pExpression (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 list of (selected) catalog item IDs.

Specified by:

getFIDs in interface IMosaicRule

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.

setFIDsByRef

public void setFIDsByRef(IFIDSet ppFIDs)
                  throws java.io.IOException,
                         AutomationException

The list of (selected) catalog item IDs.

Specified by:

setFIDsByRef in interface IMosaicRule

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.

getTimeValue

public ITimeValue getTimeValue()
                        throws java.io.IOException,
                               AutomationException

The request time value.

Specified by:

getTimeValue in interface IMosaicRule

Returns:

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

Throws:

java.io.IOException - If there are interop problems.

AutomationException - If the ArcObject component throws an exception.

setTimeValueByRef

public void setTimeValueByRef(ITimeValue ppTimeValue)
                       throws java.io.IOException,
                              AutomationException

The request time value.

Specified by:

setTimeValueByRef in interface IMosaicRule

Parameters:

ppTimeValue - A reference to a com.esri.arcgis.system.ITimeValue (in)

Throws:

java.io.IOException - If there are interop problems.

AutomationException - If the ArcObject component throws an exception.

esri_clone

public IClone esri_clone()
                  throws java.io.IOException,
                         AutomationException

Clones the receiver and assigns the result to *clone.

Specified by:

esri_clone in interface IClone

Returns:

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

Throws:

java.io.IOException - If there are interop problems.

AutomationException - If the ArcObject component throws an exception.

assign

public void assign(IClone src)
            throws java.io.IOException,
                   AutomationException

Assigns the properties of src to the receiver.

Specified by:

assign in interface IClone

Parameters:

src - A reference to a com.esri.arcgis.system.IClone (in)

Throws:

java.io.IOException - If there are interop problems.

AutomationException - If the ArcObject component throws an exception.

isEqual

public boolean isEqual(IClone other)
                throws java.io.IOException,
                       AutomationException

Indicates if the receiver and other have the same properties.

Specified by:

isEqual in interface IClone

Parameters:

other - A reference to a com.esri.arcgis.system.IClone (in)

Returns:

The equal

Throws:

java.io.IOException - If there are interop problems.

AutomationException - If the ArcObject component throws an exception.

isIdentical

public boolean isIdentical(IClone other)
                    throws java.io.IOException,
                           AutomationException

Indicates if the receiver and other are the same object.

Specified by:

isIdentical in interface IClone

Parameters:

other - A reference to a com.esri.arcgis.system.IClone (in)

Returns:

The identical

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