com.esri.arcgis.schematic
Interface INgDiscreteFilter

All Superinterfaces:
Serializable
All Known Implementing Classes:
INgDiscreteFilterProxy, NgDiscreteFilter

public interface INgDiscreteFilter
extends Serializable

Provides access to members that control the discrete property filter.

Description

A discrete property filter corresponds to a specific value of a discrete property.

A discrete filter can be created either through the Schematics Designer GUI when you define your project parameters or using the AddFilter method available from the INgDiscreteProperty interface in your code.

Product Availability

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

See Also:
INgDiscreteProperty.addFilter(int, String, java.lang.Object), INgDiscreteProperty, INgBoundedFilter, INgPropertyFilter

Method Summary
 void addPatternModel(INgPatternModel patternModel)
          Relates the pattern model 'patternModel' to the discrete property filter.
 Object getEffect(int effect)
          Returns the effect 'effect' set for the discrete property filter (see esriNgDiscreteFilterEffect).
 INgFilterEffects getFilterEffects()
          List of the effects defined for the discrete property filter.
 String getName()
          Name of the discrete property filter.
 int getNumber()
          Number associated with the discrete property filter.
 INgPatternModels getPatternModels()
          List of the pattern models related to the discrete property filter.
 INgDiscreteProperty getProperty()
          Discrete property related to the discrete property filter.
 Object getSubSymbolEffect(String subName, int effect)
          Returns the effect 'effect' set for the sub-symbol named 'subName' (see esriNgSubSymbolEffect) inside the symbol used to represent the discrete property filter.
 boolean isEffectSet(int effect)
          Indicates if the effect 'effect' related to the discrete property filter is set (see esriNgDiscreteFilterEffect).
 boolean isSubSymbolEffectSet(String subName, int effect)
          Indicates if the effect 'effect' related to the sub-symbol named 'subName' inside the symbol used to represent the discrete property filter is set (see esriNgSubSymbolEffect).
 void removeEffect(int effect)
          Removes the effect or restores the default effect 'effect' set for the discrete property filter (see esriNgDiscreteFilterEffect).
 void removePatternModel(INgPatternModel patternModel)
          Removes the relation between the discrete property filter and the pattern model 'patterModel'.
 void removePatternModels()
          Removes the relations between the discrete property filter and all its pattern models.
 void removeSubSymbolEffect(String subName, int effect)
          Removes the effect 'effect' for the sub-symbol named 'subName' inside the symbol used to represent the discrete property filter.
 void setEffect(int effect, Object effValue)
          Modifies the effect 'effect' set for the discrete property filter (see esriNgDiscreteFilterEffect).
 void setName(String pVal)
          Name of the discrete property filter.
 void setSubSymbolEffect(String subName, int effect, Object effValue)
          Sets the effect 'effect' for the sub-symbol named 'subName' (see esriNgSubSymbolEffect) inside the symbol used to represent the discrete property filter.
 

Method Detail

getNumber

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

Description

This number is defined when the discrete filter is created:

- either by calling the INgDiscreteProperty AddFilter method in the program code,

- or through ArcGIS Schematics Designer, when the discrete filter has been created.

Remarks

Contrary to the Name property, the Number property cannot 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.

getName

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

Description

This name is defined when the discrete filter is created:

- either by calling the INgDiscreteProperty AddFilter method in the program code,

- or through ArcGIS Schematics Designer, when the discrete filter has been created.

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:
INgDiscreteProperty.addFilter(int, String, java.lang.Object)

setName

void setName(String pVal)
             throws IOException,
                    AutomationException
Name of the discrete 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.

getEffect

Object getEffect(int effect)
                 throws IOException,
                        AutomationException
Returns the effect 'effect' set for the discrete property filter (see esriNgDiscreteFilterEffect).

Product Availability

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

Parameters:
effect - A com.esri.arcgis.schematic.esriNgDiscreteFilterEffect constant (in)
Returns:
A Variant
Throws:
IOException - If there are interop problems.
AutomationException - If the ArcObject component throws an exception.
See Also:
INgDiscreteFilter.setEffect(int, java.lang.Object), INgDiscreteFilter.isEffectSet(int), INgDiscreteFilter.removeEffect(int)

setEffect

void setEffect(int effect,
               Object effValue)
               throws IOException,
                      AutomationException
Modifies the effect 'effect' set for the discrete property filter (see esriNgDiscreteFilterEffect).

Product Availability

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

Parameters:
effect - A com.esri.arcgis.schematic.esriNgDiscreteFilterEffect constant (in)
effValue - A Variant (in)
Throws:
IOException - If there are interop problems.
AutomationException - If the ArcObject component throws an exception.
See Also:
INgDiscreteFilter.isEffectSet(int), INgDiscreteFilter.removeEffect(int), INgDiscreteFilter.getEffect(int)

removeEffect

void removeEffect(int effect)
                  throws IOException,
                         AutomationException
Removes the effect or restores the default effect 'effect' set for the discrete property filter (see esriNgDiscreteFilterEffect).

Description

Note that, if removing an effect that is not set by default really removes the discrete filter effect, removing an effect that is always set returns the discrete filter effect to its default effect value.

Product Availability

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

Parameters:
effect - A com.esri.arcgis.schematic.esriNgDiscreteFilterEffect constant (in)
Throws:
IOException - If there are interop problems.
AutomationException - If the ArcObject component throws an exception.
See Also:
INgDiscreteFilter.setEffect(int, java.lang.Object), INgDiscreteFilter.isEffectSet(int), INgDiscreteFilter.getEffect(int)

isEffectSet

boolean isEffectSet(int effect)
                    throws IOException,
                           AutomationException
Indicates if the effect 'effect' related to the discrete property filter is set (see esriNgDiscreteFilterEffect).

Description

By default, Schematics automatically sets default values for some discrete filter effects (see the List of the discrete filter effect default values, below). For all these effects, the IsEffectSet method returns TRUE.


For the others effects (those that are not automatically set), the IsEffectSet method returns TRUE only if the effect has been set:

- either when the discrete filter's characteristics have been set through Schematics Designer,

- or by calling the SetEffect method in the code.


List of the discrete filter effect default values


For details on all possible discrete filter effects, see Constants for Discrete Filter Effects.

Product Availability

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

Parameters:
effect - A com.esri.arcgis.schematic.esriNgDiscreteFilterEffect constant (in)
Returns:
The isSet
Throws:
IOException - If there are interop problems.
AutomationException - If the ArcObject component throws an exception.
See Also:
INgDiscreteFilter.setEffect(int, java.lang.Object), INgDiscreteFilter.removeEffect(int), INgDiscreteFilter.getEffect(int)

setSubSymbolEffect

void setSubSymbolEffect(String subName,
                        int effect,
                        Object effValue)
                        throws IOException,
                               AutomationException
Sets the effect 'effect' for the sub-symbol named 'subName' (see esriNgSubSymbolEffect) inside the symbol used to represent the discrete property filter.

Product Availability

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

Parameters:
subName - The subName (in)
effect - A com.esri.arcgis.schematic.esriNgSubSymbolEffect constant (in)
effValue - A Variant (in)
Throws:
IOException - If there are interop problems.
AutomationException - If the ArcObject component throws an exception.
See Also:
INgDiscreteFilter, INgDiscreteFilter.removeSubSymbolEffect(String, int)

removeSubSymbolEffect

void removeSubSymbolEffect(String subName,
                           int effect)
                           throws IOException,
                                  AutomationException
Removes the effect 'effect' for the sub-symbol named 'subName' inside the symbol used to represent the discrete property filter.

Product Availability

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

Parameters:
subName - The subName (in)
effect - A com.esri.arcgis.schematic.esriNgSubSymbolEffect constant (in)
Throws:
IOException - If there are interop problems.
AutomationException - If the ArcObject component throws an exception.
See Also:
INgDiscreteFilter, INgDiscreteFilter.getSubSymbolEffect(String, int)

getProperty

INgDiscreteProperty getProperty()
                                throws IOException,
                                       AutomationException
Discrete property related to the discrete property filter.

Product Availability

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

Returns:
A reference to a com.esri.arcgis.schematic.INgDiscreteProperty
Throws:
IOException - If there are interop problems.
AutomationException - If the ArcObject component throws an exception.

getSubSymbolEffect

Object getSubSymbolEffect(String subName,
                          int effect)
                          throws IOException,
                                 AutomationException
Returns the effect 'effect' set for the sub-symbol named 'subName' (see esriNgSubSymbolEffect) inside the symbol used to represent the discrete property filter.

Description

The sub-symbol's effects may be set

- either when the discrete filter's characteristics have been set through Schematics Designer,


- or by calling the INgDiscreteFilter SetSubSymbolEffect method in the code.

Product Availability

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

Parameters:
subName - The subName (in)
effect - A com.esri.arcgis.schematic.esriNgSubSymbolEffect constant (in)
Returns:
A Variant
Throws:
IOException - If there are interop problems.
AutomationException - If the ArcObject component throws an exception.
See Also:
INgDiscreteFilter, INgDiscreteFilter.removeSubSymbolEffect(String, int)

isSubSymbolEffectSet

boolean isSubSymbolEffectSet(String subName,
                             int effect)
                             throws IOException,
                                    AutomationException
Indicates if the effect 'effect' related to the sub-symbol named 'subName' inside the symbol used to represent the discrete property filter is set (see esriNgSubSymbolEffect).

Description

Returns TRUE if the effect 'effect' for the subName sub-symbol inside the symbol used for the property discrete filter has been set; else it returns FALSE (see esriNgSubSymbolEffect topic).

The sub-symbol's effect can be set:

- either when the discrete filter's characteristics have been set through Schematics Designer,


- or by calling the INgDiscreteFilter SetSubSymbolEffect method in the code.

Product Availability

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

Parameters:
subName - The subName (in)
effect - A com.esri.arcgis.schematic.esriNgSubSymbolEffect constant (in)
Returns:
The isSet
Throws:
IOException - If there are interop problems.
AutomationException - If the ArcObject component throws an exception.
See Also:
INgDiscreteFilter.removeSubSymbolEffect(String, int), INgDiscreteFilter.setSubSymbolEffect(String, int, java.lang.Object)

getPatternModels

INgPatternModels getPatternModels()
                                  throws IOException,
                                         AutomationException
List of the pattern models related to the discrete property filter.

Product Availability

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

Returns:
A reference to a com.esri.arcgis.schematic.INgPatternModels
Throws:
IOException - If there are interop problems.
AutomationException - If the ArcObject component throws an exception.
See Also:
INgBoundedFilter.getPatternModels(), INgLink.getPatternModels(), INgElementType.getPatternModels()

removePatternModels

void removePatternModels()
                         throws IOException,
                                AutomationException
Removes the relations between the discrete property filter and all its pattern models.

Product Availability

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

Throws:
IOException - If there are interop problems.
AutomationException - If the ArcObject component throws an exception.
See Also:
INgDiscreteFilter.removePatternModel(com.esri.arcgis.schematic.INgPatternModel)

removePatternModel

void removePatternModel(INgPatternModel patternModel)
                        throws IOException,
                               AutomationException
Removes the relation between the discrete property filter and the pattern model 'patterModel'.

Product Availability

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

Parameters:
patternModel - A reference to a com.esri.arcgis.schematic.INgPatternModel (in)
Throws:
IOException - If there are interop problems.
AutomationException - If the ArcObject component throws an exception.
See Also:
INgDiscreteFilter.removePatternModels(), INgDiscreteFilter.addPatternModel(com.esri.arcgis.schematic.INgPatternModel)

addPatternModel

void addPatternModel(INgPatternModel patternModel)
                     throws IOException,
                            AutomationException
Relates the pattern model 'patternModel' to the discrete property filter.

Description

By associating a pattern model with a discrete property filter defined for a link element type, all the links associated with this discrete filter will be displayed with the patterns from this pattern model.

Product Availability

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

Parameters:
patternModel - A reference to a com.esri.arcgis.schematic.INgPatternModel (in)
Throws:
IOException - If there are interop problems.
AutomationException - If the ArcObject component throws an exception.
See Also:
INgElementType.addPatternModel(com.esri.arcgis.schematic.INgPatternModel), INgBoundedFilter.addPatternModel(com.esri.arcgis.schematic.INgPatternModel), INgLink.addPatternModel(com.esri.arcgis.schematic.INgPatternModel)

getFilterEffects

INgFilterEffects getFilterEffects()
                                  throws IOException,
                                         AutomationException
List of the effects defined for the discrete property filter.

Description

Note that if this method returns all the discrete filter effects, you can get a given effect by using the GetEffect method.

Product Availability

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

Returns:
A reference to a com.esri.arcgis.schematic.INgFilterEffects
Throws:
IOException - If there are interop problems.
AutomationException - If the ArcObject component throws an exception.
See Also:
INgDiscreteFilter.getEffect(int)