Class UtilityNetworkDefinition
- java.lang.Object
-
- com.esri.arcgisruntime.utilitynetworks.UtilityNetworkDefinition
-
public final class UtilityNetworkDefinition extends java.lang.Object
Defines the metadata (for example domain networks, network sources etc.) of a utility network.- Since:
- 100.6.0
-
-
Method Summary
All Methods Instance Methods Concrete Methods Modifier and Type Method Description java.util.List<UtilityCategory>
getCategories()
Gets an unmodifiable list of utility network categories.UtilityDomainNetwork
getDomainNetwork(java.lang.String domainNetworkName)
Gets the domain network with the specified name.java.util.List<UtilityDomainNetwork>
getDomainNetworks()
Gets an unmodifiable list of the domain networks in the utility network metadata.Envelope
getExtent()
Gets theEnvelope
representing the service territory area used to define theUtilityNetwork
.UtilityNetworkAttribute
getNetworkAttribute(java.lang.String name)
Gets the network attribute specified by the name argument.java.util.List<UtilityNetworkAttribute>
getNetworkAttributes()
Gets an unmodifiable list of the network attributes in the utility network definition.UtilityNetworkSource
getNetworkSource(java.lang.String name)
Gets the network source specified by the name argument.ListenableList<UtilityNetworkSource>
getNetworkSources()
Gets an unmodifiable list of the network sources in the utility network definition.int
getSchemaVersion()
Gets the utility network schema version number reported by the utility network metadata.java.util.List<UtilityTerminalConfiguration>
getTerminalConfigurations()
Gets an unmodifiable list of the utility terminal configurations in the utility network definition.
-
-
-
Method Detail
-
getCategories
public java.util.List<UtilityCategory> getCategories()
Gets an unmodifiable list of utility network categories. This is a set of system-provided network categories that incorporate semantics of the utility network for subnetwork management and tracing operations.- Returns:
- an unmodifiable list of the categories
- Since:
- 100.6.0
-
getNetworkAttribute
public UtilityNetworkAttribute getNetworkAttribute(java.lang.String name)
Gets the network attribute specified by the name argument.- Parameters:
name
- the name of the network attribute to retrieve- Returns:
- the network attribute or null if name not found
- Throws:
java.lang.IllegalArgumentException
- if name is null or empty- Since:
- 100.6.0
-
getNetworkAttributes
public java.util.List<UtilityNetworkAttribute> getNetworkAttributes()
Gets an unmodifiable list of the network attributes in the utility network definition.- Returns:
- an unmodifiable list of the network attributes
- Since:
- 100.6.0
-
getNetworkSource
public UtilityNetworkSource getNetworkSource(java.lang.String name)
Gets the network source specified by the name argument.- Parameters:
name
- the name of the network source to retrieve- Returns:
- the network source or null if name not found
- Throws:
java.lang.IllegalArgumentException
- if name is null or empty- Since:
- 100.6.0
-
getNetworkSources
public ListenableList<UtilityNetworkSource> getNetworkSources()
Gets an unmodifiable list of the network sources in the utility network definition.- Returns:
- an unmodifiable list of the network sources
- Since:
- 100.6.0
-
getTerminalConfigurations
public java.util.List<UtilityTerminalConfiguration> getTerminalConfigurations()
Gets an unmodifiable list of the utility terminal configurations in the utility network definition.- Returns:
- an unmodifiable list of the utility terminal configurations
- Since:
- 100.7.0
-
getSchemaVersion
public int getSchemaVersion()
Gets the utility network schema version number reported by the utility network metadata. Runtime only supports schema version 2 and 3.- Returns:
- the schema version
- Since:
- 100.6.0
-
getDomainNetwork
public UtilityDomainNetwork getDomainNetwork(java.lang.String domainNetworkName)
Gets the domain network with the specified name.- Parameters:
domainNetworkName
- the name of the domain network- Returns:
- the domain network or null if domainNetworkName not found
- Throws:
java.lang.IllegalArgumentException
- if domainNetworkName is null or empty- Since:
- 100.7.0
-
getDomainNetworks
public java.util.List<UtilityDomainNetwork> getDomainNetworks()
Gets an unmodifiable list of the domain networks in the utility network metadata.Domain networks organize features in a utility network based on what utility service they provide, such as natural gas, water, electricity, or structural elements like poles or conduits.
- Returns:
- an unmodifiable list of domain networks
- Since:
- 100.7.0
-
getExtent
public Envelope getExtent()
Gets theEnvelope
representing the service territory area used to define theUtilityNetwork
.This is the extent of the network topology (i.e., the extent of the service territory plus a small buffer).
- Returns:
Envelope
representing the service territory area used to define theUtilityNetwork
- Since:
- 100.8.0
-
-