com.esri.arcgis.search
Class GPSearchFunctionFactory

java.lang.Object
  extended by com.esri.arcgis.search.GPSearchFunctionFactory
All Implemented Interfaces:
IGPFunctionFactory, com.esri.arcgis.interop.RemoteObjRef, java.io.Serializable

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

COM Class 'GPSearchFunctionFactory'. Generated 3/19/2015 1:20:50 PM from 'C:\ArcGIS\COM\esriSearch.tlb'

Description 'GeoProcessor Network Analyst Function Factory object.' 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

Constructor Summary
GPSearchFunctionFactory()
          Constructs a GPSearchFunctionFactory using ArcGIS Engine.
GPSearchFunctionFactory(java.lang.Object obj)
          Deprecated. As of ArcGIS 9.2, replaced by normal Java casts.
GPSearchFunctionFactory theGPSearchFunctionFactory = (GPSearchFunctionFactory) obj;
 
Method Summary
 boolean equals(java.lang.Object o)
          Compare this object with another
 java.lang.String getAlias()
          Alias of the geoprocessing function factory.
static java.lang.String getClsid()
          getClsid.
 IUID getCLSID()
          The class identifier (CLSID) of the geoprocessing function factory.
 IGPFunction getFunction(java.lang.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(java.lang.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.
 com.esri.arcgis.interop.Dispatch getJintegraDispatch()
          Deprecated. Internal use only.
 java.lang.String getName()
          Name of the geoprocessing function factory.
 int hashCode()
          the hashcode for this object
 void release()
          Release a GPSearchFunctionFactory.
 
Methods inherited from class java.lang.Object
clone, finalize, getClass, notify, notifyAll, toString, wait, wait, wait
 

Constructor Detail

GPSearchFunctionFactory

public GPSearchFunctionFactory()
                        throws java.io.IOException,
                               java.net.UnknownHostException
Constructs a GPSearchFunctionFactory using ArcGIS Engine.

Throws:
java.io.IOException - if there are interop problems
java.net.UnknownHostException - if there are interop problems

GPSearchFunctionFactory

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

Specified by:
release in interface com.esri.arcgis.interop.RemoteObjRef

getCLSID

public IUID getCLSID()
              throws java.io.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:
java.io.IOException - If there are interop problems.
AutomationException - If the ArcObject component throws an exception.

getName

public java.lang.String getName()
                         throws java.io.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:
java.io.IOException - If there are interop problems.
AutomationException - If the ArcObject component throws an exception.

getAlias

public java.lang.String getAlias()
                          throws java.io.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:
java.io.IOException - If there are interop problems.
AutomationException - If the ArcObject component throws an exception.

getFunction

public IGPFunction getFunction(java.lang.String name)
                        throws java.io.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:
java.io.IOException - If there are interop problems.
AutomationException - If the ArcObject component throws an exception.

getFunctionName

public IGPName getFunctionName(java.lang.String name)
                        throws java.io.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:
java.io.IOException - If there are interop problems.
AutomationException - If the ArcObject component throws an exception.

getFunctionNames

public IEnumGPName getFunctionNames()
                             throws java.io.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:
java.io.IOException - If there are interop problems.
AutomationException - If the ArcObject component throws an exception.

getFunctionEnvironments

public IEnumGPEnvironment getFunctionEnvironments()
                                           throws java.io.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:
java.io.IOException - If there are interop problems.
AutomationException - If the ArcObject component throws an exception.