Package org.netxms.client.maps

Class NetworkMapPage

java.lang.Object
org.netxms.client.maps.NetworkMapPage
public class NetworkMapPage extends Object
Network map object representation used by visualisation tools

  • Constructor Details

    • NetworkMapPage

      public NetworkMapPage(String id, long mapObjectId)
      Create empty named page.
      Parameters:
      id - page ID

    • NetworkMapPage

      public NetworkMapPage(String id)
      Create empty named page.
      Parameters:
      id - page ID

  • Method Details

    • addElement

      public void addElement(NetworkMapElement element)
      Add element to map
      Parameters:
      element - element to add

    • addAllElements

      public void addAllElements(Collection<NetworkMapElement> set)
      Add all elements from given collection.
      Parameters:
      set - set of elements to add

    • addLink

      public void addLink(NetworkMapLink link)
      Add link between elements to map
      Parameters:
      link - link to add

    • addAllLinks

      public void addAllLinks(Collection<NetworkMapLink> set)
      Add all links from given collection
      Parameters:
      set - set of links to add

    • getElement

      public NetworkMapElement getElement(long elementId, Class<? extends NetworkMapElement> requiredClass)
      Get map element by element ID.
      Parameters:
      elementId - element ID
      requiredClass - optional class filter (set to null to disable filtering)
      Returns:
      map element or null

    • removeElement

      public void removeElement(long elementId)
      Remove element from map
      Parameters:
      elementId - map element ID

    • removeObjectElement

      public void removeObjectElement(long objectId)
      Remove map element representing NetXMS object by NetXMS object ID.
      Parameters:
      objectId - NetXMS object ID

    • removeLink

      public void removeLink(NetworkMapLink link)
      Remove link between objects
      Parameters:
      link - link to be removed

    • removeLink

      public void removeLink(long id)
      Remove link between objects
      Parameters:
      id - link ID

    • getId

      public String getId()
      Get page ID.
      Returns:
      page ID

    • setId

      public void setId(String id)
      Set page ID.
      Parameters:
      id - new page ID

    • getElements

      public Collection<NetworkMapElement> getElements()
      Get map elements.
      Returns:
      map elements

    • getLinks

      public Collection<NetworkMapLink> getLinks()
      Get links between elements.
      Returns:
      links between elements

    • getObjectIds

      public List<Long> getObjectIds()
      Get IDs of all objects on map
      Returns:
      IDs of all objects on map

    • getObjectElements

      public List<NetworkMapElement> getObjectElements()
      Get all object elements
      Returns:
      all object elements

    • createElementId

      public long createElementId()
      Create new unique element ID
      Returns:
      new unique element ID

    • createLinkId

      public long createLinkId()
      Create new unique link ID
      Returns:
      new unique link ID

    • findObjectElement

      public NetworkMapObject findObjectElement(long objectId)
      Find object element by NetXMS object ID.
      Parameters:
      objectId - NetXMS object ID
      Returns:
      object element or null

    • findLinks

      public List<NetworkMapLink> findLinks(NetworkMapElement source, NetworkMapElement destination)
      Find links from source to destination
      Parameters:
      source - source element
      destination - destination element
      Returns:
      link between source and destination or null if there are no such link

    • findLinksWithStatusObject

      public List<NetworkMapLink> findLinksWithStatusObject(long objectId)
      Find all links using given object as status source
      Parameters:
      objectId - status source object id
      Returns:
      list of link using this object

    • getAllLinkStatusObjects

      public Set<Long> getAllLinkStatusObjects()
      Get all object used as status source for links
      Returns:
      set of status source objects

    • areObjectsConnected

      public boolean areObjectsConnected(long elementId1, long elementId2)
      Checks if two objects are connected
      Parameters:
      elementId1 - ID of first map element
      elementId2 - ID of second map element
      Returns:
      true if given elements are connected

    • getElementsAndLinks

      public Object[] getElementsAndLinks()
      Get objects and links in one array
      Returns:
      Objects and links in one array

    • getConnectedElements

      public NetworkMapElement[] getConnectedElements(long root)
      Get all elements connected to given element
      Parameters:
      root - Root element id
      Returns:
      All elements connected to given element

    • updateElement

      public boolean updateElement(NetworkMapElement element)
      Update existing on the map element
      Parameters:
      element - element with data to update
      Returns:
      true if element updated, false if element not found

    • getMapObjectId

      public long getMapObjectId()
      Returns:
      the mapObjectId