Package org.netxms.client.maps

Class MapDCIInstance

java.lang.Object

org.netxms.client.maps.MapDCIInstance

public class MapDCIInstance
extends Object

Class that stores data of map DCI that's last values should be requested from server

Constructor Summary

Constructors

Constructor	Description
MapDCIInstance(long dciID, long nodeID, int type, String mapId)	Constructor for MapDCIInstance for simple DCI
MapDCIInstance(long dciID, long nodeID, String column, String instance, int type, String mapId)	Constructor for MapDCIInstance for table DCI

Method Summary

Modifier and Type	Method	Description
void	addMap(String id)	Add map reference
boolean	equals(Object object)
void	fillMessage(org.netxms.base.NXCPMessage msg, long base)	This method fills message with data if all required data present.
String	getColumn()
long	getDciID()
String	getInstance()
long	getNodeID()
int	getType()
int	hashCode()
boolean	removeMap(String id)	Remove map reference
void	setColumn(String column)
void	setDciID(long dciID)
void	setInstance(String instance)
void	setNodeID(long nodeID)
void	setType(int type)

Methods inherited from class java.lang.Object

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

Constructor Detail

MapDCIInstance

public MapDCIInstance(long dciID,
                      long nodeID,
                      String column,
                      String instance,
                      int type,
                      String mapId)

Constructor for MapDCIInstance for table DCI

Parameters:

dciID - id of required DCI

nodeID - id of associated node. Is collected to fully fill DciValue instances

column - column if DCI is a table DCI

instance - instance if DCI is a table DCI

type - type of DCI

MapDCIInstance

public MapDCIInstance(long dciID,
                      long nodeID,
                      int type,
                      String mapId)

Constructor for MapDCIInstance for simple DCI

Parameters:

dciID - id of required DCI

nodeID - id of associated node. Is collected to fully fill DciValue instances

type - type of DCI

Method Detail

getColumn

public String getColumn()

Returns:

the column

setColumn

public void setColumn(String column)

Parameters:

column - the column to set

getInstance

public String getInstance()

Returns:

the instance

setInstance

public void setInstance(String instance)

Parameters:

instance - the instance to set

getDciID

public long getDciID()

Returns:

the dciID

setDciID

public void setDciID(long dciID)

Parameters:

dciID - the dciID to set

getType

public int getType()

Returns:

the type

setType

public void setType(int type)

Parameters:

type - the type to set

getNodeID

public long getNodeID()

Returns:

the nodeID

setNodeID

public void setNodeID(long nodeID)

Parameters:

nodeID - the nodeID to set

fillMessage

public void fillMessage(org.netxms.base.NXCPMessage msg,
                        long base)

This method fills message with data if all required data present. In case of table DCI if column or/and instance are not present, then this DCI value will not be requested.

Parameters:

msg - Message that should be populated with data

base - the base of this data

addMap

public void addMap(String id)

Add map reference

Parameters:

id - map ID

removeMap

public boolean removeMap(String id)

Remove map reference

Parameters:

id - map ID

Returns:

true if last map reference was removed

hashCode

public int hashCode()

Overrides:

hashCode in class Object

equals

public boolean equals(Object object)

Overrides:

equals in class Object