com.esri.arcgis.catalog
Class GxToolboxExtension

java.lang.Object
  com.esri.arcgis.catalog.GxToolboxExtension

All Implemented Interfaces:

IGxDatabaseExtension, IGxPasteTargetHelper, com.esri.arcgis.interop.RemoteObjRef, Serializable

public class GxToolboxExtension
extends Object
implements com.esri.arcgis.interop.RemoteObjRef, IGxDatabaseExtension, IGxPasteTargetHelper

GX Toolbox object factory.

Product Availability

Available with ArcGIS Desktop.

See Also:

Serialized Form

Constructor Summary

GxToolboxExtension()
Constructs a GxToolboxExtension using ArcGIS Engine.

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

Method Summary

boolean	canPaste(IName name, IGxObject target, boolean[] moveOperation) Indicates if the specified name object may be pasted into the given target.
int	compare(IGxObject gxObject1, IGxObject gxObject2, boolean ascending) Check if the objects are children and if yes compare them.
boolean	equals(Object o) Compare this object with another
IEnumGxObject	getChildren(IWorkspace workspace) Get children.
static String	getClsid() getClsid.
String	getName() The name of the extension.
boolean	hasChildren(IWorkspace workspace) Verify if this extension has children.
int	hashCode() the hashcode for this object
boolean	paste(IName name, IGxObject target, boolean[] moveOperation) Pastes the specified name object into the given target.
void	setCatalogByRef(IGxCatalog rhs1) Attach the catalog to the database 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

GxToolboxExtension

public GxToolboxExtension()
                   throws IOException,
                          UnknownHostException

Constructs a GxToolboxExtension using ArcGIS Engine.

Throws:

IOException - if there are interop problems

UnknownHostException - if there are interop problems

GxToolboxExtension

public GxToolboxExtension(Object obj)
                   throws IOException

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

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

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

setCatalogByRef

public void setCatalogByRef(IGxCatalog rhs1)
                     throws IOException,
                            AutomationException

Attach the catalog to the database extension.

Product Availability

Available with ArcGIS Desktop.

Specified by:

setCatalogByRef in interface IGxDatabaseExtension

Parameters:

rhs1 - A reference to a com.esri.arcgis.catalog.IGxCatalog (in)

Throws:

IOException - If there are interop problems.

AutomationException - If the ArcObject component throws an exception.

getName

public String getName()
               throws IOException,
                      AutomationException

The name of the extension.

Product Availability

Available with ArcGIS Desktop.

Supported Platforms

Windows

Specified by:

getName in interface IGxDatabaseExtension

Returns:

The extensionName

Throws:

IOException - If there are interop problems.

AutomationException - If the ArcObject component throws an exception.

hasChildren

public boolean hasChildren(IWorkspace workspace)
                    throws IOException,
                           AutomationException

Verify if this extension has children.

Product Availability

Available with ArcGIS Desktop.

Supported Platforms

Windows

Specified by:

hasChildren in interface IGxDatabaseExtension

Parameters:

workspace - A reference to a com.esri.arcgis.geodatabase.IWorkspace (in)

Returns:

The hasChildren

Throws:

IOException - If there are interop problems.

AutomationException - If the ArcObject component throws an exception.

getChildren

public IEnumGxObject getChildren(IWorkspace workspace)
                          throws IOException,
                                 AutomationException

Get children.

Product Availability

Available with ArcGIS Desktop.

Supported Platforms

Windows

Specified by:

getChildren in interface IGxDatabaseExtension

Parameters:

workspace - A reference to a com.esri.arcgis.geodatabase.IWorkspace (in)

Returns:

A reference to a com.esri.arcgis.catalog.IEnumGxObject

Throws:

IOException - If there are interop problems.

AutomationException - If the ArcObject component throws an exception.

compare

public int compare(IGxObject gxObject1,
                   IGxObject gxObject2,
                   boolean ascending)
            throws IOException,
                   AutomationException

Check if the objects are children and if yes compare them.

Product Availability

Available with ArcGIS Desktop.

Supported Platforms

Windows

Specified by:

compare in interface IGxDatabaseExtension

Parameters:

gxObject1 - A reference to a com.esri.arcgis.catalog.IGxObject (in)

gxObject2 - A reference to a com.esri.arcgis.catalog.IGxObject (in)

ascending - The ascending (in)

Returns:

The result

Throws:

IOException - If there are interop problems.

AutomationException - If the ArcObject component throws an exception.

canPaste

public boolean canPaste(IName name,
                        IGxObject target,
                        boolean[] moveOperation)
                 throws IOException,
                        AutomationException

Indicates if the specified name object may be pasted into the given target. On output, moveOperation indicates if a subsequent paste operation would represent a move, or merely a copy, operation.

Product Availability

Available with ArcGIS Desktop.

Supported Platforms

Windows

Specified by:

canPaste in interface IGxPasteTargetHelper

Parameters:

name - A reference to a com.esri.arcgis.system.IName (in)

target - A reference to a com.esri.arcgis.catalog.IGxObject (in)

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

Returns:

The canPaste

Throws:

IOException - If there are interop problems.

AutomationException - If the ArcObject component throws an exception.

paste

public boolean paste(IName name,
                     IGxObject target,
                     boolean[] moveOperation)
              throws IOException,
                     AutomationException

Pastes the specified name object into the given target. On input, moveOperation indicates if this is a move operation. On output, it indicates if the objects have been moved, or merely copied.

Product Availability

Available with ArcGIS Desktop.

Supported Platforms

Windows

Specified by:

paste in interface IGxPasteTargetHelper

Parameters:

name - A reference to a com.esri.arcgis.system.IName (in)

target - A reference to a com.esri.arcgis.catalog.IGxObject (in)

moveOperation - The moveOperation (in/out: use single element array)

Returns:

The successfulPaste

Throws:

IOException - If there are interop problems.

AutomationException - If the ArcObject component throws an exception.