com.esri.arcgis.datainterop
Class FMETool

java.lang.Object
  com.esri.arcgis.datainterop.FMETool

All Implemented Interfaces:

IGPToolExtension, com.esri.arcgis.interop.RemoteObjRef, IClone, IPersist, IPersistStream, ISupportErrorInfo, Externalizable, Serializable

public class FMETool
extends Object
implements com.esri.arcgis.interop.RemoteObjRef, IGPToolExtension, IPersistStream, IClone, ISupportErrorInfo, Externalizable

FMETool Class

Product Availability

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

See Also:

Serialized Form

Constructor Summary

FMETool()
Constructs a FMETool using ArcGIS Engine.

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

Method Summary

void	assign(IClone src) Assigns the properties of src to the receiver.
boolean	canEditSource() Returns whether or not the source for the tool extension can be edited.
boolean	equals(Object o) Compare this object with another
IClone	esri_clone() Clones the receiver and assigns the result to *clone.
void	execute(IArray paramvalues, ITrackCancel trackCancel, IGPEnvironmentManager pEnvMgr, IGPMessages messages) Executes the tool extension given the set of parameter values.
void	getClassID(GUID[] pClassID) getClassID
static String	getClsid() getClsid.
IGPCustomToolHelper	getCustomToolHelper() The custom tool helper object associated with the tool extension.
IUID	getDialogCLSID() The CLSID of a custom dialog class to enter/edit parameter values for custom tools associated with this tool extension.
IArray	getParameterInfo() The parameters required to execute the custom tool associated with this tool extension.
Object	getRenderer(IGPParameter pParam) Returns a custom renderer for a given parameter.
void	getSizeMax(_ULARGE_INTEGER[] pcbSize) getSizeMax
IGPToolExtensionFactory	getToolExtensionFactory() The factory object associated with this tool extension.
int	hashCode() the hashcode for this object
void	interfaceSupportsErrorInfo(GUID riid) interfaceSupportsErrorInfo
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.
boolean	isLicensed() Returns whether or not the tool extension has all necessary product licenses to be executed.
boolean	isLicensedForProduct() Returns whether or not the tool extension can be executed within the current application product.
boolean	isValid() Returns whether or not the tool extension is can be executed.
void	load(IStream pstm) load
void	readExternal(ObjectInput in)
void	save(IStream pstm, int fClearDirty) save
void	setCustomToolHelperByRef(IGPCustomToolHelper helper) The custom tool helper object associated with the tool extension.
void	synchronizeMetadata(int action, int interval, IPropertySet metadata) Updates the given metadata property set with the current tool extension properties.
IGPMessages	validate(IArray paramvalues, boolean updateValues, IGPEnvironmentManager pEnvMgr) Validates the given set of values.
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

FMETool

public FMETool()
        throws IOException,
               UnknownHostException

Constructs a FMETool using ArcGIS Engine.

Throws:

IOException - if there are interop problems

UnknownHostException - if there are interop problems

FMETool

public FMETool(Object obj)
        throws IOException

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

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

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

getToolExtensionFactory

public IGPToolExtensionFactory getToolExtensionFactory()
                                                throws IOException,
                                                       AutomationException

The factory object associated with this tool extension.

Product Availability

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

Specified by:

getToolExtensionFactory in interface IGPToolExtension

Returns:

A reference to a com.esri.arcgis.geoprocessing.IGPToolExtensionFactory

Throws:

IOException - If there are interop problems.

AutomationException - If the ArcObject component throws an exception.

getCustomToolHelper

public IGPCustomToolHelper getCustomToolHelper()
                                        throws IOException,
                                               AutomationException

The custom tool helper object associated with the tool extension.

Product Availability

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

Specified by:

getCustomToolHelper in interface IGPToolExtension

Returns:

A reference to a com.esri.arcgis.geoprocessing.IGPCustomToolHelper

Throws:

IOException - If there are interop problems.

AutomationException - If the ArcObject component throws an exception.

setCustomToolHelperByRef

public void setCustomToolHelperByRef(IGPCustomToolHelper helper)
                              throws IOException,
                                     AutomationException

The custom tool helper object associated with the tool extension.

Product Availability

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

Specified by:

setCustomToolHelperByRef in interface IGPToolExtension

Parameters:

helper - A reference to a com.esri.arcgis.geoprocessing.IGPCustomToolHelper (in)

Throws:

IOException - If there are interop problems.

AutomationException - If the ArcObject component throws an exception.

getDialogCLSID

public IUID getDialogCLSID()
                    throws IOException,
                           AutomationException

The CLSID of a custom dialog class to enter/edit parameter values for custom tools associated with this tool extension.

Product Availability

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

Specified by:

getDialogCLSID in interface IGPToolExtension

Returns:

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

Throws:

IOException - If there are interop problems.

AutomationException - If the ArcObject component throws an exception.

getParameterInfo

public IArray getParameterInfo()
                        throws IOException,
                               AutomationException

The parameters required to execute the custom tool associated with this tool extension.

Product Availability

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

Specified by:

getParameterInfo in interface IGPToolExtension

Returns:

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

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 the tool extension is can be executed.

Product Availability

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

Specified by:

isValid in interface IGPToolExtension

Returns:

The valid

Throws:

IOException - If there are interop problems.

AutomationException - If the ArcObject component throws an exception.

isLicensedForProduct

public boolean isLicensedForProduct()
                             throws IOException,
                                    AutomationException

Returns whether or not the tool extension can be executed within the current application product.

Product Availability

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

Specified by:

isLicensedForProduct in interface IGPToolExtension

Returns:

The isLicensed

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 the tool extension has all necessary product licenses to be executed.

Product Availability

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

Specified by:

isLicensed in interface IGPToolExtension

Returns:

The isLicensed

Throws:

IOException - If there are interop problems.

AutomationException - If the ArcObject component throws an exception.

canEditSource

public boolean canEditSource()
                      throws IOException,
                             AutomationException

Returns whether or not the source for the tool extension can be edited.

Product Availability

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

Specified by:

canEditSource in interface IGPToolExtension

Returns:

The canEdit

Throws:

IOException - If there are interop problems.

AutomationException - If the ArcObject component throws an exception.

getRenderer

public Object getRenderer(IGPParameter pParam)
                   throws IOException,
                          AutomationException

Returns a custom renderer for a given parameter.

Product Availability

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

Specified by:

getRenderer in interface IGPToolExtension

Parameters:

pParam - A reference to a com.esri.arcgis.geoprocessing.IGPParameter (in)

Returns:

A reference to another Object (IUnknown)

Throws:

IOException - If there are interop problems.

AutomationException - If the ArcObject component throws an exception.

validate

public IGPMessages validate(IArray paramvalues,
                            boolean updateValues,
                            IGPEnvironmentManager pEnvMgr)
                     throws IOException,
                            AutomationException

Validates the given set of values.

Product Availability

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

Specified by:

validate in interface IGPToolExtension

Parameters:

paramvalues - A reference to a com.esri.arcgis.system.IArray (in)

updateValues - The updateValues (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(IArray paramvalues,
                    ITrackCancel trackCancel,
                    IGPEnvironmentManager pEnvMgr,
                    IGPMessages messages)
             throws IOException,
                    AutomationException

Executes the tool extension given the set of parameter values.

Product Availability

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

Specified by:

execute in interface IGPToolExtension

Parameters:

paramvalues - A reference to a com.esri.arcgis.system.IArray (in)

trackCancel - A reference to a com.esri.arcgis.system.ITrackCancel (in)

pEnvMgr - A reference to a com.esri.arcgis.geoprocessing.IGPEnvironmentManager (in)

messages - A reference to a com.esri.arcgis.geodatabase.IGPMessages (in)

Throws:

IOException - If there are interop problems.

AutomationException - If the ArcObject component throws an exception.

synchronizeMetadata

public void synchronizeMetadata(int action,
                                int interval,
                                IPropertySet metadata)
                         throws IOException,
                                AutomationException

Updates the given metadata property set with the current tool extension properties.

Product Availability

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

Specified by:

synchronizeMetadata in interface IGPToolExtension

Parameters:

action - A com.esri.arcgis.geodatabase.esriMetadataSyncAction constant (in)

interval - The interval (in)

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

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.

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.

interfaceSupportsErrorInfo

public void interfaceSupportsErrorInfo(GUID riid)
                                throws IOException,
                                       AutomationException

interfaceSupportsErrorInfo

Description

Indicates whether the interface supports IErrorInfo.

Product Availability

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

Supported Platforms

Windows, Solaris, Linux

Specified by:

interfaceSupportsErrorInfo in interface ISupportErrorInfo

Parameters:

riid - A Structure: com.esri.arcgis.support.ms.stdole.GUID (in)

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