Class UtilityNetworkDefinition


  • public final class UtilityNetworkDefinition
    extends Object
    Defines the metadata (for example domain networks, network sources etc.) of a Utility Network feature service.
    Since:
    100.6.0
    • Method Detail

      • getCategories

        public 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​(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:
        IllegalArgumentException - if name is null or empty
        Since:
        100.6.0
      • getNetworkAttributes

        public 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​(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:
        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 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 Feature Service. Runtime only supports schema version 2 and 3.
        Returns:
        the schema version
        Since:
        100.6.0
      • getDomainNetwork

        public UtilityDomainNetwork getDomainNetwork​(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:
        IllegalArgumentException - if domainNetworkName is null or empty
        Since:
        100.7.0
      • getDomainNetworks

        public List<UtilityDomainNetwork> getDomainNetworks()
        Gets an unmodifiable list of the domain networks in the utility network feature service.

        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 the Envelope representing the service territory area used to define the UtilityNetwork.

        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 the UtilityNetwork
        Since:
        100.8.0