com.esri.arcgis.geoprocessing
Class MdModel

java.lang.Object
  extended by com.esri.arcgis.geoprocessing.MdModel
All Implemented Interfaces:
IConnectionPointContainer, IMdModel, IMdModelIteration, com.esri.arcgis.interop.RemoteObjRef, IClone, IPersist, IPersistStream, IXMLSerialize, Externalizable, Serializable

public class MdModel
extends Object
implements com.esri.arcgis.interop.RemoteObjRef, IMdModel, IPersistStream, IXMLSerialize, IClone, IConnectionPointContainer, IMdModelIteration, Externalizable

A collection of model variables and processes, used to execute multiple geoprocessing tools in some order.

Product Availability

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

Supported Platforms

Windows

See Also:
Serialized Form

Constructor Summary
MdModel()
          Constructs a MdModel using ArcGIS Engine.
MdModel(Object obj)
          Deprecated. As of ArcGIS 9.2, replaced by normal Java casts.
MdModel theMdModel = (MdModel) obj;
 
Method Summary
 void addElement(IMdElement element)
          Adds the given element to the model.
 void addElements(IArray elements)
          Adds the collection of elements to the model.
 void addIMdModelEventsListener(IMdModelEvents theListener)
          addIMdModelEventsListener.
 void assign(IClone src)
          Assigns the properties of src to the receiver.
 boolean canAddElement(IMdElement pElement)
          Returns whether or not the given model element can be added to the model.
 String createUniqueElementName(String name)
          Generates a new unique name that may be used for adding a new model element to the model.
 void deleteElement(IMdElement element)
          Removes the given element from the model.
 void deserialize(IXMLSerializeData data)
          Deserializes an object from XML.
 void disconnectElements(IMdElement pFromElement, IMdElement pToElement, int connectionType)
          Removes the connection/dependency between two model elements.
 void empty()
          Removes all model elements from the model.
 void enumConnectionPoints(IEnumConnectionPoints[] ppEnum)
          enumConnectionPoints
 boolean equals(Object o)
          Compare this object with another
 IClone esri_clone()
          Clones the receiver and assigns the result to *clone.
 void execute(ITrackCancel trackcancel, boolean reset, IGPEnvironmentManager pEnvMgr, IGPMessages messages, boolean stopOnFirstFailure)
          Executes all the processes in the model.
 void executeProcess(IMdProcess pMdProcess, ITrackCancel trackcancel, boolean reset, IGPEnvironmentManager pEnvMgr, IGPMessages messages, boolean stopOnFirstFailure)
          Executes a single process in the model.
 void findConnectionPoint(GUID riid, IConnectionPoint[] ppCP)
          findConnectionPoint
 IEnumMdElement findDependents(IMdElement pMdElement, int direction, int connectionType)
          Returns all the model elements dependent on the given model element in the given direction of the given connection type.
 void getClassID(GUID[] pClassID)
          getClassID
static String getClsid()
          getClsid.
 int getCurrentIteration()
          Current model iteration.
 IMdElement getElement(String name)
          Returns the model element with the given name.
 IMdElement getElementByID(int identifier)
          Returns the model element with the given identifier.
 IEnumMdElement getElements()
          Returns all of the model elements in the model.
 IGPEnvironmentManager getEnvironmentManager()
          The set of overriding environment values used when validating/executing the model.
 int getIterationCount()
          Number of times to iterate the model.
 int getIterationType()
          Indicates model iteration type.
 IMdVariable getIterationVariable()
          Model iteration variable.
 String getName()
          Name of the model.
 IEnumMdProcess getProcesses()
          Returns all of the processes in the model.
 void getSizeMax(_ULARGE_INTEGER[] pcbSize)
          getSizeMax
 IEnumMdVariable getVariables()
          Returns all of the variables in the model.
 int hashCode()
          the hashcode for this object
 void isDirty()
          isDirty
 boolean isEqual(IClone other)
          Returns TRUE when the receiver and other have the same properties.
 boolean isIdentical(IClone other)
          Returns TRUE when the receiver and other are the same object.
 boolean isLicensed()
          Returns whether or not all the processes in the model are licensed.
 boolean isValid()
          Returns whether or not all the model elements in the model are valid.
 void load(IStream pstm)
          load
 void mergeElements(IEnumMdElement pElements)
          Merges the given enumeration of model elements, commonly from another model, into the current model.
 void readExternal(ObjectInput in)
           
 void removeIMdModelEventsListener(IMdModelEvents theListener)
          removeIMdModelEventsListener.
 void save(IStream pstm, int fClearDirty)
          save
 void serialize(IXMLSerializeData data)
          Serializes an object to XML.
 void setEnvironmentManagerByRef(IGPEnvironmentManager ppEnvMgr)
          The set of overriding environment values used when validating/executing the model.
 void setIterationCount(int count)
          Number of times to iterate the model.
 void setIterationType(int type)
          Indicates model iteration type.
 void setIterationVariableByRef(IMdVariable ppVariable)
          Model iteration variable.
 void setName(String name)
          Name of the model.
 IEnumMdElement sortElements()
          Returns all the model elements in the model in sorted order.
 IEnumMdElement traceDependents(IMdElement pMdElement, int direction, int depth)
          Returns all the model elements dependent on the given model element in the given direction.
 IGPMessages validate(boolean reset, IGPEnvironmentManager pEnvMgr)
          Validates all model elements in the model.
 boolean verifyUniqueElementName(String name)
          Returns whether or not the model already contains a model element by the given name.
 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

MdModel

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

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

MdModel

public MdModel(Object obj)
        throws IOException
Deprecated. As of ArcGIS 9.2, replaced by normal Java casts.
MdModel theMdModel = (MdModel) obj;

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

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

addIMdModelEventsListener

public void addIMdModelEventsListener(IMdModelEvents theListener)
                               throws IOException
addIMdModelEventsListener. Listen to events generated by this class.

Parameters:
theListener - An object that implements the com.esri.arcgis.geoprocessing.IMdModelEvents interface.
Throws:
IOException - If there are communications problems.

removeIMdModelEventsListener

public void removeIMdModelEventsListener(IMdModelEvents theListener)
                                  throws IOException
removeIMdModelEventsListener. Stop listening to events generated by this class.

Parameters:
theListener - An object that implements the com.esri.arcgis.geoprocessing.IMdModelEvents interface.
Throws:
IOException - If there are communications problems.

getName

public String getName()
               throws IOException,
                      AutomationException
Name of the model.

Product Availability

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

Supported Platforms

Windows

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

setName

public void setName(String name)
             throws IOException,
                    AutomationException
Name of the model.

Product Availability

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

Supported Platforms

Windows

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

addElement

public void addElement(IMdElement element)
                throws IOException,
                       AutomationException
Adds the given element to the model.

Product Availability

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

Supported Platforms

Windows

Specified by:
addElement in interface IMdModel
Parameters:
element - A reference to a com.esri.arcgis.geoprocessing.IMdElement (in)
Throws:
IOException - If there are interop problems.
AutomationException - If the ArcObject component throws an exception.

addElements

public void addElements(IArray elements)
                 throws IOException,
                        AutomationException
Adds the collection of elements to the model.

Product Availability

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

Supported Platforms

Windows

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

getElement

public IMdElement getElement(String name)
                      throws IOException,
                             AutomationException
Returns the model element with the given name.

Product Availability

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

Supported Platforms

Windows

Specified by:
getElement in interface IMdModel
Parameters:
name - The name (in)
Returns:
A reference to a com.esri.arcgis.geoprocessing.IMdElement
Throws:
IOException - If there are interop problems.
AutomationException - If the ArcObject component throws an exception.

getElementByID

public IMdElement getElementByID(int identifier)
                          throws IOException,
                                 AutomationException
Returns the model element with the given identifier.

Product Availability

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

Supported Platforms

Windows

Specified by:
getElementByID in interface IMdModel
Parameters:
identifier - The identifier (in)
Returns:
A reference to a com.esri.arcgis.geoprocessing.IMdElement
Throws:
IOException - If there are interop problems.
AutomationException - If the ArcObject component throws an exception.

getElements

public IEnumMdElement getElements()
                           throws IOException,
                                  AutomationException
Returns all of the model elements in the model.

Product Availability

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

Supported Platforms

Windows

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

getVariables

public IEnumMdVariable getVariables()
                             throws IOException,
                                    AutomationException
Returns all of the variables in the model.

Product Availability

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

Supported Platforms

Windows

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

getProcesses

public IEnumMdProcess getProcesses()
                            throws IOException,
                                   AutomationException
Returns all of the processes in the model.

Product Availability

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

Supported Platforms

Windows

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

deleteElement

public void deleteElement(IMdElement element)
                   throws IOException,
                          AutomationException
Removes the given element from the model.

Product Availability

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

Supported Platforms

Windows

Specified by:
deleteElement in interface IMdModel
Parameters:
element - A reference to a com.esri.arcgis.geoprocessing.IMdElement (in)
Throws:
IOException - If there are interop problems.
AutomationException - If the ArcObject component throws an exception.

empty

public void empty()
           throws IOException,
                  AutomationException
Removes all model elements from the model.

Product Availability

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

Supported Platforms

Windows

Specified by:
empty in interface IMdModel
Throws:
IOException - If there are interop problems.
AutomationException - If the ArcObject component throws an exception.

validate

public IGPMessages validate(boolean reset,
                            IGPEnvironmentManager pEnvMgr)
                     throws IOException,
                            AutomationException
Validates all model elements in the model.

Product Availability

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

Supported Platforms

Windows

Specified by:
validate in interface IMdModel
Parameters:
reset - The reset (in)
pEnvMgr - A reference to a com.esri.arcgis.geoprocessing.IGPEnvironmentManager (in)
Returns:
A reference to a com.esri.arcgis.geodatabase.IGPMessages
Throws:
IOException - If there are interop problems.
AutomationException - If the ArcObject component throws an exception.

execute

public void execute(ITrackCancel trackcancel,
                    boolean reset,
                    IGPEnvironmentManager pEnvMgr,
                    IGPMessages messages,
                    boolean stopOnFirstFailure)
             throws IOException,
                    AutomationException
Executes all the processes in the model.

Product Availability

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

Supported Platforms

Windows

Specified by:
execute in interface IMdModel
Parameters:
trackcancel - A reference to a com.esri.arcgis.system.ITrackCancel (in)
reset - The reset (in)
pEnvMgr - A reference to a com.esri.arcgis.geoprocessing.IGPEnvironmentManager (in)
messages - A reference to a com.esri.arcgis.geodatabase.IGPMessages (in)
stopOnFirstFailure - The stopOnFirstFailure (in)
Throws:
IOException - If there are interop problems.
AutomationException - If the ArcObject component throws an exception.

executeProcess

public void executeProcess(IMdProcess pMdProcess,
                           ITrackCancel trackcancel,
                           boolean reset,
                           IGPEnvironmentManager pEnvMgr,
                           IGPMessages messages,
                           boolean stopOnFirstFailure)
                    throws IOException,
                           AutomationException
Executes a single process in the model.

Product Availability

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

Supported Platforms

Windows

Specified by:
executeProcess in interface IMdModel
Parameters:
pMdProcess - A reference to a com.esri.arcgis.geoprocessing.IMdProcess (in)
trackcancel - A reference to a com.esri.arcgis.system.ITrackCancel (in)
reset - The reset (in)
pEnvMgr - A reference to a com.esri.arcgis.geoprocessing.IGPEnvironmentManager (in)
messages - A reference to a com.esri.arcgis.geodatabase.IGPMessages (in)
stopOnFirstFailure - The stopOnFirstFailure (in)
Throws:
IOException - If there are interop problems.
AutomationException - If the ArcObject component throws an exception.

sortElements

public IEnumMdElement sortElements()
                            throws IOException,
                                   AutomationException
Returns all the model elements in the model in sorted order.

Product Availability

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

Supported Platforms

Windows

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

traceDependents

public IEnumMdElement traceDependents(IMdElement pMdElement,
                                      int direction,
                                      int depth)
                               throws IOException,
                                      AutomationException
Returns all the model elements dependent on the given model element in the given direction.

Product Availability

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

Supported Platforms

Windows

Specified by:
traceDependents in interface IMdModel
Parameters:
pMdElement - A reference to a com.esri.arcgis.geoprocessing.IMdElement (in)
direction - A com.esri.arcgis.geoprocessing.esriMdDirection constant (in)
depth - The depth (in)
Returns:
A reference to a com.esri.arcgis.geoprocessing.IEnumMdElement
Throws:
IOException - If there are interop problems.
AutomationException - If the ArcObject component throws an exception.

findDependents

public IEnumMdElement findDependents(IMdElement pMdElement,
                                     int direction,
                                     int connectionType)
                              throws IOException,
                                     AutomationException
Returns all the model elements dependent on the given model element in the given direction of the given connection type.

Product Availability

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

Supported Platforms

Windows

Specified by:
findDependents in interface IMdModel
Parameters:
pMdElement - A reference to a com.esri.arcgis.geoprocessing.IMdElement (in)
direction - A com.esri.arcgis.geoprocessing.esriMdDirection constant (in)
connectionType - A com.esri.arcgis.geoprocessing.esriMdConnectionType constant (in)
Returns:
A reference to a com.esri.arcgis.geoprocessing.IEnumMdElement
Throws:
IOException - If there are interop problems.
AutomationException - If the ArcObject component throws an exception.

mergeElements

public void mergeElements(IEnumMdElement pElements)
                   throws IOException,
                          AutomationException
Merges the given enumeration of model elements, commonly from another model, into the current model.

Product Availability

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

Supported Platforms

Windows

Specified by:
mergeElements in interface IMdModel
Parameters:
pElements - A reference to a com.esri.arcgis.geoprocessing.IEnumMdElement (in)
Throws:
IOException - If there are interop problems.
AutomationException - If the ArcObject component throws an exception.

verifyUniqueElementName

public boolean verifyUniqueElementName(String name)
                                throws IOException,
                                       AutomationException
Returns whether or not the model already contains a model element by the given name.

Product Availability

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

Supported Platforms

Windows

Specified by:
verifyUniqueElementName in interface IMdModel
Parameters:
name - The name (in)
Returns:
The pUnique
Throws:
IOException - If there are interop problems.
AutomationException - If the ArcObject component throws an exception.

canAddElement

public boolean canAddElement(IMdElement pElement)
                      throws IOException,
                             AutomationException
Returns whether or not the given model element can be added to the model.

Product Availability

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

Supported Platforms

Windows

Specified by:
canAddElement in interface IMdModel
Parameters:
pElement - A reference to a com.esri.arcgis.geoprocessing.IMdElement (in)
Returns:
The pCanAdd
Throws:
IOException - If there are interop problems.
AutomationException - If the ArcObject component throws an exception.

getEnvironmentManager

public IGPEnvironmentManager getEnvironmentManager()
                                            throws IOException,
                                                   AutomationException
The set of overriding environment values used when validating/executing the model.

Product Availability

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

Supported Platforms

Windows

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

setEnvironmentManagerByRef

public void setEnvironmentManagerByRef(IGPEnvironmentManager ppEnvMgr)
                                throws IOException,
                                       AutomationException
The set of overriding environment values used when validating/executing the model.

Product Availability

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

Specified by:
setEnvironmentManagerByRef in interface IMdModel
Parameters:
ppEnvMgr - A reference to a com.esri.arcgis.geoprocessing.IGPEnvironmentManager (in)
Throws:
IOException - If there are interop problems.
AutomationException - If the ArcObject component throws an exception.

isValid

public boolean isValid()
                throws IOException,
                       AutomationException
Returns whether or not all the model elements in the model are valid.

Product Availability

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

Supported Platforms

Windows

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

isLicensed

public boolean isLicensed()
                   throws IOException,
                          AutomationException
Returns whether or not all the processes in the model are licensed.

Product Availability

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

Supported Platforms

Windows

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

disconnectElements

public void disconnectElements(IMdElement pFromElement,
                               IMdElement pToElement,
                               int connectionType)
                        throws IOException,
                               AutomationException
Removes the connection/dependency between two model elements.

Product Availability

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

Supported Platforms

Windows

Specified by:
disconnectElements in interface IMdModel
Parameters:
pFromElement - A reference to a com.esri.arcgis.geoprocessing.IMdElement (in)
pToElement - A reference to a com.esri.arcgis.geoprocessing.IMdElement (in)
connectionType - A com.esri.arcgis.geoprocessing.esriMdConnectionType constant (in)
Throws:
IOException - If there are interop problems.
AutomationException - If the ArcObject component throws an exception.

createUniqueElementName

public String createUniqueElementName(String name)
                               throws IOException,
                                      AutomationException
Generates a new unique name that may be used for adding a new model element to the model.

Product Availability

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

Supported Platforms

Windows

Specified by:
createUniqueElementName in interface IMdModel
Parameters:
name - The name (in)
Returns:
The pName
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.

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.

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.

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
Returns TRUE when 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
Returns TRUE when 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.

enumConnectionPoints

public void enumConnectionPoints(IEnumConnectionPoints[] ppEnum)
                          throws IOException,
                                 AutomationException
enumConnectionPoints

Description

IConnectionPointContainer 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:
enumConnectionPoints in interface IConnectionPointContainer
Parameters:
ppEnum - A reference to a com.esri.arcgis.display.IEnumConnectionPoints (out: use single element array)
Throws:
IOException - If there are interop problems.
AutomationException - If the ArcObject component throws an exception.

findConnectionPoint

public void findConnectionPoint(GUID riid,
                                IConnectionPoint[] ppCP)
                         throws IOException,
                                AutomationException
findConnectionPoint

Description

IConnectionPointContainer 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:
findConnectionPoint in interface IConnectionPointContainer
Parameters:
riid - A Structure: com.esri.arcgis.support.ms.stdole.GUID (in)
ppCP - A reference to a com.esri.arcgis.display.IConnectionPoint (out: use single element array)
Throws:
IOException - If there are interop problems.
AutomationException - If the ArcObject component throws an exception.

getIterationType

public int getIterationType()
                     throws IOException,
                            AutomationException
Indicates model iteration type.

Product Availability

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

Specified by:
getIterationType in interface IMdModelIteration
Returns:
A com.esri.arcgis.geoprocessing.esriMdIterationType constant
Throws:
IOException - If there are interop problems.
AutomationException - If the ArcObject component throws an exception.

setIterationType

public void setIterationType(int type)
                      throws IOException,
                             AutomationException
Indicates model iteration type.

Product Availability

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

Specified by:
setIterationType in interface IMdModelIteration
Parameters:
type - A com.esri.arcgis.geoprocessing.esriMdIterationType constant (in)
Throws:
IOException - If there are interop problems.
AutomationException - If the ArcObject component throws an exception.

getIterationCount

public int getIterationCount()
                      throws IOException,
                             AutomationException
Number of times to iterate the model.

Product Availability

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

Specified by:
getIterationCount in interface IMdModelIteration
Returns:
The count
Throws:
IOException - If there are interop problems.
AutomationException - If the ArcObject component throws an exception.

setIterationCount

public void setIterationCount(int count)
                       throws IOException,
                              AutomationException
Number of times to iterate the model.

Product Availability

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

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

getIterationVariable

public IMdVariable getIterationVariable()
                                 throws IOException,
                                        AutomationException
Model iteration variable.

Product Availability

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

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

setIterationVariableByRef

public void setIterationVariableByRef(IMdVariable ppVariable)
                               throws IOException,
                                      AutomationException
Model iteration variable.

Product Availability

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

Specified by:
setIterationVariableByRef in interface IMdModelIteration
Parameters:
ppVariable - A reference to a com.esri.arcgis.geoprocessing.IMdVariable (in)
Throws:
IOException - If there are interop problems.
AutomationException - If the ArcObject component throws an exception.

getCurrentIteration

public int getCurrentIteration()
                        throws IOException,
                               AutomationException
Current model iteration.

Product Availability

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

Specified by:
getCurrentIteration in interface IMdModelIteration
Returns:
The iteration
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