com.esri.arcgis.catalog
Class GxToolboxExtension

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

All Implemented Interfaces:

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

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

COM Class 'GxToolboxExtension'. Generated 3/19/2015 1:20:49 PM from 'C:\ArcGIS\COM\esriCatalog.olb'

Description 'GX Toolbox object factory.' 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

Fields inherited from interface com.esri.arcgis.catalog.IGxDatabaseExtension

IID, IIDcdb0cc46_4e87_11d3_9f52_00c04f6bdf06, xxDummy

Fields inherited from interface com.esri.arcgis.catalog.IGxPasteTargetHelper

IID, IIDc8b779c7_9ce0_45f9_bb53_c09898688c25, xxDummy

Constructor Summary

GxToolboxExtension()
Constructs a GxToolboxExtension using ArcGIS Engine.

GxToolboxExtension(java.lang.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(java.lang.Object o) Compare this object with another
IEnumGxObject	getChildren(IWorkspace workspace) Get children.
static java.lang.String	getClsid() getClsid.
com.esri.arcgis.interop.Dispatch	getJintegraDispatch() Deprecated. Internal use only.
java.lang.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	release() Release a GxToolboxExtension.
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

Constructor Detail

GxToolboxExtension

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

Constructs a GxToolboxExtension using ArcGIS Engine.

Throws:

java.io.IOException - if there are interop problems

java.net.UnknownHostException - if there are interop problems

GxToolboxExtension

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

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

Specified by:

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

setCatalogByRef

public void setCatalogByRef(IGxCatalog rhs1)
                     throws java.io.IOException,
                            AutomationException

Attach the catalog to the database extension.

Specified by:

setCatalogByRef in interface IGxDatabaseExtension

Parameters:

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

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

Specified by:

getName in interface IGxDatabaseExtension

Returns:

The extensionName

Throws:

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

AutomationException - If the ArcObject component throws an exception.

hasChildren

public boolean hasChildren(IWorkspace workspace)
                    throws java.io.IOException,
                           AutomationException

Verify if this extension has children.

Specified by:

hasChildren in interface IGxDatabaseExtension

Parameters:

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

Returns:

The hasChildren

Throws:

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

AutomationException - If the ArcObject component throws an exception.

getChildren

public IEnumGxObject getChildren(IWorkspace workspace)
                          throws java.io.IOException,
                                 AutomationException

Get children.

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:

java.io.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 java.io.IOException,
                   AutomationException

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

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:

java.io.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 java.io.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.

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:

java.io.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 java.io.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.

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:

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

AutomationException - If the ArcObject component throws an exception.