com.esri.arcgis.search
Class GPSearchFunctionFactory

java.lang.Object
  com.esri.arcgis.search.GPSearchFunctionFactory

All Implemented Interfaces:

IGPFunctionFactory, com.esri.arcgis.interop.RemoteObjRef, Serializable

public class GPSearchFunctionFactory
extends Object
implements com.esri.arcgis.interop.RemoteObjRef, IGPFunctionFactory

GeoProcessor Network Analyst Function Factory object.

See Also:

Serialized Form

Constructor Summary

GPSearchFunctionFactory()
Constructs a GPSearchFunctionFactory using ArcGIS Engine.

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

Method Summary

boolean	equals(Object o) Compare this object with another
String	getAlias() Alias of the geoprocessing function factory.
static String	getClsid() getClsid.
IUID	getCLSID() The class identifier (CLSID) of the geoprocessing function factory.
IGPFunction	getFunction(String name) Returns the geoprocessing function object with the given name.
IEnumGPEnvironment	getFunctionEnvironments() Returns an enumeration of the geoprocessing environments that the geoprocessing functions managed by this function factory use.
IGPName	getFunctionName(String name) Returns the geoprocessing function name object with the given name.
IEnumGPName	getFunctionNames() Returns an enumeration of function name objects of all the geoprocessing functions managed by this function factory.
String	getName() Name of the geoprocessing function factory.
int	hashCode() the hashcode for this object

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

GPSearchFunctionFactory

public GPSearchFunctionFactory()
                        throws IOException,
                               UnknownHostException

Constructs a GPSearchFunctionFactory using ArcGIS Engine.

Throws:

IOException - if there are interop problems

UnknownHostException - if there are interop problems

GPSearchFunctionFactory

public GPSearchFunctionFactory(Object obj)
                        throws IOException

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

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

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 class identifier (CLSID) of the geoprocessing function factory.

Product Availability

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

Supported Platforms

Windows

Specified by:

getCLSID in interface IGPFunctionFactory

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.

getName

public String getName()
               throws IOException,
                      AutomationException

Name of the geoprocessing function factory.

Product Availability

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

Supported Platforms

Windows

Specified by:

getName in interface IGPFunctionFactory

Returns:

The name

Throws:

IOException - If there are interop problems.

AutomationException - If the ArcObject component throws an exception.

getAlias

public String getAlias()
                throws IOException,
                       AutomationException

Alias of the geoprocessing function factory.

Product Availability

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

Supported Platforms

Windows

Specified by:

getAlias in interface IGPFunctionFactory

Returns:

The alias

Throws:

IOException - If there are interop problems.

AutomationException - If the ArcObject component throws an exception.

getFunction

public IGPFunction getFunction(String name)
                        throws IOException,
                               AutomationException

Returns the geoprocessing function object with the given name.

Product Availability

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

Supported Platforms

Windows

Specified by:

getFunction in interface IGPFunctionFactory

Parameters:

name - The name (in)

Returns:

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

Throws:

IOException - If there are interop problems.

AutomationException - If the ArcObject component throws an exception.

getFunctionName

public IGPName getFunctionName(String name)
                        throws IOException,
                               AutomationException

Returns the geoprocessing function name object with the given name.

Product Availability

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

Supported Platforms

Windows

Specified by:

getFunctionName in interface IGPFunctionFactory

Parameters:

name - The name (in)

Returns:

A reference to a com.esri.arcgis.geodatabase.IGPName

Throws:

IOException - If there are interop problems.

AutomationException - If the ArcObject component throws an exception.

getFunctionNames

public IEnumGPName getFunctionNames()
                             throws IOException,
                                    AutomationException

Returns an enumeration of function name objects of all the geoprocessing functions managed by this function factory.

Product Availability

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

Supported Platforms

Windows

Specified by:

getFunctionNames in interface IGPFunctionFactory

Returns:

A reference to a com.esri.arcgis.geodatabase.IEnumGPName

Throws:

IOException - If there are interop problems.

AutomationException - If the ArcObject component throws an exception.

getFunctionEnvironments

public IEnumGPEnvironment getFunctionEnvironments()
                                           throws IOException,
                                                  AutomationException

Returns an enumeration of the geoprocessing environments that the geoprocessing functions managed by this function factory use.

Product Availability

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

Supported Platforms

Windows

Specified by:

getFunctionEnvironments in interface IGPFunctionFactory

Returns:

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

Throws:

IOException - If there are interop problems.

AutomationException - If the ArcObject component throws an exception.