com.esri.arcgis.schematic
Class NgBoundedFilter

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

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

Graphic bounded filter object.

Product Availability

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

See Also:
Serialized Form

Constructor Summary
NgBoundedFilter(Object obj)
          Construct a NgBoundedFilter using a reference to such an object returned from ArcGIS Engine or Server.
 
Method Summary
 void addPatternModel(INgPatternModel patternModel)
          Relates the pattern model 'patternModel' to the bounded property filter.
 boolean equals(Object o)
          Compare this object with another
 Object getEffect(int effect)
          Returns the effect 'effect' set for the bounded property filter (see esriNgBoundedFilterEffect).
 INgFilterEffects getFilterEffects()
          List of the effects defined for the bounded property filter.
 String getName()
          Name of the bounded property filter.
 int getNumber()
          Number associated with the bounded property filter.
 INgPatternModels getPatternModels()
          List of the pattern models related to the bounded property filter.
 INgBoundedProperty getProperty()
          Bounded property related to the bounded 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 bounded property filter.
 int getType()
          Type of the property filter.
 int hashCode()
          the hashcode for this object
 boolean isEffectSet(int effect)
          Indicates if the effect 'effect' related to the bounded property filter is set (see esriNgBoundedFilterEffect).
 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 bounded property filter is set (see esriNgSubSymbolEffect).
 void removeEffect(int effect)
          Removes the effect or restores the default effect 'effect' set for the bounded property filter.
 void removePatternModel(INgPatternModel patternModel)
          Removes the relation between the bounded property filter and the pattern model 'patterModel'.
 void removePatternModels()
          Removes the relations between the bounded 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 bounded property filter.
 void setEffect(int effect, Object effValue)
          Modifies the effect 'effect' set for the bounded property filter (see esriNgBoundedFilterEffect).
 void setName(String pVal)
          Name of the bounded 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 bounded 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

NgBoundedFilter

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

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

Throws:
IOException - if there are interop problems NgBoundedFilter theNgBoundedFilter = (NgBoundedFilter) 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 bounded property filter.

Description

This number is defined when the bounded filter is created:

- either by calling the INgBoundedProperty AddFilter method in the program code

- or through ArcGIS Schematics Designer, when the bounded 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.

Specified by:
getNumber in interface INgBoundedFilter
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:
INgBoundedProperty.addFilter(int, String, java.lang.Object, java.lang.Object)

getName

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

Description

This name is defined when the bounded filter is created:

- either by calling the INgBoundedProperty AddFilter method in the program code

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

Product Availability

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

Specified by:
getName in interface INgBoundedFilter
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:
INgBoundedProperty.addFilter(int, String, java.lang.Object, java.lang.Object)

setName

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

Product Availability

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

Specified by:
setName in interface INgBoundedFilter
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.

getEffect

public Object getEffect(int effect)
                 throws IOException,
                        AutomationException
Returns the effect 'effect' set for the bounded property filter (see esriNgBoundedFilterEffect).

Product Availability

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

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

setEffect

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

Product Availability

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

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

removeEffect

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

Description

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

Product Availability

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

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

isEffectSet

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

Description

By default, Schematics automatically sets default values for some bounded filter effects (see the List of the bounded 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 bounded filter's characteristics have been set through Schematics Designer

- or by calling the SetEffect method in the code.


List of the bounded filter effect default values


For details on all possible bounded filter effects, see Constants for Bounded Filter Effects

Product Availability

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

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

setSubSymbolEffect

public 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 bounded property filter.

Product Availability

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

Specified by:
setSubSymbolEffect in interface INgBoundedFilter
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:
INgBoundedFilter.removeSubSymbolEffect(String, int), INgBoundedFilter.getSubSymbolEffect(String, int)

removeSubSymbolEffect

public 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 bounded property filter.

Product Availability

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

Specified by:
removeSubSymbolEffect in interface INgBoundedFilter
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:
INgBoundedFilter.setSubSymbolEffect(String, int, java.lang.Object), INgBoundedFilter.getSubSymbolEffect(String, int)

getProperty

public INgBoundedProperty getProperty()
                               throws IOException,
                                      AutomationException
Bounded property related to the bounded property filter.

Product Availability

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

Specified by:
getProperty in interface INgBoundedFilter
Returns:
A reference to a com.esri.arcgis.schematic.INgBoundedProperty
Throws:
IOException - If there are interop problems.
AutomationException - If the ArcObject component throws an exception.

getSubSymbolEffect

public 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 bounded property filter.

Description

The sub-symbol's effects may be set:

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

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

Product Availability

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

Specified by:
getSubSymbolEffect in interface INgBoundedFilter
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:
INgBoundedFilter.setSubSymbolEffect(String, int, java.lang.Object), INgBoundedFilter.removeSubSymbolEffect(String, int)

isSubSymbolEffectSet

public 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 bounded 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 bounded filter has been set; else it returns FALSE (see esriNgSubSymbolEffect topic).

The sub-symbol's effect can be set:

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

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

Product Availability

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

Specified by:
isSubSymbolEffectSet in interface INgBoundedFilter
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:
INgBoundedFilter.setSubSymbolEffect(String, int, java.lang.Object), INgBoundedFilter.getSubSymbolEffect(String, int)

getPatternModels

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

Product Availability

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

Specified by:
getPatternModels in interface INgBoundedFilter
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:
INgLink.getPatternModels(), INgDiscreteFilter.getPatternModels(), INgElementType.getPatternModels()

removePatternModels

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

Product Availability

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

Specified by:
removePatternModels in interface INgBoundedFilter
Throws:
IOException - If there are interop problems.
AutomationException - If the ArcObject component throws an exception.
See Also:
INgBoundedFilter.removePatternModel(com.esri.arcgis.schematic.INgPatternModel)

removePatternModel

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

Product Availability

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

Specified by:
removePatternModel in interface INgBoundedFilter
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:
INgBoundedFilter.addPatternModel(com.esri.arcgis.schematic.INgPatternModel), INgBoundedFilter.removePatternModels()

addPatternModel

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

Description

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

Product Availability

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

Specified by:
addPatternModel in interface INgBoundedFilter
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), INgLink.addPatternModel(com.esri.arcgis.schematic.INgPatternModel), INgDiscreteFilter.addPatternModel(com.esri.arcgis.schematic.INgPatternModel)

getFilterEffects

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

Description

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

Product Availability

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

Specified by:
getFilterEffects in interface INgBoundedFilter
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:
INgBoundedFilter.getEffect(int)

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