org.netxms.client.objects

Class NetworkMap

java.lang.Object

org.netxms.client.objects.AbstractObject

org.netxms.client.objects.GenericObject

org.netxms.client.objects.NetworkMap

public class NetworkMap
extends GenericObject

Network map object

Field Summary

Fields

Modifier and Type	Field and Description
static UUID	GEOMAP_BACKGROUND
static int	MF_CALCULATE_STATUS
static int	MF_FILTER_OBJECTS
static int	MF_SHOW_END_NODES
static int	MF_SHOW_STATUS_BKGND
static int	MF_SHOW_STATUS_FRAME
static int	MF_SHOW_STATUS_ICON
static int	TYPE_CUSTOM
static int	TYPE_IP_TOPOLOGY
static int	TYPE_LAYER2_TOPOLOGY

Fields inherited from class org.netxms.client.objects.AbstractObject

accessList, BUSINESSSERVICEROOT, CALCULATE_DEFAULT, CALCULATE_MOST_CRITICAL, CALCULATE_MULTIPLE_THRESHOLDS, CALCULATE_SINGLE_THRESHOLD, children, comments, customAttributes, DASHBOARDROOT, dashboards, fixedPropagatedStatus, geolocation, guid, image, inheritAccessRights, inMaintenanceMode, isDeleted, moduleData, NETWORK, NETWORKMAPROOT, OBJECT_ACCESSPOINT, OBJECT_AGENTPOLICY, OBJECT_AGENTPOLICY_CONFIG, OBJECT_BUSINESSSERVICE, OBJECT_BUSINESSSERVICEROOT, OBJECT_CLUSTER, OBJECT_CONDITION, OBJECT_CONTAINER, OBJECT_CUSTOM, OBJECT_DASHBOARD, OBJECT_DASHBOARDROOT, OBJECT_GENERIC, OBJECT_INTERFACE, OBJECT_MOBILEDEVICE, OBJECT_NETWORK, OBJECT_NETWORKMAP, OBJECT_NETWORKMAPGROUP, OBJECT_NETWORKMAPROOT, OBJECT_NETWORKSERVICE, OBJECT_NODE, OBJECT_NODELINK, OBJECT_POLICYGROUP, OBJECT_POLICYROOT, OBJECT_RACK, OBJECT_SERVICEROOT, OBJECT_SLMCHECK, OBJECT_SUBNET, OBJECT_TEMPLATE, OBJECT_TEMPLATEGROUP, OBJECT_TEMPLATEROOT, OBJECT_VPNCONNECTOR, OBJECT_ZONE, objectClass, objectId, objectName, parents, POLICYROOT, postalAddress, PROPAGATE_DEFAULT, PROPAGATE_FIXED, PROPAGATE_RELATIVE, PROPAGATE_TRANSLATED, PROPAGATE_UNCHANGED, REPORTROOT, SERVICEROOT, session, status, statusCalculationMethod, statusPropagationMethod, statusShift, statusSingleThreshold, statusThresholds, statusTransformation, submapId, TEMPLATEROOT, trustedNodes, ZONE0

Constructor Summary

Constructors

Constructor and Description
NetworkMap(org.netxms.base.NXCPMessage msg, NXCSession session)

Method Summary

Methods

Modifier and Type	Method and Description
NetworkMapPage	createMapPage() Create map page from map object's data
UUID	getBackground()
int	getBackgroundColor()
org.netxms.base.GeoLocation	getBackgroundLocation()
int	getBackgroundZoom()
int	getDefaultLinkColor()
int	getDefaultLinkRouting()
int	getDiscoveryRadius()
String	getFilter()
int	getFlags()
MapLayoutAlgorithm	getLayout()
int	getMapType()
String	getObjectClassName()
MapObjectDisplayMode	getObjectDisplayMode()
long	getSeedObjectId()
boolean	isAllowedOnMap() If this method returns true object is allowed to be on custom network map.
void	prepareCopy(NXCObjectCreationData cd, NXCObjectModificationData md) Prepare object creation and modification data to create map copy

Methods inherited from class org.netxms.client.objects.AbstractObject

getAccessList, getAllChilds, getAllChilds, getAllParents, getAllParents, getChildIdList, getChildren, getChildsAsArray, getComments, getCustomAttributes, getDashboards, getEffectiveRights, getFixedPropagatedStatus, getGeolocation, getGuid, getImage, getModuleData, getObjectClass, getObjectId, getObjectName, getParentCount, getParentIdList, getParents, getParentsAsArray, getPostalAddress, getStatus, getStatusCalculationMethod, getStatusPropagationMethod, getStatusShift, getStatusSingleThreshold, getStatusThresholds, getStatusTransformation, getSubmapId, getTrustedNodes, hasAccessibleChildren, hasChildren, hashCode, hasParents, isAlarmsVisible, isChildOf, isChildOf, isDefaultImage, isDeleted, isDirectChildOf, isInheritAccessRights, isInMaintenanceMode, setSession

Methods inherited from class java.lang.Object

clone, equals, finalize, getClass, notify, notifyAll, toString, wait, wait, wait

Field Detail

GEOMAP_BACKGROUND

public static final UUID GEOMAP_BACKGROUND

TYPE_CUSTOM

public static final int TYPE_CUSTOM

See Also:

Constant Field Values

TYPE_LAYER2_TOPOLOGY

public static final int TYPE_LAYER2_TOPOLOGY

See Also:

Constant Field Values

TYPE_IP_TOPOLOGY

public static final int TYPE_IP_TOPOLOGY

See Also:

Constant Field Values

MF_SHOW_STATUS_ICON

public static final int MF_SHOW_STATUS_ICON

See Also:

Constant Field Values

MF_SHOW_STATUS_FRAME

public static final int MF_SHOW_STATUS_FRAME

See Also:

Constant Field Values

MF_SHOW_STATUS_BKGND

public static final int MF_SHOW_STATUS_BKGND

See Also:

Constant Field Values

MF_SHOW_END_NODES

public static final int MF_SHOW_END_NODES

See Also:

Constant Field Values

MF_CALCULATE_STATUS

public static final int MF_CALCULATE_STATUS

See Also:

Constant Field Values

MF_FILTER_OBJECTS

public static final int MF_FILTER_OBJECTS

See Also:

Constant Field Values

Constructor Detail

NetworkMap

public NetworkMap(org.netxms.base.NXCPMessage msg,
          NXCSession session)

Parameters:

msg -

session -

Method Detail

prepareCopy

public void prepareCopy(NXCObjectCreationData cd,
               NXCObjectModificationData md)

Prepare object creation and modification data to create map copy

Parameters:

cd -

md -

getObjectClassName

public String getObjectClassName()

Overrides:

getObjectClassName in class AbstractObject

Returns:

Name of NetXMS object's class

isAllowedOnMap

public boolean isAllowedOnMap()

Description copied from class: AbstractObject

If this method returns true object is allowed to be on custom network map. Default implementation always returns false.

Overrides:

isAllowedOnMap in class AbstractObject

Returns:

true if object is allowed to be on custom network map

getMapType

public int getMapType()

Returns:

the mapType

getLayout

public MapLayoutAlgorithm getLayout()

Returns:

the layout

getBackground

public UUID getBackground()

Returns:

the background

getSeedObjectId

public long getSeedObjectId()

Returns:

the seedObjectId

createMapPage

public NetworkMapPage createMapPage()

Create map page from map object's data

Returns:

new map page

getBackgroundLocation

public org.netxms.base.GeoLocation getBackgroundLocation()

Returns:

the backgroundLocation

getBackgroundZoom

public int getBackgroundZoom()

Returns:

the backgroundZoom

getFlags

public int getFlags()

Returns:

the flags

getDefaultLinkColor

public int getDefaultLinkColor()

Returns:

the defaultLinkColor

getDefaultLinkRouting

public int getDefaultLinkRouting()

Returns:

the defaultLinkRouting

getBackgroundColor

public int getBackgroundColor()

Returns:

the backgroundColor

getDiscoveryRadius

public final int getDiscoveryRadius()

Returns:

the discoveryRadius

getFilter

public String getFilter()

Returns:

the filter

getObjectDisplayMode

public MapObjectDisplayMode getObjectDisplayMode()

Returns:

the objectDisplayMode