com.esri.arcgis.schematic
Class INgPropertyFilterProxy

java.lang.Object
  extended by com.esri.arcgis.interop.Dispatch
      extended by com.esri.arcgis.schematic.INgPropertyFilterProxy
All Implemented Interfaces:
INgPropertyFilter, Externalizable, Serializable

public class INgPropertyFilterProxy
extends com.esri.arcgis.interop.Dispatch
implements INgPropertyFilter, 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, Serialized Form

Field Summary
 
Fields inherited from class com.esri.arcgis.interop.Dispatch
DISPATCH_METHOD, DISPATCH_PROPERTYGET, DISPATCH_PROPERTYPUT, DISPATCH_PROPERTYPUTREF, E
 
Constructor Summary
  INgPropertyFilterProxy()
           
  INgPropertyFilterProxy(Object obj)
           
protected INgPropertyFilterProxy(Object obj, String iid)
           
 
Method Summary
 void addListener(String iidStr, Object theListener, Object theSource)
           
 String getName()
          Name of the property filter.
 int getNumber()
          Number associated with the property filter.
 int getType()
          Type of the property filter.
 void readExternal(ObjectInput in)
           
 void removeListener(String iidStr, Object theListener)
           
 void setName(String pVal)
          Name of the property filter.
 void writeExternal(ObjectOutput out)
           
 
Methods inherited from class com.esri.arcgis.interop.Dispatch
bindUsingMoniker, constructVtblPosTable, convertToNative, cookieForListener, createDispatch, createObjrefMonikerDisplayName, equals, getActiveObject, getActiveObject, getDefaultProperty, getDispatchIdOfName, getLastErrorCode, getMtsObjectContext, getObjRef, getPropertyByName, getPropertyByName, getVtblPos, hashCode, initDispatch, invoke, invokeMethodByName, invokeMethodByName, invokeMethodByName, invokePropertyGetByName, invokePropertyPutByName, invokePropertyPutByRefByName, isNativeMode, isObjRef, queryInterface, release, setNativeMode, setPropertyByName, toString, vtblInvoke
 
Methods inherited from class java.lang.Object
clone, finalize, getClass, notify, notifyAll, wait, wait, wait
 

Constructor Detail

INgPropertyFilterProxy

public INgPropertyFilterProxy()

INgPropertyFilterProxy

public INgPropertyFilterProxy(Object obj)
                       throws IOException
Throws:
IOException

INgPropertyFilterProxy

protected INgPropertyFilterProxy(Object obj,
                                 String iid)
                          throws IOException
Throws:
IOException
Method Detail

addListener

public void addListener(String iidStr,
                        Object theListener,
                        Object theSource)
                 throws IOException
Overrides:
addListener in class com.esri.arcgis.interop.Dispatch
Throws:
IOException

removeListener

public void removeListener(String iidStr,
                           Object theListener)
                    throws IOException
Overrides:
removeListener in class com.esri.arcgis.interop.Dispatch
Throws:
IOException

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

writeExternal

public void writeExternal(ObjectOutput out)
                   throws IOException
Specified by:
writeExternal in interface Externalizable
Overrides:
writeExternal in class com.esri.arcgis.interop.Dispatch
Throws:
IOException

readExternal

public void readExternal(ObjectInput in)
                  throws IOException,
                         ClassNotFoundException
Specified by:
readExternal in interface Externalizable
Overrides:
readExternal in class com.esri.arcgis.interop.Dispatch
Throws:
IOException
ClassNotFoundException