com.esri.arcgis.schematic
Interface INgPropertyFilter

All Superinterfaces:
Serializable
All Known Implementing Classes:
INgPropertyFilterProxy, NgBoundedFilter, NgDiscreteFilter, NgPropertyFilter

public interface INgPropertyFilter
extends Serializable

Provides access to members that control the property filter.

Description

A discrete filter refers to a specific value of a property. It can be assigned a name that may be displayed on its related elements. One or several graphic effects matching the property value can be specified for each filter. The graphic effects thus defined apply to all the network elements that are then assigned this property value. In the following example, all the links in the network whose Road Type property value is equal to IS will be represented by a red dotted line.



A bounded filter corresponds to a range of values a property can take. Besides specifying the lower and higher bounds of the value range, the filter can be assigned a name that can be displayed on the element it is related to. One or more graphic effects matching the range of values defined for the property can be specified for each filter. The graphic effects thus defined apply to all the network elements that are then assigned a value within the corresponding value range. In the following example, all the links in the network whose Traffic property value is equal to 125 will be represented by a pattern composed of two red circles.

Product Availability

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

See Also:
INgDiscreteFilter, INgBoundedFilter

Method Summary
 String getName()
          Name of the property filter.
 int getNumber()
          Number associated with the property filter.
 int getType()
          Type of the property filter.
 void setName(String pVal)
          Name of the property filter.
 

Method Detail

getNumber

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.

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

getName

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.

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

setName

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

Product Availability

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

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

getType

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.

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