java.lang.Object
com.esri.arcgisruntime.utilitynetworks.UtilityRule

public final class UtilityRule extends Object
Defines a permissible association between features in a utility network.

Network rules help maintain data integrity. They are imposed at the asset group, asset type, and terminal levels for the entire utility network to manage the correctness of assets in the network by allowing you to select which types of features can be connected or associated. A network rule supporting the type of association between features must exist or these features cannot be associated.

Since:
200.1.0
  • Property Details

  • Method Details

    • fromElementProperty

      public ReadOnlyObjectProperty<UtilityRuleElement> fromElementProperty()
      The first participant in a network rule.

      This may describe a container or structure feature, or any feature from which a connection to another feature can be made.

      Since:
      200.1.0
      See Also:
    • getFromElement

      public UtilityRuleElement getFromElement()
      Gets the value of the property fromElement.
      Property description:
      The first participant in a network rule.

      This may describe a container or structure feature, or any feature from which a connection to another feature can be made.

      Since:
      200.1.0
    • ruleIdProperty

      public ReadOnlyLongProperty ruleIdProperty()
      The ID of this network rule.
      Since:
      200.1.0
      See Also:
    • getRuleId

      public long getRuleId()
      Gets the value of the property ruleId.
      Property description:
      The ID of this network rule.
      Since:
      200.1.0
    • ruleTypeProperty

      public ReadOnlyObjectProperty<UtilityRuleType> ruleTypeProperty()
      The UtilityRuleType of this network rule.
      Since:
      200.1.0
      See Also:
    • getRuleType

      public UtilityRuleType getRuleType()
      Gets the value of the property ruleType.
      Property description:
      The UtilityRuleType of this network rule.
      Since:
      200.1.0
    • toElementProperty

      public ReadOnlyObjectProperty<UtilityRuleElement> toElementProperty()
      The second participant in a network rule.

      This may describe a content or attachment feature, a container feature in a nested containment, or any feature from which a connection to another feature can be made.

      Since:
      200.1.0
      See Also:
    • getToElement

      public UtilityRuleElement getToElement()
      Gets the value of the property toElement.
      Property description:
      The second participant in a network rule.

      This may describe a content or attachment feature, a container feature in a nested containment, or any feature from which a connection to another feature can be made.

      Since:
      200.1.0
    • viaElementProperty

      public ReadOnlyObjectProperty<UtilityRuleElement> viaElementProperty()
      An optional intermediate participant in a network rule.

      This is available only in an UtilityRuleType.EDGE_JUNCTION_EDGE_CONNECTIVITY network rule and is commonly used to describe a junction feature without a terminal.

      Since:
      200.1.0
      See Also:
    • getViaElement

      public UtilityRuleElement getViaElement()
      Gets the value of the property viaElement.
      Property description:
      An optional intermediate participant in a network rule.

      This is available only in an UtilityRuleType.EDGE_JUNCTION_EDGE_CONNECTIVITY network rule and is commonly used to describe a junction feature without a terminal.

      Since:
      200.1.0