com.esri.arcgis.schematic
Interface INgProperty

All Superinterfaces:
Serializable
All Known Implementing Classes:
INgPropertyProxy, NgBoundedProperty, NgDirectProperty, NgDiscreteProperty, NgProperty, NgTextualProperty

public interface INgProperty
extends Serializable

Provides access to members that control the property.

Description

Properties are used to define the characteristics of a group of elements that have an impact in the graphic representation of a network. The overall state of a network is determined by the values taken by the existing set of properties at a given time. A property is associated with a single element group.

A label displayed either directly on the elements it applies to or inside a flag associated with these elements can represent any property. The position of the text is determined either relative to the objects (above/below, for links) or by a port number (for nodes or flags).




A property created for the sole purpose of displaying a label on an element or inside the flag attached to this element is said to be textual. To associate graphic effects with a property, the possible values of the property must first be specified. If these values belong to a finite set of numbers or alphanumeric codes, the property is said to be discrete. If the values are simply numeric and indifferent (that is, they belong to a range of values), the property is said to be bounded. To assign specific graphic effects to that property, a filter must be defined for each of its possible values. Along with the textual, discrete, and bounded properties, a fourth property, the direct property, is also available for directly applying a given graphic effect, depending on the values taken up by the property itself—that is, scale factor and symbology.

In all cases, the values used to define any property effect are returned through an attribute that must be associated with the property. Each attribute may be related to one or several fields stored in the database.

The use of properties depends on whether its related element type is associated with a group. A property is always related to a element type. It can be created or associated with this element type.

Product Availability

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

See Also:
INgDiscreteProperty, INgTextualProperty, INgBoundedProperty, INgElementType.createProperty(String, int, int, int)

Method Summary
 void delete()
          Deletes the property.
 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).
 INgElementType getElementType()
          Element type the property is related to.
 String getName()
          Name of the property.
 int getType()
          Type of the property (see esriNgPropertyType).
 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 property.
 

Method Detail

getName

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

Description

This name has been defined when the property was created

- Either by calling the INgElementType CreateProperty method in the program code

- Or when the property has been 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.

setName

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

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

Product Availability

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

Returns:
A com.esri.arcgis.schematic.esriNgPropertyType constant
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 property (see esriNgPropertyEffect).

Product Availability

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

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

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.

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

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.

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

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.

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)

getElementType

INgElementType getElementType()
                              throws IOException,
                                     AutomationException
Element type the property is related to.

Product Availability

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

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)

getDisplayFlagModel

INgFlagModel getDisplayFlagModel()
                                 throws IOException,
                                        AutomationException
Flag model used by the property.

Product Availability

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

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

void setDisplayFlagModel(INgFlagModel pVal)
                         throws IOException,
                                AutomationException
Flag model used by the property.

Product Availability

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

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

void delete()
            throws IOException,
                   AutomationException
Deletes the property.

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:
INgElementType.createProperty(String, int, int, int)

getAssociatedAttribute

INgAttribute getAssociatedAttribute()
                                    throws IOException,
                                           AutomationException
Attribute the property is associated with.

Product Availability

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

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)