org.netxms.client.maps
Class NetworkMapPage

java.lang.Object
  extended by org.netxms.client.maps.NetworkMapPage

public class NetworkMapPage
extends java.lang.Object

Represents single map page (submap)

Author:
Victor

Constructor Summary
NetworkMapPage()
          Create empty unnamed page
NetworkMapPage(java.lang.String name)
          Create empty named page
 
Method Summary
 void addLink(NetworkMapObjectLink link)
          Add link between objects to map
 void addObject(NetworkMapObjectData object)
          Add object to map
 NXCObject[] getConnectedObjects(long root, NXCSession session)
          Get all objects connected to given object
 java.util.Set<NetworkMapObjectLink> getLinks()
           
 java.lang.String getName()
           
 java.util.Set<NetworkMapObjectData> getObjects()
           
 java.lang.Object[] getObjectsAndLinks(NXCSession session)
          Get objects and links in one array - objects as NXCObject and subclasses, links as NXCMapObjectLink
 NXCObject[] getResolvedObjects(NXCSession session)
          Get objects as NXCObject and subclasses
 void setName(java.lang.String name)
           
 
Methods inherited from class java.lang.Object
clone, equals, finalize, getClass, hashCode, notify, notifyAll, toString, wait, wait, wait
 

Constructor Detail

NetworkMapPage

public NetworkMapPage()
Create empty unnamed page


NetworkMapPage

public NetworkMapPage(java.lang.String name)
Create empty named page

Method Detail

addObject

public void addObject(NetworkMapObjectData object)
Add object to map


addLink

public void addLink(NetworkMapObjectLink link)
Add link between objects to map


getName

public java.lang.String getName()
Returns:
the name

setName

public void setName(java.lang.String name)
Parameters:
name - the name to set

getObjects

public java.util.Set<NetworkMapObjectData> getObjects()
Returns:
the objects

getLinks

public java.util.Set<NetworkMapObjectLink> getLinks()
Returns:
the links

getObjectsAndLinks

public java.lang.Object[] getObjectsAndLinks(NXCSession session)
Get objects and links in one array - objects as NXCObject and subclasses, links as NXCMapObjectLink

Parameters:
session - Client session which should be used for object lookup
Returns:
Objects and links in one array

getResolvedObjects

public NXCObject[] getResolvedObjects(NXCSession session)
Get objects as NXCObject and subclasses

Parameters:
session - Client session which should be used for object lookup
Returns:
NetXMS objects

getConnectedObjects

public NXCObject[] getConnectedObjects(long root,
                                       NXCSession session)
Get all objects connected to given object

Parameters:
root - Root object id
session - Client session which should be used for object lookup
Returns:
All objects connected to given object


Copyright © 2009. All Rights Reserved.