com.esri.arcgis.datainterop
Class FMEToolFactory

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

All Implemented Interfaces:

IGPToolExtensionFactory, com.esri.arcgis.interop.RemoteObjRef, ISupportErrorInfo, Serializable

public class FMEToolFactory
extends Object
implements com.esri.arcgis.interop.RemoteObjRef, IGPToolExtensionFactory, ISupportErrorInfo

FMEToolFactory Class

Product Availability

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

See Also:

Serialized Form

Constructor Summary

FMEToolFactory()
Constructs a FMEToolFactory using ArcGIS Engine.

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

Method Summary

boolean	canEdit() Returns whether or not the factory supports editing instances of the tool extension.
IGPToolExtension	create(int parent, IGPToolbox destination, String[] defaultName, String[] defaultDisplayName, String[] defaultDescription) Creates a new instance of a tool extension in the given toolbox.
void	edit(int parent, IGPToolExtension toolExtension) Invokes a window to edit a tool extension.
boolean	equals(Object o) Compare this object with another
static String	getClsid() getClsid.
IUID	getCLSID() The CLSID of the tool extension factory class.
int	getLargeImage() A 32x32 bitmap to associate with the tool extension.
int	getLargeInvalidImage() A 32x32 bitmap to associate with invalid instances of the tool extension.
int	getLargeUnlicensedImage() A 32x32 bitmap to associate with unlicensed instances of the tool extension.
int	getSmallImage() A 16x16 bitmap to associate with the tool extension.
int	getSmallInvalidImage() A 16x16 bitmap to associate with invalid instances of the tool extension.
int	getSmallUnlicensedImage() A 16x16 bitmap to associate with unlicensed instances of the tool extension.
String	getToolExtensionName() Name of the tool extension factory class.
int	hashCode() the hashcode for this object
void	interfaceSupportsErrorInfo(GUID riid) interfaceSupportsErrorInfo
void	postCreateTool(int parent, IGPToolExtension toolExtension) Called immediately following the creation of a new tool extension.

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

FMEToolFactory

public FMEToolFactory()
               throws IOException,
                      UnknownHostException

Constructs a FMEToolFactory using ArcGIS Engine.

Throws:

IOException - if there are interop problems

UnknownHostException - if there are interop problems

FMEToolFactory

public FMEToolFactory(Object obj)
               throws IOException

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

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

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

getCLSID

public IUID getCLSID()
              throws IOException,
                     AutomationException

The CLSID of the tool extension factory class.

Product Availability

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

Specified by:

getCLSID in interface IGPToolExtensionFactory

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.

getToolExtensionName

public String getToolExtensionName()
                            throws IOException,
                                   AutomationException

Name of the tool extension factory class.

Product Availability

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

Specified by:

getToolExtensionName in interface IGPToolExtensionFactory

Returns:

The name

Throws:

IOException - If there are interop problems.

AutomationException - If the ArcObject component throws an exception.

getSmallImage

public int getSmallImage()
                  throws IOException,
                         AutomationException

A 16x16 bitmap to associate with the tool extension.

Product Availability

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

Specified by:

getSmallImage in interface IGPToolExtensionFactory

Returns:

The image (A COM typedef)

Throws:

IOException - If there are interop problems.

AutomationException - If the ArcObject component throws an exception.

getLargeImage

public int getLargeImage()
                  throws IOException,
                         AutomationException

A 32x32 bitmap to associate with the tool extension.

Product Availability

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

Specified by:

getLargeImage in interface IGPToolExtensionFactory

Returns:

The image (A COM typedef)

Throws:

IOException - If there are interop problems.

AutomationException - If the ArcObject component throws an exception.

getSmallInvalidImage

public int getSmallInvalidImage()
                         throws IOException,
                                AutomationException

A 16x16 bitmap to associate with invalid instances of the tool extension.

Product Availability

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

Specified by:

getSmallInvalidImage in interface IGPToolExtensionFactory

Returns:

The image (A COM typedef)

Throws:

IOException - If there are interop problems.

AutomationException - If the ArcObject component throws an exception.

getLargeInvalidImage

public int getLargeInvalidImage()
                         throws IOException,
                                AutomationException

A 32x32 bitmap to associate with invalid instances of the tool extension.

Product Availability

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

Specified by:

getLargeInvalidImage in interface IGPToolExtensionFactory

Returns:

The image (A COM typedef)

Throws:

IOException - If there are interop problems.

AutomationException - If the ArcObject component throws an exception.

getSmallUnlicensedImage

public int getSmallUnlicensedImage()
                            throws IOException,
                                   AutomationException

A 16x16 bitmap to associate with unlicensed instances of the tool extension.

Product Availability

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

Specified by:

getSmallUnlicensedImage in interface IGPToolExtensionFactory

Returns:

The image (A COM typedef)

Throws:

IOException - If there are interop problems.

AutomationException - If the ArcObject component throws an exception.

getLargeUnlicensedImage

public int getLargeUnlicensedImage()
                            throws IOException,
                                   AutomationException

A 32x32 bitmap to associate with unlicensed instances of the tool extension.

Product Availability

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

Specified by:

getLargeUnlicensedImage in interface IGPToolExtensionFactory

Returns:

The image (A COM typedef)

Throws:

IOException - If there are interop problems.

AutomationException - If the ArcObject component throws an exception.

create

public IGPToolExtension create(int parent,
                               IGPToolbox destination,
                               String[] defaultName,
                               String[] defaultDisplayName,
                               String[] defaultDescription)
                        throws IOException,
                               AutomationException

Creates a new instance of a tool extension in the given toolbox.

Product Availability

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

Specified by:

create in interface IGPToolExtensionFactory

Parameters:

parent - The parent (A COM typedef) (in)

destination - A reference to a com.esri.arcgis.geoprocessing.IGPToolbox (in)

defaultName - The defaultName (out: use single element array)

defaultDisplayName - The defaultDisplayName (out: use single element array)

defaultDescription - The defaultDescription (out: use single element array)

Returns:

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

Throws:

IOException - If there are interop problems.

AutomationException - If the ArcObject component throws an exception.

postCreateTool

public void postCreateTool(int parent,
                           IGPToolExtension toolExtension)
                    throws IOException,
                           AutomationException

Called immediately following the creation of a new tool extension.

Product Availability

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

Specified by:

postCreateTool in interface IGPToolExtensionFactory

Parameters:

parent - The parent (A COM typedef) (in)

toolExtension - A reference to a com.esri.arcgis.geoprocessing.IGPToolExtension (in)

Throws:

IOException - If there are interop problems.

AutomationException - If the ArcObject component throws an exception.

canEdit

public boolean canEdit()
                throws IOException,
                       AutomationException

Returns whether or not the factory supports editing instances of the tool extension.

Product Availability

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

Specified by:

canEdit in interface IGPToolExtensionFactory

Returns:

The canEdit

Throws:

IOException - If there are interop problems.

AutomationException - If the ArcObject component throws an exception.

edit

public void edit(int parent,
                 IGPToolExtension toolExtension)
          throws IOException,
                 AutomationException

Invokes a window to edit a tool extension.

Product Availability

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

Specified by:

edit in interface IGPToolExtensionFactory

Parameters:

parent - The parent (A COM typedef) (in)

toolExtension - A reference to a com.esri.arcgis.geoprocessing.IGPToolExtension (in)

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.