com.esri.arcgis.geoprocessing
Class GPToolName

java.lang.Object
  com.esri.arcgis.geoprocessing.GPToolName

All Implemented Interfaces:

IDatasetName, IGPToolName, com.esri.arcgis.interop.RemoteObjRef, IName, IPersist, IPersistStream, IXMLSerialize, java.io.Externalizable, java.io.Serializable

public class GPToolName
extends java.lang.Object
implements com.esri.arcgis.interop.RemoteObjRef, IName, IDatasetName, IGPToolName, IPersistStream, IXMLSerialize, java.io.Externalizable

COM Class 'GPToolName'. Generated 3/19/2015 1:20:44 PM from 'C:\ArcGIS\COM\esriGeoprocessing.olb'

Description 'Light-weight object referencing a geoprocessing tool.' 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.geodatabase.IDatasetName

IID, IID89e75917_c287_11d1_aa77_00c04fa33a15, xxDummy

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

IID, IID3cabeaaf_91a8_4c02_aa2f_95c9e01d1682, 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.IXMLSerialize

IID, IIDc8545045_6615_48e3_af27_52a0e5fc35e2, xxDummy

Constructor Summary

GPToolName()
Constructs a GPToolName using ArcGIS Engine.

GPToolName(java.lang.Object obj)
Deprecated. As of ArcGIS 9.2, replaced by normal Java casts.
GPToolName theGPToolName = (GPToolName) obj;

Method Summary

void	deserialize(IXMLSerializeData data) Deserializes an object from XML.
boolean	equals(java.lang.Object o) Compare this object with another
java.lang.String	getCategory() The category of the dataset.
void	getClassID(GUID[] pClassID) getClassID
static java.lang.String	getClsid() getClsid.
java.lang.String	getDescription() The description of the tool name object.
IUID	getDialogCLSID() The CLSID of the dialog object of the tool name.
java.lang.String	getDisplayName() The display name of the tool name object.
com.esri.arcgis.interop.Dispatch	getJintegraDispatch() Deprecated. Internal use only.
java.lang.String	getName() The name of the dataset.
java.lang.String	getNameString() The name string of the object.
void	getSizeMax(_ULARGE_INTEGER[] pcbSize) getSizeMax
IEnumDatasetName	getSubsetNames() Subset names contained within this dataset name.
IGPToolboxName	getToolboxName() The toolbox name of the tool name.
java.lang.String	getToolCategory() The category of the tool name object.
int	getToolType() The tool type of the tool name.
int	getType() The type of the dataset.
IWorkspaceName	getWorkspaceName() The WorkspaceName of the DatasetName.
int	hashCode() the hashcode for this object
void	isDirty() isDirty
void	load(IStream pstm) load
java.lang.Object	open() Opens the object referred to by this name.
void	readExternal(java.io.ObjectInput in)
void	release() Release a GPToolName.
void	save(IStream pstm, int fClearDirty) save
void	serialize(IXMLSerializeData data) Serializes an object to XML.
void	setCategory(java.lang.String category) The category of the dataset.
void	setDescription(java.lang.String description) The description of the tool name object.
void	setDialogCLSIDByRef(IUID ppClsid) The CLSID of the dialog object of the tool name.
void	setDisplayName(java.lang.String name) The display name of the tool name object.
void	setName(java.lang.String name) The name of the dataset.
void	setNameString(java.lang.String nameString) The name string of the object.
void	setToolboxNameByRef(IGPToolboxName toolboxName) The toolbox name of the tool name.
void	setToolCategory(java.lang.String path) The category of the tool name object.
void	setToolType(int type) The tool type of the tool name.
void	setWorkspaceNameByRef(IWorkspaceName workspaceName) The WorkspaceName of the DatasetName.
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

GPToolName

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

Constructs a GPToolName using ArcGIS Engine.

Throws:

java.io.IOException - if there are interop problems

java.net.UnknownHostException - if there are interop problems

GPToolName

public GPToolName(java.lang.Object obj)
           throws java.io.IOException

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

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

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

Specified by:

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

setNameString

public void setNameString(java.lang.String nameString)
                   throws java.io.IOException,
                          AutomationException

The name string of the object.

Remarks

The NameString property is reserved for future use. When implemented, it will return a string representation of the locational component of the name object that may be persisted by applications.

Product Availability

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

Supported Platforms

Windows, Solaris, Linux

Specified by:

setNameString in interface IName

Parameters:

nameString - The nameString (in)

Throws:

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

AutomationException - If the ArcObject component throws an exception.

getNameString

public java.lang.String getNameString()
                               throws java.io.IOException,
                                      AutomationException

The name string of the object.

Remarks

The NameString property is reserved for future use. When implemented, it will return a string representation of the locational component of the name object that may be persisted by applications.

Product Availability

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

Supported Platforms

Windows, Solaris, Linux

Specified by:

getNameString in interface IName

Returns:

The nameString

Throws:

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

AutomationException - If the ArcObject component throws an exception.

open

public java.lang.Object open()
                      throws java.io.IOException,
                             AutomationException

Opens the object referred to by this name.

Remarks

The Open method lets you instantiate the actual object given the name object.

Note: Opening a feature class that participates in a topology or geometric network will also open all other feature classes participating in the topology or geometric network in memory.

Example:

IName   pName = pFeatureClassName; 
pFeatureClass = new IFeatureClassProxy(pName.open());

Product Availability

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

Supported Platforms

Windows, Solaris, Linux

Specified by:

open in interface IName

Returns:

A reference to another Object (IUnknown)

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

The name of the dataset.

Specified by:

getName in interface IDatasetName

Returns:

The name

Throws:

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

AutomationException - If the ArcObject component throws an exception.

setName

public void setName(java.lang.String name)
             throws java.io.IOException,
                    AutomationException

The name of the dataset.

Specified by:

setName in interface IDatasetName

Parameters:

name - The name (in)

Throws:

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

AutomationException - If the ArcObject component throws an exception.

getType

public int getType()
            throws java.io.IOException,
                   AutomationException

The type of the dataset.

Specified by:

getType in interface IDatasetName

Returns:

A com.esri.arcgis.geodatabase.esriDatasetType constant

Throws:

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

AutomationException - If the ArcObject component throws an exception.

getCategory

public java.lang.String getCategory()
                             throws java.io.IOException,
                                    AutomationException

The category of the dataset.

Specified by:

getCategory in interface IDatasetName

Returns:

The category

Throws:

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

AutomationException - If the ArcObject component throws an exception.

setCategory

public void setCategory(java.lang.String category)
                 throws java.io.IOException,
                        AutomationException

The category of the dataset.

Specified by:

setCategory in interface IDatasetName

Parameters:

category - The category (in)

Throws:

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

AutomationException - If the ArcObject component throws an exception.

getWorkspaceName

public IWorkspaceName getWorkspaceName()
                                throws java.io.IOException,
                                       AutomationException

The WorkspaceName of the DatasetName.

Specified by:

getWorkspaceName in interface IDatasetName

Returns:

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

Throws:

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

AutomationException - If the ArcObject component throws an exception.

setWorkspaceNameByRef

public void setWorkspaceNameByRef(IWorkspaceName workspaceName)
                           throws java.io.IOException,
                                  AutomationException

The WorkspaceName of the DatasetName.

Specified by:

setWorkspaceNameByRef in interface IDatasetName

Parameters:

workspaceName - A reference to a com.esri.arcgis.geodatabase.IWorkspaceName (in)

Throws:

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

AutomationException - If the ArcObject component throws an exception.

getSubsetNames

public IEnumDatasetName getSubsetNames()
                                throws java.io.IOException,
                                       AutomationException

Subset names contained within this dataset name.

Specified by:

getSubsetNames in interface IDatasetName

Returns:

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

Throws:

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

AutomationException - If the ArcObject component throws an exception.

getDisplayName

public java.lang.String getDisplayName()
                                throws java.io.IOException,
                                       AutomationException

The display name of the tool name object.

Specified by:

getDisplayName in interface IGPToolName

Returns:

The name

Throws:

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

AutomationException - If the ArcObject component throws an exception.

setDisplayName

public void setDisplayName(java.lang.String name)
                    throws java.io.IOException,
                           AutomationException

The display name of the tool name object.

Specified by:

setDisplayName in interface IGPToolName

Parameters:

name - The name (in)

Throws:

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

AutomationException - If the ArcObject component throws an exception.

getDescription

public java.lang.String getDescription()
                                throws java.io.IOException,
                                       AutomationException

The description of the tool name object.

Specified by:

getDescription in interface IGPToolName

Returns:

The description

Throws:

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

AutomationException - If the ArcObject component throws an exception.

setDescription

public void setDescription(java.lang.String description)
                    throws java.io.IOException,
                           AutomationException

The description of the tool name object.

Specified by:

setDescription in interface IGPToolName

Parameters:

description - The description (in)

Throws:

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

AutomationException - If the ArcObject component throws an exception.

getToolCategory

public java.lang.String getToolCategory()
                                 throws java.io.IOException,
                                        AutomationException

The category of the tool name object.

Specified by:

getToolCategory in interface IGPToolName

Returns:

The path

Throws:

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

AutomationException - If the ArcObject component throws an exception.

setToolCategory

public void setToolCategory(java.lang.String path)
                     throws java.io.IOException,
                            AutomationException

The category of the tool name object.

Specified by:

setToolCategory in interface IGPToolName

Parameters:

path - The path (in)

Throws:

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

AutomationException - If the ArcObject component throws an exception.

getToolType

public int getToolType()
                throws java.io.IOException,
                       AutomationException

The tool type of the tool name.

Specified by:

getToolType in interface IGPToolName

Returns:

A com.esri.arcgis.geoprocessing.esriGPToolType constant

Throws:

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

AutomationException - If the ArcObject component throws an exception.

setToolType

public void setToolType(int type)
                 throws java.io.IOException,
                        AutomationException

The tool type of the tool name.

Specified by:

setToolType in interface IGPToolName

Parameters:

type - A com.esri.arcgis.geoprocessing.esriGPToolType constant (in)

Throws:

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

AutomationException - If the ArcObject component throws an exception.

getToolboxName

public IGPToolboxName getToolboxName()
                              throws java.io.IOException,
                                     AutomationException

The toolbox name of the tool name.

Specified by:

getToolboxName in interface IGPToolName

Returns:

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

Throws:

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

AutomationException - If the ArcObject component throws an exception.

setToolboxNameByRef

public void setToolboxNameByRef(IGPToolboxName toolboxName)
                         throws java.io.IOException,
                                AutomationException

The toolbox name of the tool name.

Specified by:

setToolboxNameByRef in interface IGPToolName

Parameters:

toolboxName - A reference to a com.esri.arcgis.geoprocessing.IGPToolboxName (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 the dialog object of the tool name.

Specified by:

getDialogCLSID in interface IGPToolName

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.

setDialogCLSIDByRef

public void setDialogCLSIDByRef(IUID ppClsid)
                         throws java.io.IOException,
                                AutomationException

The CLSID of the dialog object of the tool name.

Specified by:

setDialogCLSIDByRef in interface IGPToolName

Parameters:

ppClsid - A reference to a com.esri.arcgis.system.IUID (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.

serialize

public void serialize(IXMLSerializeData data)
               throws java.io.IOException,
                      AutomationException

Serializes an object to XML.

Specified by:

serialize in interface IXMLSerialize

Parameters:

data - A reference to a com.esri.arcgis.system.IXMLSerializeData (in)

Throws:

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

AutomationException - If the ArcObject component throws an exception.

deserialize

public void deserialize(IXMLSerializeData data)
                 throws java.io.IOException,
                        AutomationException

Deserializes an object from XML.

Specified by:

deserialize in interface IXMLSerialize

Parameters:

data - A reference to a com.esri.arcgis.system.IXMLSerializeData (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