com.esri.arcgis.schematic
Class NgPropertyFilter

java.lang.Object
  extended by com.esri.arcgis.schematic.NgPropertyFilter
All Implemented Interfaces:
com.esri.arcgis.interop.RemoteObjRef, INgPropertyFilter, Serializable

public class NgPropertyFilter
extends Object
implements com.esri.arcgis.interop.RemoteObjRef, INgPropertyFilter

Graphic property filter object.

Product Availability

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

See Also:
Serialized Form

Constructor Summary
NgPropertyFilter(Object obj)
          Construct a NgPropertyFilter using a reference to such an object returned from ArcGIS Engine or Server.
 
Method Summary
 boolean equals(Object o)
          Compare this object with another
 String getName()
          Name of the property filter.
 int getNumber()
          Number associated with the property filter.
 int getType()
          Type of the property filter.
 int hashCode()
          the hashcode for this object
 void setName(String pVal)
          Name of the property filter.
 
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

NgPropertyFilter

public NgPropertyFilter(Object obj)
                 throws IOException
Construct a NgPropertyFilter using a reference to such an object returned from ArcGIS Engine or Server. This is semantically equivalent to casting obj to NgPropertyFilter.
Casting to this class from the return value of a method will not work, as this class represents an abstract class in ArcObjects.
*
NgPropertyFilter o = (NgPropertyFilter)obj; // will not work

NgPropertyFilter o = new NgPropertyFilter(obj); // Use this constructor instead
* @param obj an object returned from ArcGIS Engine or Server

Throws:
IOException - if there are interop problems NgPropertyFilter theNgPropertyFilter = (NgPropertyFilter) obj;
Method Detail

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

getNumber

public int getNumber()
              throws IOException,
                     AutomationException
Number associated with the property filter.

Description

This number is defined when the property filter is created:

- Either by calling the INgBoundedProperty AddFilter or INgDiscreteProperty AddFilter methods in the program code,

- Or when it is created with ArcGIS Schematics Designer.

Product Availability

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

Specified by:
getNumber in interface INgPropertyFilter
Returns:
The pVal
Throws:
IOException - If there are interop problems.
AutomationException - If the ArcObject component throws an exception.
See Also:
INgPropertyFilter.getName()

getName

public String getName()
               throws IOException,
                      AutomationException
Name of the property filter.

Description

This name is defined when the property filter is created:

- Either by calling the INgBoundedProperty AddFilter or INgDiscreteProperty AddFilter methods in the program code,

- Or when it is created with ArcGIS Schematics Designer.

If needed, property filter name can be redefined.

Product Availability

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

Specified by:
getName in interface INgPropertyFilter
Returns:
The pVal
Throws:
IOException - If there are interop problems.
AutomationException - If the ArcObject component throws an exception.
See Also:
INgPropertyFilter.getNumber()

setName

public void setName(String pVal)
             throws IOException,
                    AutomationException
Name of the property filter.

Product Availability

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

Specified by:
setName in interface INgPropertyFilter
Parameters:
pVal - The pVal (in)
Throws:
IOException - If there are interop problems.
AutomationException - If the ArcObject component throws an exception.

getType

public int getType()
            throws IOException,
                   AutomationException
Type of the property filter.

Description

This depends on the type of the associated property: For a discrete property, the filter type is esriNgDiscreteFilterType and for a bounded property, esriNgBoundedFilterType.

Product Availability

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

Specified by:
getType in interface INgPropertyFilter
Returns:
A com.esri.arcgis.schematic.esriNgPropertyFilterType constant
Throws:
IOException - If there are interop problems.
AutomationException - If the ArcObject component throws an exception.
See Also:
INgDiscreteFilter, INgBoundedFilter