com.esri.arcgis.carto
Class MosaicRule

java.lang.Object
  extended by com.esri.arcgis.carto.MosaicRule
All Implemented Interfaces:
IMosaicRule, com.esri.arcgis.interop.RemoteObjRef, IClone, IPersist, IPersistStream, IXMLSerialize, IXMLVersionSupport, Externalizable, Serializable

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

A mosaic rule class.

Remarks

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

Product Availability

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

See Also:
Serialized Form

Constructor Summary
MosaicRule()
          Constructs a MosaicRule using ArcGIS Engine.
MosaicRule(Object obj)
          Deprecated. As of ArcGIS 9.2, replaced by normal Java casts.
MosaicRule theMosaicRule = (MosaicRule) obj;
 
Method Summary
 void assign(IClone src)
          Assigns the properties of src to the receiver.
 void deserialize(IXMLSerializeData data)
          Deserializes an object from XML.
 boolean equals(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 String getClsid()
          getClsid.
 IFIDSet getFIDs()
          The list of (selected) catalog item IDs.
 String getLockRasterID()
          The lock raster ID.
 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.
 Object getOrderByBaseValue()
          The Order By base value.
 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.
 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(ObjectInput in)
           
 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(String pRasterID)
          The lock raster ID.
 void setMosaicMethod(int pMosaicMethod)
          The mosaic method.
 void setMosaicOperatorType(int type)
          The type of mosaic operator for resolving overlapping pixels.
 void setOrderByBaseValue(Object pValue)
          The Order By base value.
 void setOrderByFieldName(String pName)
          The Order By field on the source catalog.
 void setTimeValueByRef(ITimeValue ppTimeValue)
          The request time value.
 void setViewpointByRef(IPoint ppViewpoint)
          The view point.
 void setWhereClause(String pExpression)
          The SQL selection where clause expression.
 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

MosaicRule

public MosaicRule()
           throws IOException,
                  UnknownHostException
Constructs a MosaicRule using ArcGIS Engine.

Throws:
IOException - if there are interop problems
UnknownHostException - if there are interop problems

MosaicRule

public MosaicRule(Object obj)
           throws 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:
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

getMosaicMethod

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

Product Availability

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

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

setMosaicMethod

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

Product Availability

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

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

getLockRasterID

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

Product Availability

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

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

setLockRasterID

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

Description

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

Product Availability

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

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

getViewpoint

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

Product Availability

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

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

setViewpointByRef

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

Remarks

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

Product Availability

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

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

getOrderByFieldName

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

Product Availability

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

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

setOrderByFieldName

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

Remarks

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

Product Availability

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

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

getOrderByBaseValue

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

Product Availability

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

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

setOrderByBaseValue

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

Product Availability

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

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

isAscending

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

Product Availability

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

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

setAscending

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

Description

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

Product Availability

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

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

getMosaicOperatorType

public int getMosaicOperatorType()
                          throws IOException,
                                 AutomationException
The type of mosaic operator for resolving overlapping pixels.

Product Availability

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

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

setMosaicOperatorType

public void setMosaicOperatorType(int type)
                           throws IOException,
                                  AutomationException
The type of mosaic operator for resolving overlapping pixels.

Remarks

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

Product Availability

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

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

getWhereClause

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

Product Availability

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

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

setWhereClause

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

Product Availability

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

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

getFIDs

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

Product Availability

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

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

setFIDsByRef

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

Product Availability

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

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

getTimeValue

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

Product Availability

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

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

setTimeValueByRef

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

Product Availability

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

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

esri_clone

public IClone esri_clone()
                  throws IOException,
                         AutomationException
Clones the receiver and assigns the result to *clone.

Product Availability

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

Specified by:
esri_clone in interface IClone
Returns:
A reference to a com.esri.arcgis.system.IClone
Throws:
IOException - If there are interop problems.
AutomationException - If the ArcObject component throws an exception.

assign

public void assign(IClone src)
            throws IOException,
                   AutomationException
Assigns the properties of src to the receiver.

Description

Use Assign method to assign the properties of source object to receiver object. Both objects need to have the same CLSIDs. Both source and receiver objects need to be instantiated.

Product Availability

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

Supported Platforms

Windows, Solaris, Linux

Specified by:
assign in interface IClone
Parameters:
src - A reference to a com.esri.arcgis.system.IClone (in)
Throws:
IOException - If there are interop problems.
AutomationException - If the ArcObject component throws an exception.

isEqual

public boolean isEqual(IClone other)
                throws IOException,
                       AutomationException
Indicates if the receiver and other have the same properties.

Description

IsEqual returns True if the receiver and the source have the same properties. Note, this does not imply that the receiver and the source reference the same object.

Product Availability

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

Supported Platforms

Windows, Solaris, Linux

Specified by:
isEqual in interface IClone
Parameters:
other - A reference to a com.esri.arcgis.system.IClone (in)
Returns:
The equal
Throws:
IOException - If there are interop problems.
AutomationException - If the ArcObject component throws an exception.

isIdentical

public boolean isIdentical(IClone other)
                    throws IOException,
                           AutomationException
Indicates if the receiver and other are the same object.

Description

IsIdentical returns true if the receiver and the source reference the same object.

Product Availability

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

Supported Platforms

Windows, Solaris, Linux

Specified by:
isIdentical in interface IClone
Parameters:
other - A reference to a com.esri.arcgis.system.IClone (in)
Returns:
The identical
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