Module com.esri.arcgisruntime

Package com.esri.arcgisruntime.utilitynetworks

Class UtilityRule

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 Summary

Properties

Type	Property	Description
ReadOnlyObjectProperty<UtilityRuleElement>	fromElement	The first participant in a network rule.
ReadOnlyLongProperty	ruleId	The ID of this network rule.
ReadOnlyObjectProperty<UtilityRuleType>	ruleType	The UtilityRuleType of this network rule.
ReadOnlyObjectProperty<UtilityRuleElement>	toElement	The second participant in a network rule.
ReadOnlyObjectProperty<UtilityRuleElement>	viaElement	An optional intermediate participant in a network rule.

Method Summary

Modifier and Type	Method	Description
ReadOnlyObjectProperty<UtilityRuleElement>	fromElementProperty()	The first participant in a network rule.
UtilityRuleElement	getFromElement()	Gets the value of the fromElement property.
long	getRuleId()	Gets the value of the ruleId property.
UtilityRuleType	getRuleType()	Gets the value of the ruleType property.
UtilityRuleElement	getToElement()	Gets the value of the toElement property.
UtilityRuleElement	getViaElement()	Gets the value of the viaElement property.
ReadOnlyLongProperty	ruleIdProperty()	The ID of this network rule.
ReadOnlyObjectProperty<UtilityRuleType>	ruleTypeProperty()	The UtilityRuleType of this network rule.
ReadOnlyObjectProperty<UtilityRuleElement>	toElementProperty()	The second participant in a network rule.
ReadOnlyObjectProperty<UtilityRuleElement>	viaElementProperty()	An optional intermediate participant in a network rule.

Methods inherited from class java.lang.Object

clone, equals, finalize, getClass, hashCode, notify, notifyAll, toString, wait, wait, wait

Property Details

fromElement

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()
• fromElementProperty()

ruleId

public ReadOnlyLongProperty ruleIdProperty

The ID of this network rule.

Since:

200.1.0

See Also:

• getRuleId()
• ruleIdProperty()

ruleType

public ReadOnlyObjectProperty<UtilityRuleType> ruleTypeProperty

The UtilityRuleType of this network rule.

Since:

200.1.0

See Also:

• getRuleType()
• ruleTypeProperty()

toElement

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()
• toElementProperty()

viaElement

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()
• viaElementProperty()

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.

Returns:

the fromElement property

Since:

200.1.0

See Also:

• getFromElement()

getFromElement

public UtilityRuleElement getFromElement()

Gets the value of the fromElement property.

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.

Returns:

the value of the fromElement property

Since:

200.1.0

See Also:

• fromElementProperty()

ruleIdProperty

public ReadOnlyLongProperty ruleIdProperty()

The ID of this network rule.

Returns:

the ruleId property

Since:

200.1.0

See Also:

• getRuleId()

getRuleId

public long getRuleId()

Gets the value of the ruleId property.

Property description:

The ID of this network rule.

Returns:

the value of the ruleId property

Since:

200.1.0

See Also:

• ruleIdProperty()

ruleTypeProperty

public ReadOnlyObjectProperty<UtilityRuleType> ruleTypeProperty()

The UtilityRuleType of this network rule.

Returns:

the ruleType property

Since:

200.1.0

See Also:

• getRuleType()

getRuleType

public UtilityRuleType getRuleType()

Gets the value of the ruleType property.

Property description:

The UtilityRuleType of this network rule.

Returns:

the value of the ruleType property

Since:

200.1.0

See Also:

• ruleTypeProperty()

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.

Returns:

the toElement property

Since:

200.1.0

See Also:

• getToElement()

getToElement

public UtilityRuleElement getToElement()

Gets the value of the toElement property.

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.

Returns:

the value of the toElement property

Since:

200.1.0

See Also:

• toElementProperty()

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.

Returns:

the viaElement property

Since:

200.1.0

See Also:

• getViaElement()

getViaElement

public UtilityRuleElement getViaElement()

Gets the value of the viaElement property.

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.

Returns:

the value of the viaElement property

Since:

200.1.0

See Also:

• viaElementProperty()