Module com.esri.arcgisruntime

Package com.esri.arcgisruntime.utilitynetworks

Class UtilityRuleElement

java.lang.Object

com.esri.arcgisruntime.utilitynetworks.UtilityRuleElement

public final class UtilityRuleElement
extends Object

Specifies the type of features participating in a network rule.

A rule element describes the type of features to which a network rule is applied.

A rule element participating in a network rule can be one of the following:

• UtilityRule.fromElementProperty()
• UtilityRule.toElementProperty()
• UtilityRule.viaElementProperty()

Attachment network rules place a structure feature in the UtilityRule.fromElementProperty() and attachment features in the UtilityRule.toElementProperty(). Containment network rules place a container feature in the UtilityRule.fromElementProperty() and content features in the UtilityRule.toElementProperty(). If nested containment is allowed, another container feature may be placed in the UtilityRule.toElementProperty(). Connectivity network rules with an UtilityRule.viaElementProperty() have a junction feature.

Network rules that support terminal connectivity use these rule elements to define which terminal the rule is applicable for.

Since:

200.1.0

Property Summary

Properties

Type	Property	Description
ReadOnlyObjectProperty<UtilityAssetGroup>	assetGroup	The asset group that contains the asset type bound by a network rule.
ReadOnlyObjectProperty<UtilityAssetType>	assetType	The asset type bound by a network rule.
ReadOnlyObjectProperty<UtilityNetworkSource>	networkSource	The network source that contains the asset group and asset type bound by a network rule.
ReadOnlyObjectProperty<UtilityTerminal>	terminal	The terminal of the asset type where a network rule is applicable.

Method Summary

Modifier and Type	Method	Description
ReadOnlyObjectProperty<UtilityAssetGroup>	assetGroupProperty()	The asset group that contains the asset type bound by a network rule.
ReadOnlyObjectProperty<UtilityAssetType>	assetTypeProperty()	The asset type bound by a network rule.
UtilityAssetGroup	getAssetGroup()	Gets the value of the assetGroup property.
UtilityAssetType	getAssetType()	Gets the value of the assetType property.
UtilityNetworkSource	getNetworkSource()	Gets the value of the networkSource property.
UtilityTerminal	getTerminal()	Gets the value of the terminal property.
ReadOnlyObjectProperty<UtilityNetworkSource>	networkSourceProperty()	The network source that contains the asset group and asset type bound by a network rule.
ReadOnlyObjectProperty<UtilityTerminal>	terminalProperty()	The terminal of the asset type where a network rule is applicable.

Methods inherited from class java.lang.Object

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

Property Details

assetGroup

public ReadOnlyObjectProperty<UtilityAssetGroup> assetGroupProperty

The asset group that contains the asset type bound by a network rule.

Since:

200.1.0

See Also:

• getAssetGroup()
• assetGroupProperty()

assetType

public ReadOnlyObjectProperty<UtilityAssetType> assetTypeProperty

The asset type bound by a network rule.

Since:

200.1.0

See Also:

• getAssetType()
• assetTypeProperty()

networkSource

public ReadOnlyObjectProperty<UtilityNetworkSource> networkSourceProperty

The network source that contains the asset group and asset type bound by a network rule.

Since:

200.1.0

See Also:

• getNetworkSource()
• networkSourceProperty()

terminal

public ReadOnlyObjectProperty<UtilityTerminal> terminalProperty

The terminal of the asset type where a network rule is applicable.

Only applicable to asset types with terminals and network rules that support terminal connectivity.

Since:

200.1.0

See Also:

• getTerminal()
• terminalProperty()

Method Details

assetGroupProperty

public ReadOnlyObjectProperty<UtilityAssetGroup> assetGroupProperty()

The asset group that contains the asset type bound by a network rule.

Returns:

the assetGroup property

Since:

200.1.0

See Also:

• getAssetGroup()

getAssetGroup

public UtilityAssetGroup getAssetGroup()

Gets the value of the assetGroup property.

Property description:

The asset group that contains the asset type bound by a network rule.

Returns:

the value of the assetGroup property

Since:

200.1.0

See Also:

• assetGroupProperty()

assetTypeProperty

public ReadOnlyObjectProperty<UtilityAssetType> assetTypeProperty()

The asset type bound by a network rule.

Returns:

the assetType property

Since:

200.1.0

See Also:

• getAssetType()

getAssetType

public UtilityAssetType getAssetType()

Gets the value of the assetType property.

Property description:

The asset type bound by a network rule.

Returns:

the value of the assetType property

Since:

200.1.0

See Also:

• assetTypeProperty()

networkSourceProperty

public ReadOnlyObjectProperty<UtilityNetworkSource> networkSourceProperty()

The network source that contains the asset group and asset type bound by a network rule.

Returns:

the networkSource property

Since:

200.1.0

See Also:

• getNetworkSource()

getNetworkSource

public UtilityNetworkSource getNetworkSource()

Gets the value of the networkSource property.

Property description:

The network source that contains the asset group and asset type bound by a network rule.

Returns:

the value of the networkSource property

Since:

200.1.0

See Also:

• networkSourceProperty()

terminalProperty

public ReadOnlyObjectProperty<UtilityTerminal> terminalProperty()

The terminal of the asset type where a network rule is applicable.

Only applicable to asset types with terminals and network rules that support terminal connectivity.

Returns:

the terminal property

Since:

200.1.0

See Also:

• getTerminal()

getTerminal

public UtilityTerminal getTerminal()

Gets the value of the terminal property.

Property description:

The terminal of the asset type where a network rule is applicable.

Only applicable to asset types with terminals and network rules that support terminal connectivity.

Returns:

the value of the terminal property

Since:

200.1.0

See Also:

• terminalProperty()