Package org.netxms.client.objects

Class NetworkMap

java.lang.Object
org.netxms.client.objects.AbstractObject
org.netxms.client.objects.GenericObject
org.netxms.client.objects.NetworkMap
All Implemented Interfaces:
AutoBindObject, PollingTarget
public class NetworkMap extends GenericObject implements AutoBindObject, PollingTarget
Network map object

  • Field Details

  • Constructor Details

    • NetworkMap

      public NetworkMap(NXCPMessage msg, NXCSession session)
      Create from NXCP message.
      Parameters:
      msg - NXCP message
      session - owning client session

  • Method Details

    • prepareCopy

      public void prepareCopy(NXCObjectCreationData cd, NXCObjectModificationData md)
      Prepare object creation and modification data to create map copy
      Parameters:
      cd - object creation data
      md - object modification data

    • getObjectClassName

      public String getObjectClassName()
      Description copied from class: AbstractObject
      Get name of NetXMS object's class.
      Overrides:
      getObjectClassName in class AbstractObject
      Returns:
      Name of NetXMS object's class
      See Also:

    • 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
      See Also:

    • getMapType

      public MapType getMapType()
      Returns:
      the mapType

    • getLayout

      public MapLayoutAlgorithm getLayout()
      Returns:
      the layout

    • getBackground

      public UUID getBackground()
      Returns:
      the background

    • getSeedObjects

      public List<Long> getSeedObjects()
      Returns:
      the seedObjectIds

    • 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()
      Description copied from interface: PollingTarget
      Get object flags.
      Specified by:
      getFlags in interface PollingTarget
      Returns:
      object flags
      See Also:

    • getDefaultLinkColor

      public int getDefaultLinkColor()
      Returns:
      the defaultLinkColor

    • getDefaultLinkRouting

      public int getDefaultLinkRouting()
      Returns:
      the defaultLinkRouting

    • getDefaultLinkWidth

      public int getDefaultLinkWidth()
      Returns:
      the defaultLinkWidth

    • getDefaultLinkStyle

      public int getDefaultLinkStyle()
      Returns:
      the defaultLinkStyle

    • getBackgroundColor

      public int getBackgroundColor()
      Returns:
      the backgroundColor

    • getDiscoveryRadius

      public final int getDiscoveryRadius()
      Returns:
      the discoveryRadius

    • getFilter

      public String getFilter()
      Returns:
      the filter

    • getLinkStylingScript

      public String getLinkStylingScript()
      Returns:
      the updateLinkScript

    • getObjectDisplayMode

      public MapObjectDisplayMode getObjectDisplayMode()
      Returns:
      the objectDisplayMode

    • getStrings

      public Set<String> getStrings()
      Description copied from class: AbstractObject
      Get all strings in object
      Overrides:
      getStrings in class AbstractObject
      Returns:
      set of all strings in object
      See Also:

    • isShowStatusIcon

      public boolean isShowStatusIcon()
      Returns the MF_SHOW_STATUS_ICON flag status
      Returns:
      true if MF_SHOW_STATUS_ICON flag is set

    • isShowStatusFrame

      public boolean isShowStatusFrame()
      Returns the MF_SHOW_STATUS_FRAME flag status
      Returns:
      true if MF_SHOW_STATUS_FRAME flag is set

    • isShowStatusBackground

      public boolean isShowStatusBackground()
      Returns the MF_SHOW_STATUS_BKGND flag status
      Returns:
      true if MF_SHOW_STATUS_BKGND flag is set

    • isShowEndNodes

      public boolean isShowEndNodes()
      Returns the MF_SHOW_END_NODES flag status
      Returns:
      true if MF_SHOW_END_NODES flag is set

    • isShowLinkDirection

      public boolean isShowLinkDirection()
      Returns the MF_SHOW_LINK_DIRECTION flag status
      Returns:
      true if MF_SHOW_LINK_DIRECTION flag is set

    • isCalculateStatus

      public boolean isCalculateStatus()
      Returns the MF_CALCULATE_STATUS flag status
      Returns:
      true if MF_CALCULATE_STATUS flag is set

    • isCenterBackgroundImage

      public boolean isCenterBackgroundImage()
      Returns the MF_CENTER_BKGND_IMAGE flag status
      Returns:
      true if MF_CENTER_BKGND_IMAGE flag is set

    • isTranslucentLabelBackground

      public boolean isTranslucentLabelBackground()
      Returns the MF_TRANSLUCENT_LABEL_BKGND flag status
      Returns:
      true if MF_TRANSLUCENT_LABEL_BKGND flag is set

    • isDontUpdateLinkText

      public boolean isDontUpdateLinkText()
      Returns the MF_DONT_UPDATE_LINK_TEXT flag status
      Returns:
      true if MF_DONT_UPDATE_LINK_TEXT flag is set

    • isFitBackgroundImage

      public boolean isFitBackgroundImage()
      Returns:
      true if background image should fit map size

    • isFitToScreen

      public boolean isFitToScreen()
      Returns the MF_FIT_TO_SCREEN flag status
      Returns:
      true if MF_FIT_TO_SCREEN flag is set

    • getWidth

      public int getWidth()
      Returns:
      the mapWidth

    • getHeight

      public int getHeight()
      Returns:
      the mapHeight

    • getDisplayPriority

      public int getDisplayPriority()
      Get map's display priority if it should be shown as object view.
      Returns:
      map's display priority

    • isUpdateFailed

      public boolean isUpdateFailed()
      Check if last map update failed.
      Returns:
      true if last map update failed

    • updateWithTemplateData

      public void updateWithTemplateData(NXCObjectModificationData md)
      Update modification data with template fields form this map
      Parameters:
      md - modification data

    • getIfXTablePolicy

      public int getIfXTablePolicy()
      Description copied from interface: PollingTarget
      Get ifXTable usage policy.
      Specified by:
      getIfXTablePolicy in interface PollingTarget
      Returns:
      ifXTable usage policy
      See Also:

    • getAgentCacheMode

      public AgentCacheMode getAgentCacheMode()
      Description copied from interface: PollingTarget
      Get agent cache mode.
      Specified by:
      getAgentCacheMode in interface PollingTarget
      Returns:
      agent cache mode
      See Also:

    • getPollerNodeId

      public long getPollerNodeId()
      Description copied from interface: PollingTarget
      Get poller node ID.
      Specified by:
      getPollerNodeId in interface PollingTarget
      Returns:
      poller node ID or 0 if object cannot have poler node
      See Also:

    • canHaveAgent

      public boolean canHaveAgent()
      Description copied from interface: PollingTarget
      Identify if this object can have NetXMS agent.
      Specified by:
      canHaveAgent in interface PollingTarget
      Returns:
      true if this object can have NetXMS agent
      See Also:

    • canHaveInterfaces

      public boolean canHaveInterfaces()
      Description copied from interface: PollingTarget
      Identify if this object can have network interfaces.
      Specified by:
      canHaveInterfaces in interface PollingTarget
      Returns:
      true if this object can have network interfaces
      See Also:

    • canHavePollerNode

      public boolean canHavePollerNode()
      Description copied from interface: PollingTarget
      Identify if this object can have poller node property.
      Specified by:
      canHavePollerNode in interface PollingTarget
      Returns:
      true if this object can have poller node property
      See Also:

    • canUseEtherNetIP

      public boolean canUseEtherNetIP()
      Description copied from interface: PollingTarget
      Identify if this object can use EtherNet/IP for communications.
      Specified by:
      canUseEtherNetIP in interface PollingTarget
      Returns:
      true if this object can use EtherNet/IP for communications
      See Also:

    • canUseModbus

      public boolean canUseModbus()
      Description copied from interface: PollingTarget
      Identify if this object can use Modbus for communications.
      Specified by:
      canUseModbus in interface PollingTarget
      Returns:
      true if this object can use Modbus for communications
      See Also:

    • getPollStates

      public PollState[] getPollStates()
      Description copied from interface: PollingTarget
      Get poll states.
      Specified by:
      getPollStates in interface PollingTarget
      Returns:
      array of poll states or null if object doesn't have any
      See Also:

    • isAutoBindEnabled

      public boolean isAutoBindEnabled()
      Specified by:
      isAutoBindEnabled in interface AutoBindObject
      Returns:
      true if automatic bind is enabled
      See Also:

    • isAutoUnbindEnabled

      public boolean isAutoUnbindEnabled()
      Specified by:
      isAutoUnbindEnabled in interface AutoBindObject
      Returns:
      true if automatic unbind is enabled
      See Also:

    • getAutoBindFilter

      public String getAutoBindFilter()
      Specified by:
      getAutoBindFilter in interface AutoBindObject
      Returns:
      Filter script for automatic bind
      See Also:

    • getAutoBindFlags

      public int getAutoBindFlags()
      Specified by:
      getAutoBindFlags in interface AutoBindObject
      Returns:
      auto bind flags
      See Also: