Interface LogicalBasicNetwork

    • Method Detail

      • getName

        java.lang.String getName()
        Returns the internal network name, for example, the network name stored in network metadata table. Note that the internal network names for different networks are not guaranteed to be unique across multiple database connections.
        Returns:
        network name
      • getLinkLevel

        int getLinkLevel()
        Returns the link level of the network.
        Returns:
      • addLink

        void addLink​(LogicalNetLink link)
        Adds a logical link to the network.
        Parameters:
        link - logical link
      • addNode

        void addNode​(LogicalNetNode node)
        Adds a logical node to the network.
        Parameters:
        node -
      • getNumberOfNodes

        int getNumberOfNodes()
        Returns the total number of nodes in the network.
        Returns:
        number of nodes
      • getNumberOfLinks

        int getNumberOfLinks()
        Returns the total number of links in the network.
        Returns:
        number of links
      • getNodes

        LogicalNetNode[] getNodes()
        Returns all the nodes in the network.
        Returns:
        array of nodes
      • getLinks

        LogicalNetLink[] getLinks()
        Returns all the links in the network.
        Returns:
        array of links
      • getNode

        LogicalNetNode getNode​(long nodeId)
        Returns the logical node object for the specified node id.
        Parameters:
        nodeId - node id
        Returns:
        logical node object
      • getLink

        LogicalNetLink getLink​(long linkId)
        Returns the logical link object for the specified link id.
        Parameters:
        linkId - link id
        Returns:
        logical link object
      • getNodeIds

        long[] getNodeIds()
        Returns all the node ids in the network.
        Returns:
        array of node ids
      • getLinkIds

        long[] getLinkIds()
        Returns all the link ids in the network.
        Returns:
        array of link ids
      • isUserDataLoaded

        boolean isUserDataLoaded()
        Deprecated.
        use getUserDataCategories
        Returns whether the user data are loaded to the network.
        Returns:
        true, if the user data are loaded; false, otherwise.
      • setIsUserDataLoaded

        void setIsUserDataLoaded​(boolean isUserDataLoaded)
        Deprecated.
        use addUserDataCategory
        Sets whether the user data is loaded to the network.
        Parameters:
        isUserDataLoaded - true, if the user data are loaded; false, otherwise.
      • getUserDataCategories

        int[] getUserDataCategories()
        Returns the user data categories loaded in the network.
        Returns:
      • addUserDataCategory

        void addUserDataCategory​(int userDataCategory)
        Adds the user data category that have been loaded to the network.
        Parameters:
        userDataCategory - user data category
      • isUserDataCategoryLoaded

        boolean isUserDataCategoryLoaded​(int category)
        Returns whether the specified user data category is loaded.
        Parameters:
        category -
        Returns:
      • removeNode

        void removeNode​(long nodeId)
        Removes a node from the network.
        Parameters:
        nodeId - ID of the node to be removed
      • removeLink

        void removeLink​(long linkId)
        Removes a link from the network.
        Parameters:
        linkId - ID of the link to be removed
      • getFeatureData

        FeatureData getFeatureData()
        Returns the feature data associated to this network.
        Returns:
      • setFeatureData

        void setFeatureData​(FeatureData featureData)
        Sets the feature data associated to this network.
        Parameters:
        featureData -
      • addFeatureLayer

        void addFeatureLayer​(int featureLayerId,
                             FeatureLayer featureLayer)
        Adds the feature layer.
        Parameters:
        featureLayer -
      • isFeatureLayerLoaded

        boolean isFeatureLayerLoaded​(int featureLayerId)
        Returns whether the specified user data category is loaded.
        Parameters:
        featureLayerId -
        Returns:
      • clone

        java.lang.Object clone()
                        throws java.lang.CloneNotSupportedException
        Supports cloneable
        Returns:
        cloned object
        Throws:
        java.lang.CloneNotSupportedException