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 java.util.UUID	GEOMAP_BACKGROUND
static int	LAYOUT_HTREE
static int	LAYOUT_MANUAL
static int	LAYOUT_RADIAL
static int	LAYOUT_SPARSE_VTREE
static int	LAYOUT_SPRING
static int	LAYOUT_VTREE
static int	MF_CALCULATE_STATUS
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, fixedPropagatedStatus, geolocation, guid, image, inheritAccessRights, isDeleted, 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_REPORT, OBJECT_REPORTGROUP, OBJECT_REPORTROOT, OBJECT_SERVICEROOT, OBJECT_SLMCHECK, OBJECT_SUBNET, OBJECT_TEMPLATE, OBJECT_TEMPLATEGROUP, OBJECT_TEMPLATEROOT, OBJECT_VPNCONNECTOR, OBJECT_ZONE, objectClass, objectId, objectName, parents, POLICYROOT, primaryIP, 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(NXCPMessage msg, NXCSession session)

Method Summary

Methods

Modifier and Type	Method and Description
NetworkMapPage	createMapPage() Create map page from map object's data
java.util.UUID	getBackground()
int	getBackgroundColor()
GeoLocation	getBackgroundLocation()
int	getBackgroundZoom()
int	getDefaultLinkColor()
int	getDefaultLinkRouting()
int	getDiscoveryRadius()
java.lang.String	getFilter()
int	getFlags()
int	getLayout()
int	getMapType()
java.lang.String	getObjectClassName()
long	getSeedObjectId()
boolean	isAllowedOnMap() If this method returns true object is allowed to be on custom network map.

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

getAccessList, getAllChilds, getAllParents, getChildIdList, getChildren, getChildsAsArray, getComments, getCustomAttributes, getEffectiveRights, getFixedPropagatedStatus, getGeolocation, getGuid, getImage, getObjectClass, getObjectId, getObjectName, getParentCount, getParentIdList, getParents, getParentsAsArray, getPrimaryIP, getStatus, getStatusCalculationMethod, getStatusPropagationMethod, getStatusShift, getStatusSingleThreshold, getStatusThresholds, getStatusTransformation, getSubmapId, getTrustedNodes, hasAccessibleChildren, hasChildren, hashCode, hasParents, isChildOf, isChildOf, isDefaultImage, isDeleted, isDirectChildOf, isInheritAccessRights, 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 java.util.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

LAYOUT_MANUAL

public static final int LAYOUT_MANUAL

See Also:

Constant Field Values

LAYOUT_SPRING

public static final int LAYOUT_SPRING

See Also:

Constant Field Values

LAYOUT_RADIAL

public static final int LAYOUT_RADIAL

See Also:

Constant Field Values

LAYOUT_HTREE

public static final int LAYOUT_HTREE

See Also:

Constant Field Values

LAYOUT_VTREE

public static final int LAYOUT_VTREE

See Also:

Constant Field Values

LAYOUT_SPARSE_VTREE

public static final int LAYOUT_SPARSE_VTREE

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

Constructor Detail

NetworkMap

public NetworkMap(NXCPMessage msg,
          NXCSession session)

Parameters:

msg -

session -

Method Detail

getObjectClassName

public java.lang.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 int getLayout()

Returns:

the layout

getBackground

public java.util.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 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 java.lang.String getFilter()

Returns:

the filter