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, java.io.Externalizable, java.io.Serializable

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

COM Class 'FMETool'. Generated 3/19/2015 1:20:46 PM from 'C:\ArcGIS\COM\esriDataInterop.olb'

Description 'FMETool 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

static long

serialVersionUID

Fields inherited from interface com.esri.arcgis.geoprocessing.IGPToolExtension

IID, IIDad1cb977_d8b6_4d54_8c85_86d6e533649b, 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.IClone

IID, IID9bff8aeb_e415_11d0_943c_080009eebecb, xxDummy

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

IID, IIDdf0b3d60_548f_101b_8e65_08002b2bd119, xxDummy

Constructor Summary

FMETool()
Constructs a FMETool using ArcGIS Engine.

FMETool(java.lang.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(java.lang.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 java.lang.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.
com.esri.arcgis.interop.Dispatch	getJintegraDispatch() Deprecated. Internal use only.
IArray	getParameterInfo() The parameters required to execute the custom tool associated with this tool extension.
java.lang.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(java.io.ObjectInput in)
void	release() Release a FMETool.
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(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

FMETool

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

Constructs a FMETool using ArcGIS Engine.

Throws:

java.io.IOException - if there are interop problems

java.net.UnknownHostException - if there are interop problems

FMETool

public FMETool(java.lang.Object obj)
        throws java.io.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:

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

Deprecated. Internal use only.

Specified by:

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

release

public void release()

Release a FMETool.

Specified by:

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

getToolExtensionFactory

public IGPToolExtensionFactory getToolExtensionFactory()
                                                throws java.io.IOException,
                                                       AutomationException

The factory object associated with this tool extension.

Specified by:

getToolExtensionFactory in interface IGPToolExtension

Returns:

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

Throws:

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

AutomationException - If the ArcObject component throws an exception.

getCustomToolHelper

public IGPCustomToolHelper getCustomToolHelper()
                                        throws java.io.IOException,
                                               AutomationException

The custom tool helper object associated with the tool extension.

Specified by:

getCustomToolHelper in interface IGPToolExtension

Returns:

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

Throws:

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

AutomationException - If the ArcObject component throws an exception.

setCustomToolHelperByRef

public void setCustomToolHelperByRef(IGPCustomToolHelper helper)
                              throws java.io.IOException,
                                     AutomationException

The custom tool helper object associated with the tool extension.

Specified by:

setCustomToolHelperByRef in interface IGPToolExtension

Parameters:

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

Throws:

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

AutomationException - If the ArcObject component throws an exception.

getDialogCLSID

public IUID getDialogCLSID()
                    throws java.io.IOException,
                           AutomationException

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

Specified by:

getDialogCLSID in interface IGPToolExtension

Returns:

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

Throws:

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

AutomationException - If the ArcObject component throws an exception.

getParameterInfo

public IArray getParameterInfo()
                        throws java.io.IOException,
                               AutomationException

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

Specified by:

getParameterInfo in interface IGPToolExtension

Returns:

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

Throws:

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

AutomationException - If the ArcObject component throws an exception.

isValid

public boolean isValid()
                throws java.io.IOException,
                       AutomationException

Returns whether or not the tool extension is can be executed.

Specified by:

isValid in interface IGPToolExtension

Returns:

The valid

Throws:

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

AutomationException - If the ArcObject component throws an exception.

isLicensedForProduct

public boolean isLicensedForProduct()
                             throws java.io.IOException,
                                    AutomationException

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

Specified by:

isLicensedForProduct in interface IGPToolExtension

Returns:

The isLicensed

Throws:

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

AutomationException - If the ArcObject component throws an exception.

isLicensed

public boolean isLicensed()
                   throws java.io.IOException,
                          AutomationException

Returns whether or not the tool extension has all necessary product licenses to be executed.

Specified by:

isLicensed in interface IGPToolExtension

Returns:

The isLicensed

Throws:

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

AutomationException - If the ArcObject component throws an exception.

canEditSource

public boolean canEditSource()
                      throws java.io.IOException,
                             AutomationException

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

Specified by:

canEditSource in interface IGPToolExtension

Returns:

The canEdit

Throws:

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

AutomationException - If the ArcObject component throws an exception.

getRenderer

public java.lang.Object getRenderer(IGPParameter pParam)
                             throws java.io.IOException,
                                    AutomationException

Returns a custom renderer for a given parameter.

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:

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

Validates the given set of values.

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:

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

Executes the tool extension given the set of parameter values.

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:

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

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

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:

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.

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.

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.

interfaceSupportsErrorInfo

public void interfaceSupportsErrorInfo(GUID riid)
                                throws java.io.IOException,
                                       AutomationException

interfaceSupportsErrorInfo

Specified by:

interfaceSupportsErrorInfo in interface ISupportErrorInfo

Parameters:

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

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