Interface Feature

  • All Known Subinterfaces:
    PathFeature
    All Known Implementing Classes:
    FeatureImpl, PathFeatureImpl

    public interface Feature
    This interface defines the methods supported by a network feature. A network feature is a collection of feature elements. A feature element can be a point on node, a point along a link, a link or partial link. Each feature element corresponds to a feature element index, starting from 0.
    Since:
    12.1
    • Method Detail

      • getId

        long getId()
        Returns the feature ID.
        Returns:
      • getElement

        FeatureElement getElement​(int i)
        Returns the ith element in the feature.
        Parameters:
        i - feature element index
        Returns:
      • getElements

        FeatureElement[] getElements()
        Returns the feature elements in the feature.
        Returns:
      • getNumberOfElements

        int getNumberOfElements()
        Returns the number of elements in the feature.
        Returns:
      • addElement

        void addElement​(int i,
                        FeatureElement element)
        Adds a feature element at the ith position of the feature.
        Parameters:
        i - feature element index
        element -
      • addElements

        void addElements​(FeatureElement[] newElements)
        Appends a list of elements to the end of the feature.
        Parameters:
        newElements -
      • deleteElement

        void deleteElement​(int i)
        Deletes the ith element in the feature.
        Parameters:
        i - feature element index
      • findElement

        int findElement​(FeatureElement element)
        Finds the input feature element in this feature, and returns the feature element index. If the feature element is not found, returns 0.
        Parameters:
        element -
        Returns:
      • setElement

        void setElement​(int i,
                        FeatureElement element)
        Sets the ith feature element.
        Parameters:
        i - feature element index
        element -
      • getCategorizedUserData

        CategorizedUserData getCategorizedUserData()
        Returns categorized user data.
        Returns:
      • setCategorizedUserData

        void setCategorizedUserData​(CategorizedUserData userData)
        Sets categorized user data.
        Parameters:
        userData -
      • getUserData

        UserData getUserData​(int category)
        Returns user data for the specified category.
        Returns:
      • setUserData

        void setUserData​(int category,
                         UserData userData)
        Sets user data for the specified category.
        Parameters:
        userData -
      • clone

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