com.esri.arcgis.catalog
Class GxFilterDataElements

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

All Implemented Interfaces:

IGxFilterDataElements, IGxObjectFilter, com.esri.arcgis.interop.RemoteObjRef, Serializable

public class GxFilterDataElements
extends Object
implements com.esri.arcgis.interop.RemoteObjRef, IGxFilterDataElements, IGxObjectFilter

A filter for displaying/choosing data elements.

Product Availability

Available with ArcGIS Desktop.

Supported Platforms

Windows

See Also:

Serialized Form

Constructor Summary

GxFilterDataElements()
Constructs a GxFilterDataElements using ArcGIS Engine.

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

Method Summary

boolean	canChooseObject(IGxObject object, int[] result) Indicates if the given object can be chosen.
boolean	canDisplayObject(IGxObject object) Indicates if the given object can be displayed.
boolean	canSaveObject(IGxObject location, String newObjectName, boolean[] objectAlreadyExists) Indicates if a new object named newObjectName could be saved in the specified location.
boolean	equals(Object o) Compare this object with another
IGPDomain	getChooseDomain() Data element domain.
static String	getClsid() getClsid.
String	getDescription() A string that describes what this filter does.
IGPDomain	getDisplayDomain() Data element domain.
String	getName() A user-friendly name identifying this filter.
int	hashCode() the hashcode for this object
void	setChooseDomainByRef(IGPDomain domain) Data element domain.
void	setDescription(String rhs1) Filter description.
void	setDisplayDomainByRef(IGPDomain domain) Data element domain.
void	setName(String rhs1) Filter name.

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

GxFilterDataElements

public GxFilterDataElements()
                     throws IOException,
                            UnknownHostException

Constructs a GxFilterDataElements using ArcGIS Engine.

Throws:

IOException - if there are interop problems

UnknownHostException - if there are interop problems

GxFilterDataElements

public GxFilterDataElements(Object obj)
                     throws IOException

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

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

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

getChooseDomain

public IGPDomain getChooseDomain()
                          throws IOException,
                                 AutomationException

Data element domain.

Product Availability

Available with ArcGIS Desktop.

Supported Platforms

Windows

Specified by:

getChooseDomain in interface IGxFilterDataElements

Returns:

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

Throws:

IOException - If there are interop problems.

AutomationException - If the ArcObject component throws an exception.

setChooseDomainByRef

public void setChooseDomainByRef(IGPDomain domain)
                          throws IOException,
                                 AutomationException

Data element domain.

Product Availability

Available with ArcGIS Desktop.

Specified by:

setChooseDomainByRef in interface IGxFilterDataElements

Parameters:

domain - A reference to a com.esri.arcgis.geodatabase.IGPDomain (in)

Throws:

IOException - If there are interop problems.

AutomationException - If the ArcObject component throws an exception.

getDisplayDomain

public IGPDomain getDisplayDomain()
                           throws IOException,
                                  AutomationException

Data element domain.

Product Availability

Available with ArcGIS Desktop.

Supported Platforms

Windows

Specified by:

getDisplayDomain in interface IGxFilterDataElements

Returns:

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

Throws:

IOException - If there are interop problems.

AutomationException - If the ArcObject component throws an exception.

setDisplayDomainByRef

public void setDisplayDomainByRef(IGPDomain domain)
                           throws IOException,
                                  AutomationException

Data element domain.

Product Availability

Available with ArcGIS Desktop.

Specified by:

setDisplayDomainByRef in interface IGxFilterDataElements

Parameters:

domain - A reference to a com.esri.arcgis.geodatabase.IGPDomain (in)

Throws:

IOException - If there are interop problems.

AutomationException - If the ArcObject component throws an exception.

setName

public void setName(String rhs1)
             throws IOException,
                    AutomationException

Filter name.

Product Availability

Available with ArcGIS Desktop.

Supported Platforms

Windows

Specified by:

setName in interface IGxFilterDataElements

Parameters:

rhs1 - The rhs1 (in)

Throws:

IOException - If there are interop problems.

AutomationException - If the ArcObject component throws an exception.

setDescription

public void setDescription(String rhs1)
                    throws IOException,
                           AutomationException

Filter description.

Product Availability

Available with ArcGIS Desktop.

Supported Platforms

Windows

Specified by:

setDescription in interface IGxFilterDataElements

Parameters:

rhs1 - The rhs1 (in)

Throws:

IOException - If there are interop problems.

AutomationException - If the ArcObject component throws an exception.

getName

public String getName()
               throws IOException,
                      AutomationException

A user-friendly name identifying this filter.

Product Availability

Available with ArcGIS Desktop.

Supported Platforms

Windows

Specified by:

getName in interface IGxObjectFilter

Returns:

The name

Throws:

IOException - If there are interop problems.

AutomationException - If the ArcObject component throws an exception.

getDescription

public String getDescription()
                      throws IOException,
                             AutomationException

A string that describes what this filter does.

Product Availability

Available with ArcGIS Desktop.

Supported Platforms

Windows

Specified by:

getDescription in interface IGxObjectFilter

Returns:

The description

Throws:

IOException - If there are interop problems.

AutomationException - If the ArcObject component throws an exception.

canDisplayObject

public boolean canDisplayObject(IGxObject object)
                         throws IOException,
                                AutomationException

Indicates if the given object can be displayed.

Product Availability

Available with ArcGIS Desktop.

Supported Platforms

Windows

Specified by:

canDisplayObject in interface IGxObjectFilter

Parameters:

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

Returns:

The canDisplay

Throws:

IOException - If there are interop problems.

AutomationException - If the ArcObject component throws an exception.

canChooseObject

public boolean canChooseObject(IGxObject object,
                               int[] result)
                        throws IOException,
                               AutomationException

Indicates if the given object can be chosen.

Product Availability

Available with ArcGIS Desktop.

Supported Platforms

Windows

Specified by:

canChooseObject in interface IGxObjectFilter

Parameters:

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

result - A com.esri.arcgis.catalog.esriDoubleClickResult constant (in/out: use single element array)

Returns:

The canChoose

Throws:

IOException - If there are interop problems.

AutomationException - If the ArcObject component throws an exception.

canSaveObject

public boolean canSaveObject(IGxObject location,
                             String newObjectName,
                             boolean[] objectAlreadyExists)
                      throws IOException,
                             AutomationException

Indicates if a new object named newObjectName could be saved in the specified location. If objectAlreadyExists is set to True, a confirmation dialog will appear asking if the existing object should be replaced.

Product Availability

Available with ArcGIS Desktop.

Supported Platforms

Windows

Specified by:

canSaveObject in interface IGxObjectFilter

Parameters:

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

newObjectName - The newObjectName (in)

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

Returns:

The canSave

Throws:

IOException - If there are interop problems.

AutomationException - If the ArcObject component throws an exception.