com.esri.arcgis.schematic
Class NgDiscreteProperty

java.lang.Object
  com.esri.arcgis.schematic.NgDiscreteProperty

All Implemented Interfaces:

com.esri.arcgis.interop.RemoteObjRef, INgDiscreteProperty, INgProperty, Serializable

public class NgDiscreteProperty
extends Object
implements com.esri.arcgis.interop.RemoteObjRef, INgDiscreteProperty, INgProperty

Graphic discrete property object.

Product Availability

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

See Also:

Serialized Form

Constructor Summary

NgDiscreteProperty(Object obj)
Construct a NgDiscreteProperty using a reference to such an object returned from ArcGIS Engine or Server.

Method Summary

INgDiscreteFilter	addFilter(int filterNum, String name, Object value) Creates the filter 'filterNum' named 'name' for the property value 'value'.
void	delete() Deletes the property.
void	deleteFilter(int filterNum) Deletes the discrete filter 'filterNum'.
boolean	equals(Object o) Compare this object with another
INgAttribute	getAssociatedAttribute() Attribute the property is associated with.
INgFlagModel	getDisplayFlagModel() Flag model used by the property.
Object	getEffect(int effect) Returns the effect 'effect' set for the property (see esriNgPropertyEffect).
INgElements	getElementsByFilter(INgDiagram diagram, int filterNum, int mode) Returns all the elements contained in the diagram 'Diagram' that match the 'filternum' discrete filter (mode=esriNgFilterEqual) or that do not match the 'filterNum' discrete filter (mode = esriNgFilterDifferent) (see esriNgFilterSelectionMode).
INgElementType	getElementType() Element type the discrete property applies to.
INgDiscreteFilters	getFilters() Collection of the discrete filters defined for the discrete property.
String	getName() Name of the discrete property.
int	getType() Type of the property (see esriNgPropertyType).
int	hashCode() the hashcode for this object
boolean	isEffectSet(int effect) Indicates if the effect 'effect' related to the property is set (see esriNgPropertyEffect).
void	removeEffect(int effect) Removes the effect or restores the default effect 'effect' set for the property (see esriNgPropertyEffect).
void	setDisplayFlagModel(INgFlagModel pVal) Flag model used by the property.
void	setEffect(int effect, Object effValue) Modifies the effect 'effect' set for the property (see esriNgPropertyEffect).
void	setName(String pVal) Name of the discrete property.

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

NgDiscreteProperty

public NgDiscreteProperty(Object obj)
                   throws IOException

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

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

Throws:

IOException - if there are interop problems NgDiscreteProperty theNgDiscreteProperty = (NgDiscreteProperty) 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

getName

public String getName()
               throws IOException,
                      AutomationException

Name of the discrete property.

Description

This name is defined when the discrete property is created:

- either by calling the INgElementType CreateProperty method in the program code,

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

Product Availability

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

Specified by:

getName in interface INgDiscreteProperty

Specified by:

getName in interface INgProperty

Returns:

The pVal

Throws:

IOException - If there are interop problems.

AutomationException - If the ArcObject component throws an exception.

setName

public void setName(String pVal)
             throws IOException,
                    AutomationException

Name of the discrete property.

Product Availability

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

Specified by:

setName in interface INgDiscreteProperty

Specified by:

setName in interface INgProperty

Parameters:

pVal - The pVal (in)

Throws:

IOException - If there are interop problems.

AutomationException - If the ArcObject component throws an exception.

getFilters

public INgDiscreteFilters getFilters()
                              throws IOException,
                                     AutomationException

Collection of the discrete filters defined for the discrete property.

Product Availability

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

Specified by:

getFilters in interface INgDiscreteProperty

Returns:

A reference to a com.esri.arcgis.schematic.INgDiscreteFilters

Throws:

IOException - If there are interop problems.

AutomationException - If the ArcObject component throws an exception.

See Also:

INgDiscreteProperty.addFilter(int, String, java.lang.Object)

getElementsByFilter

public INgElements getElementsByFilter(INgDiagram diagram,
                                       int filterNum,
                                       int mode)
                                throws IOException,
                                       AutomationException

Returns all the elements contained in the diagram 'Diagram' that match the 'filternum' discrete filter (mode=esriNgFilterEqual) or that do not match the 'filterNum' discrete filter (mode = esriNgFilterDifferent) (see esriNgFilterSelectionMode).

Product Availability

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

Specified by:

getElementsByFilter in interface INgDiscreteProperty

Parameters:

diagram - A reference to a com.esri.arcgis.schematic.INgDiagram (in)

filterNum - The filterNum (in)

mode - A com.esri.arcgis.schematic.esriNgFilterSelectionMode constant (in)

Returns:

A reference to a com.esri.arcgis.schematic.INgElements

Throws:

IOException - If there are interop problems.

AutomationException - If the ArcObject component throws an exception.

addFilter

public INgDiscreteFilter addFilter(int filterNum,
                                   String name,
                                   Object value)
                            throws IOException,
                                   AutomationException

Creates the filter 'filterNum' named 'name' for the property value 'value'.

Product Availability

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

Specified by:

addFilter in interface INgDiscreteProperty

Parameters:

filterNum - The filterNum (in)

name - The name (in)

value - A Variant (in)

Returns:

A reference to a com.esri.arcgis.schematic.INgDiscreteFilter

Throws:

IOException - If there are interop problems.

AutomationException - If the ArcObject component throws an exception.

See Also:

INgDiscreteProperty.getFilters(), INgDiscreteProperty.deleteFilter(int)

deleteFilter

public void deleteFilter(int filterNum)
                  throws IOException,
                         AutomationException

Deletes the discrete filter 'filterNum'.

Product Availability

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

Specified by:

deleteFilter in interface INgDiscreteProperty

Parameters:

filterNum - The filterNum (in)

Throws:

IOException - If there are interop problems.

AutomationException - If the ArcObject component throws an exception.

See Also:

INgDiscreteProperty.addFilter(int, String, java.lang.Object)

getElementType

public INgElementType getElementType()
                              throws IOException,
                                     AutomationException

Element type the discrete property applies to.

Product Availability

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

Specified by:

getElementType in interface INgDiscreteProperty

Specified by:

getElementType in interface INgProperty

Returns:

A reference to a com.esri.arcgis.schematic.INgElementType

Throws:

IOException - If there are interop problems.

AutomationException - If the ArcObject component throws an exception.

See Also:

INgElementType.getProperties(), INgElementType.createProperty(String, int, int, int)

getType

public int getType()
            throws IOException,
                   AutomationException

Type of the property (see esriNgPropertyType).

Product Availability

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

Specified by:

getType in interface INgProperty

Returns:

A com.esri.arcgis.schematic.esriNgPropertyType constant

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 property (see esriNgPropertyEffect).

Product Availability

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

Specified by:

getEffect in interface INgProperty

Parameters:

effect - A com.esri.arcgis.schematic.esriNgPropertyEffect constant (in)

Returns:

A Variant

Throws:

IOException - If there are interop problems.

AutomationException - If the ArcObject component throws an exception.

See Also:

INgProperty.isEffectSet(int), INgProperty.removeEffect(int), INgProperty.setEffect(int, java.lang.Object)

setEffect

public void setEffect(int effect,
                      Object effValue)
               throws IOException,
                      AutomationException

Modifies the effect 'effect' set for the property (see esriNgPropertyEffect).

Product Availability

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

Specified by:

setEffect in interface INgProperty

Parameters:

effect - A com.esri.arcgis.schematic.esriNgPropertyEffect constant (in)

effValue - A Variant (in)

Throws:

IOException - If there are interop problems.

AutomationException - If the ArcObject component throws an exception.

See Also:

INgProperty.isEffectSet(int), INgProperty.removeEffect(int), INgProperty.getEffect(int)

removeEffect

public void removeEffect(int effect)
                  throws IOException,
                         AutomationException

Removes the effect or restores the default effect 'effect' set for the property (see esriNgPropertyEffect).

Description

Note that when removing an effect that is always set, the ;property default effect value is automatically restored; and removing an effect that is not set by default, really removes the property effect.

Product Availability

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

Specified by:

removeEffect in interface INgProperty

Parameters:

effect - A com.esri.arcgis.schematic.esriNgPropertyEffect constant (in)

Throws:

IOException - If there are interop problems.

AutomationException - If the ArcObject component throws an exception.

See Also:

INgProperty.isEffectSet(int), INgProperty.setEffect(int, java.lang.Object), INgProperty.getEffect(int)

isEffectSet

public boolean isEffectSet(int effect)
                    throws IOException,
                           AutomationException

Indicates if the effect 'effect' related to the property is set (see esriNgPropertyEffect).

Description

By default, Schematics automatically sets default values for some property effects (see the List of the property effect default values, below). For all these effects, the IsEffectSet method returns True. For the other effects (those that are not automatically set by default), the IsEffectSet method returns True only if the effect has been set:

- Either when defining the property's characteristics in ArcGIS Schematics Designer

- Or by calling the SetEffect method in the project code.

List of the property effect default values

esriNgPropertyDecimalPrecision: -1

esriNgPropertyLabelDisplayMode: esriNgDisplayPropertyValue

esriNgPropertyLabelPlacement: esriNgAbove

esriNgPropertyLabelPort: 0

esriNgPropertyLegendNotes: nothing. But, by default, Schematics displays the property name

esriNgPropertyLegendVisibility: esriNgVisible

esriNgPropertyStatus: esriNgEnabled

esriNgPropertyStringLenght: -1

esriNgPropertyValueType: esriNgFloatPropertyValue, esriNgIntegerPropertyValue or esriNgStringPropertyValue. This parameter is fixed when the property is created.

For more details, see Property Effects Definition.

Product Availability

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

Specified by:

isEffectSet in interface INgProperty

Parameters:

effect - A com.esri.arcgis.schematic.esriNgPropertyEffect constant (in)

Returns:

The isSet

Throws:

IOException - If there are interop problems.

AutomationException - If the ArcObject component throws an exception.

See Also:

INgProperty.removeEffect(int), INgProperty.setEffect(int, java.lang.Object), INgProperty.getEffect(int)

getDisplayFlagModel

public INgFlagModel getDisplayFlagModel()
                                 throws IOException,
                                        AutomationException

Flag model used by the property.

Product Availability

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

Specified by:

getDisplayFlagModel in interface INgProperty

Returns:

A reference to a com.esri.arcgis.schematic.INgFlagModel

Throws:

IOException - If there are interop problems.

AutomationException - If the ArcObject component throws an exception.

setDisplayFlagModel

public void setDisplayFlagModel(INgFlagModel pVal)
                         throws IOException,
                                AutomationException

Flag model used by the property.

Product Availability

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

Specified by:

setDisplayFlagModel in interface INgProperty

Parameters:

pVal - A reference to a com.esri.arcgis.schematic.INgFlagModel (in)

Throws:

IOException - If there are interop problems.

AutomationException - If the ArcObject component throws an exception.

delete

public void delete()
            throws IOException,
                   AutomationException

Deletes the property.

Product Availability

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

Specified by:

delete in interface INgProperty

Throws:

IOException - If there are interop problems.

AutomationException - If the ArcObject component throws an exception.

See Also:

INgElementType.createProperty(String, int, int, int)

getAssociatedAttribute

public INgAttribute getAssociatedAttribute()
                                    throws IOException,
                                           AutomationException

Attribute the property is associated with.

Product Availability

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

Specified by:

getAssociatedAttribute in interface INgProperty

Returns:

A reference to a com.esri.arcgis.schematic.INgAttribute

Throws:

IOException - If there are interop problems.

AutomationException - If the ArcObject component throws an exception.

See Also:

INgElementType.getAssociatedPropertyAttribute(String)