NetworkMapLink (netxms-client 2.2.8 API)

java.lang.Object
- org.netxms.client.maps.NetworkMapLink

public class NetworkMapLink
extends Object

Represents link between two elements on map

Field Summary

Fields
Modifier and Type	Field and Description
`static int`	`MULTILINK`
`static int`	`NORMAL`
`static int`	`ROUTING_BENDPOINTS`
`static int`	`ROUTING_DEFAULT`
`static int`	`ROUTING_DIRECT`
`static int`	`ROUTING_MANHATTAN`
`static int`	`VPN`

Constructor Summary

Constructors
Constructor and Description
`NetworkMapLink(int type, long element1, long element2)`
`NetworkMapLink(NXCPMessage msg, long baseId)` Create link object from NXCP message
`NetworkMapLink(String name, int type, long element1, long element2, String connectorName1, String connectorName2, int flags)`
`NetworkMapLink(String name, int type, long element1, long element2, String connectorName1, String connectorName2, SingleDciConfig[] dciList, int flags, boolean isLocked)`

Method Summary

All Methods Instance Methods Concrete Methods
Modifier and Type	Method and Description
`void`	`fillMessage(NXCPMessage msg, long baseId)` Fill NXCP message with link data
`long[]`	`getBendPoints()`
`int`	`getColor()`
`int`	`getColorSource()` Get color source
`LinkConfig`	`getConfig()`
`String`	`getConnectorName1()`
`String`	`getConnectorName2()`
`List<SingleDciConfig>`	`getDciAsList()` Returns DCI array as a list
`SingleDciConfig[]`	`getDciList()`
`long`	`getElement1()`
`long`	`getElement2()`
`int`	`getFlags()`
`String`	`getLabel()` Get label for display.
`String`	`getName()`
`int`	`getRouting()`
`List<Long>`	`getStatusObjects()` Get list of objects used for status calculation
`int`	`getType()`
`boolean`	`hasConnectorName1()` Check if link has non-empty name for connector 1
`boolean`	`hasConnectorName2()` Check if link has non-empty name for connector 2
`boolean`	`hasDciData()`
`boolean`	`hasName()` Check if link has non-empty name
`void`	`initData(String name, int type, long element1, long element2, String connectorName1, String connectorName2, int flags)`
`boolean`	`isLocked()`
`boolean`	`isUnnamed()` Check if this link is unnamed.
`void`	`setBendPoints(long[] bendPoints)`
`void`	`setColor(int color)`
`void`	`setColorSource(int colorSource)` Set color source
`void`	`setConnectorName1(String connectorName1)`
`void`	`setConnectorName2(String connectorName2)`
`void`	`setFlags(int flags)`
`void`	`setLocked(boolean isLocked)`
`void`	`setName(String name)`
`void`	`setRouting(int routing)`
`void`	`setStatusObjects(List<Long> statusObjects)` Set list of objects used for status calculation
`String`	`toString()`

Methods inherited from class java.lang.Object
clone, equals, finalize, getClass, hashCode, notify, notifyAll, wait, wait, wait

- Field Detail
  - NORMAL
```
public static final int NORMAL
```
    See Also:
    
    Constant Field Values
  - VPN
```
public static final int VPN
```
    See Also:
    
    Constant Field Values
  - MULTILINK
```
public static final int MULTILINK
```
    See Also:
    
    Constant Field Values
  - ROUTING_DEFAULT
```
public static final int ROUTING_DEFAULT
```
    See Also:
    
    Constant Field Values
  - ROUTING_DIRECT
```
public static final int ROUTING_DIRECT
```
    See Also:
    
    Constant Field Values
  - ROUTING_MANHATTAN
```
public static final int ROUTING_MANHATTAN
```
    See Also:
    
    Constant Field Values
  - ROUTING_BENDPOINTS
```
public static final int ROUTING_BENDPOINTS
```
    See Also:
    
    Constant Field Values
- Constructor Detail
  - NetworkMapLink
```
public NetworkMapLink(String name,
                      int type,
                      long element1,
                      long element2,
                      String connectorName1,
                      String connectorName2,
                      SingleDciConfig[] dciList,
                      int flags,
                      boolean isLocked)
```
    Parameters:
    
    name -
    
    type -
    
    element1 -
    
    element2 -
    
    connectorName1 -
    
    connectorName2 -
    
    dciList -
    
    flags -
  - NetworkMapLink
```
public NetworkMapLink(String name,
                      int type,
                      long element1,
                      long element2,
                      String connectorName1,
                      String connectorName2,
                      int flags)
```
    Parameters:
    
    name -
    
    type -
    
    element1 -
    
    element2 -
    
    connectorName1 -
    
    connectorName2 -
    
    flags -
  - NetworkMapLink
```
public NetworkMapLink(int type,
                      long element1,
                      long element2)
```
    Parameters:
    
    type -
    
    element1 -
    
    element2 -
  - NetworkMapLink
```
public NetworkMapLink(NXCPMessage msg,
                      long baseId)
```
    Create link object from NXCP message
    
    Parameters:
    
    msg - NXCP message
    
    baseId - base variable ID
- Method Detail
  - initData
```
public void initData(String name,
                     int type,
                     long element1,
                     long element2,
                     String connectorName1,
                     String connectorName2,
                     int flags)
```
    Parameters:
    
    name -
    
    type -
    
    element1 -
    
    element2 -
    
    connectorName1 -
    
    connectorName2 -
    
    flags -
  - fillMessage
```
public void fillMessage(NXCPMessage msg,
                        long baseId)
```
    Fill NXCP message with link data
    
    Parameters:
    
    msg - NXCP message
    
    baseId - base variable ID
  - getType
```
public int getType()
```
    Returns:
    
    the linkType
  - getElement1
```
public long getElement1()
```
    Returns:
    
    first (left) element
  - getElement2
```
public long getElement2()
```
    Returns:
    
    second (right) element
  - getConnectorName1
```
public String getConnectorName1()
```
    Returns:
    
    first (left) connector name
  - getConnectorName2
```
public String getConnectorName2()
```
    Returns:
    
    second (right) connector name
  - getName
```
public String getName()
```
    Returns:
    
    the name
  - getLabel
```
public String getLabel()
```
    Get label for display. If name is not null and not empty, label will have form name (connector1 - connector2) otherwise it will have form connector1 - connector2 If any of connector names is null or empty, it will be replaced with string "<noname>".
    
    Returns:
    
    display label or null for unnamed link
  - hasName
```
public boolean hasName()
```
    Check if link has non-empty name
    
    Returns:
    
    true if link has non-empty name
  - hasConnectorName1
```
public boolean hasConnectorName1()
```
    Check if link has non-empty name for connector 1
    
    Returns:
    
    true if link has non-empty name for connector 1
  - hasConnectorName2
```
public boolean hasConnectorName2()
```
    Check if link has non-empty name for connector 2
    
    Returns:
    
    true if link has non-empty name for connector 2
  - isUnnamed
```
public boolean isUnnamed()
```
    Check if this link is unnamed.
    
    Returns:
    
    true if all names (link and both connectors) are null or empty
  - getColor
```
public int getColor()
```
    Returns:
    
    the color
  - setColor
```
public void setColor(int color)
```
    Parameters:
    
    color - the color to set
  - getColorSource
```
public int getColorSource()
```
    Get color source
    
    Returns:
    
    color source
  - setColorSource
```
public void setColorSource(int colorSource)
```
    Set color source
    
    Parameters:
    
    colorSource - new color source
  - getStatusObjects
```
public List<Long> getStatusObjects()
```
    Get list of objects used for status calculation
    
    Returns:
    
    list of objects used for status calculation
  - setStatusObjects
```
public void setStatusObjects(List<Long> statusObjects)
```
    Set list of objects used for status calculation
    
    Parameters:
    
    statusObjects - new list of objects
  - getRouting
```
public int getRouting()
```
    Returns:
    
    the routing
  - setRouting
```
public void setRouting(int routing)
```
    Parameters:
    
    routing - the routing to set
  - getBendPoints
```
public long[] getBendPoints()
```
    Returns:
    
    the bendPoints
  - setBendPoints
```
public void setBendPoints(long[] bendPoints)
```
    Parameters:
    
    bendPoints - the bendPoints to set
  - getFlags
```
public int getFlags()
```
    Returns:
    
    the flags
  - setFlags
```
public void setFlags(int flags)
```
    Parameters:
    
    flags - the flags to set
  - hasDciData
```
public boolean hasDciData()
```
    Returns:
    
    returns if DCI list is not empty
  - getDciList
```
public SingleDciConfig[] getDciList()
```
    Returns:
    
    returns the DCI list if not empty or null
  - getDciAsList
```
public List<SingleDciConfig> getDciAsList()
```
    Returns DCI array as a list
  - setName
```
public void setName(String name)
```
    Parameters:
    
    name - the name to set
  - setConnectorName1
```
public void setConnectorName1(String connectorName1)
```
    Parameters:
    
    connectorName1 - the connectorName1 to set
  - setConnectorName2
```
public void setConnectorName2(String connectorName2)
```
    Parameters:
    
    connectorName2 - the connectorName2 to set
  - getConfig
```
public LinkConfig getConfig()
```
    Returns:
    
    link config
  - isLocked
```
public boolean isLocked()
```
  - setLocked
```
public void setLocked(boolean isLocked)
```
    Parameters:
    
    isLocked - set true if link should be locked
  - toString
```
public String toString()
```
    Overrides:
    
    toString in class Object

Class NetworkMapLink

Field Summary

Constructor Summary

Method Summary

Methods inherited from class java.lang.Object

Field Detail

NORMAL

VPN

MULTILINK

ROUTING_DEFAULT

ROUTING_DIRECT

ROUTING_MANHATTAN

ROUTING_BENDPOINTS

Constructor Detail

NetworkMapLink

NetworkMapLink

NetworkMapLink

NetworkMapLink

Method Detail

initData

fillMessage

getType

getElement1

getElement2

getConnectorName1

getConnectorName2

getName

getLabel

hasName

hasConnectorName1

hasConnectorName2

isUnnamed

getColor

setColor

getColorSource

setColorSource

getStatusObjects

setStatusObjects

getRouting

setRouting

getBendPoints

setBendPoints

getFlags

setFlags

hasDciData

getDciList

getDciAsList

setName

setConnectorName1

setConnectorName2

getConfig

isLocked

setLocked

toString