Package org.netxms.client.datacollection

Class DataCollectionItem

java.lang.Object

org.netxms.client.datacollection.DataCollectionObject

org.netxms.client.datacollection.DataCollectionItem

public class DataCollectionItem
extends DataCollectionObject

Data Collection Item representation

Field Summary

Fields

Modifier and Type	Field	Description
static int	DCF_AGGREGATE_FUNCTION_MASK
static int	DCF_ALL_THRESHOLDS
static int	DCF_CALCULATE_NODE_STATUS
static int	DCF_FUNCTION_AVG
static int	DCF_FUNCTION_MAX
static int	DCF_FUNCTION_MIN
static int	DCF_FUNCTION_SUM
static int	DCF_RAW_VALUE_OCTET_STRING
static int	DCF_SHOW_IN_OBJECT_OVERVIEW
static int	DCF_SHOW_ON_OBJECT_TOOLTIP
static int	DELTA_AVERAGE_PER_MINUTE
static int	DELTA_AVERAGE_PER_SECOND
static int	DELTA_NONE
static int	DELTA_SIMPLE
static int	SNMP_RAWTYPE_DOUBLE
static int	SNMP_RAWTYPE_INT32
static int	SNMP_RAWTYPE_INT64
static int	SNMP_RAWTYPE_IP_ADDR
static int	SNMP_RAWTYPE_MAC_ADDR
static int	SNMP_RAWTYPE_NONE
static int	SNMP_RAWTYPE_UINT32
static int	SNMP_RAWTYPE_UINT64

Fields inherited from class org.netxms.client.datacollection.DataCollectionObject

accessList, ACTIVE, AGENT, comments, DCF_AGGREGATE_ON_CLUSTER, DCF_AGGREGATE_WITH_ERRORS, DCF_CACHE_MODE_MASK, DCF_HIDE_ON_LAST_VALUES_PAGE, DCF_TRANSFORM_AGGREGATED, DCO_TYPE_GENERIC, DCO_TYPE_ITEM, DCO_TYPE_TABLE, description, DEVICE_DRIVER, DISABLED, flags, id, IDM_AGENT_LIST, IDM_AGENT_TABLE, IDM_NONE, IDM_SCRIPT, IDM_SNMP_WALK_OIDS, IDM_SNMP_WALK_VALUES, instance, instanceDiscoveryData, instanceDiscoveryFilter, instanceDiscoveryMethod, instanceRetentionTime, INTERNAL, MQTT, name, NOT_SUPPORTED, origin, owner, perfTabSettings, POLLING_SCHEDULE_ADVANCED, POLLING_SCHEDULE_CUSTOM, POLLING_SCHEDULE_DEFAULT, pollingInterval, pollingScheduleType, PUSH, relatedObject, resourceId, RETENTION_CUSTOM, RETENTION_DEFAULT, RETENTION_NONE, retentionTime, retentionType, schedules, SCRIPT, SMCLP, SNMP, snmpPort, snmpVersion, sourceNode, SSH, status, systemTag, templateId, transformationScript, userData, WEB_SERVICE, WINPERF

Constructor Summary

Constructors

Modifier	Constructor	Description
	DataCollectionItem(DataCollectionConfiguration owner, long id)	Constructor for new data collection items.
	DataCollectionItem(DataCollectionConfiguration owner, org.netxms.base.NXCPMessage msg)	Create data collection item object from NXCP message
protected	DataCollectionItem(DataCollectionConfiguration owner, DataCollectionItem dco)	Object copy constructor

Method Summary

Modifier and Type	Method	Description
void	fillMessage(org.netxms.base.NXCPMessage msg)	Fill NXCP message with item's data.
int	getAggregationFunction()
int	getBaseUnits()
String	getCustomUnitName()
DataType	getDataType()
int	getDeltaCalculation()
int	getMultiplier()
String	getPredictionEngine()
int	getSampleCount()
int	getSnmpRawValueType()
ArrayList<Threshold>	getThresholds()
boolean	isProcessAllThresholds()
boolean	isShowInObjectOverview()
boolean	isShowOnObjectTooltip()
boolean	isSnmpRawValueInOctetString()
boolean	isUsedForNodeStatusCalculation()
void	setAggregationFunction(int func)
void	setBaseUnits(int baseUnits)
void	setCustomUnitName(String customUnitName)
void	setDataType(DataType dataType)
void	setDeltaCalculation(int deltaCalculation)
void	setMultiplier(int multiplier)
void	setPredictionEngine(String predictionEngine)
void	setProcessAllThresholds(boolean processAllThresholds)
void	setSampleCount(int sampleCount)
void	setShowInObjectOverview(boolean show)
void	setShowOnObjectTooltip(boolean show)
void	setSnmpRawValueInOctetString(boolean enable)	Set state of DCF_RAW_VALUE_OCTET_STRING flag
void	setSnmpRawValueType(int snmpRawValueType)
void	setUsedForNodeStatusCalculation(boolean enable)	Enable or disable usage of this DCI for node status calculation

Methods inherited from class org.netxms.client.datacollection.DataCollectionObject

getAccessList, getCacheMode, getComments, getComparablePollingInterval, getComparableRetentionTime, getDescription, getFlags, getId, getInstance, getInstanceDiscoveryData, getInstanceDiscoveryFilter, getInstanceDiscoveryMethod, getInstanceRetentionTime, getName, getNodeId, getOrigin, getOwner, getPerfTabSettings, getPollingInterval, getPollingScheduleType, getRelatedObject, getResourceId, getRetentionTime, getRetentionType, getSchedules, getSnmpPort, getSnmpVersion, getSourceNode, getStatus, getSystemTag, getTemplateId, getTransformationScript, getUserData, isAggregateOnCluster, isAggregateWithErrors, isHideOnLastValuesView, isNewItem, isTransformAggregated, isUseAdvancedSchedule, setAccessList, setAggregateOnCluster, setAggregateWithErrors, setCacheMode, setComments, setDescription, setFlags, setHideOnLastValuesView, setId, setInstance, setInstanceDiscoveryData, setInstanceDiscoveryFilter, setInstanceDiscoveryMethod, setInstanceRetentionTime, setName, setOrigin, setPerfTabSettings, setPollingInterval, setPollingScheduleType, setRelatedObject, setResourceId, setRetentionTime, setRetentionType, setSchedules, setSnmpPort, setSnmpVersion, setSourceNode, setStatus, setSystemTag, setTemplateId, setTransformAggregated, setTransformationScript, setUserData

Methods inherited from class java.lang.Object

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

Field Detail

DCF_ALL_THRESHOLDS

public static final int DCF_ALL_THRESHOLDS

See Also:

Constant Field Values

DCF_RAW_VALUE_OCTET_STRING

public static final int DCF_RAW_VALUE_OCTET_STRING

See Also:

Constant Field Values

DCF_SHOW_ON_OBJECT_TOOLTIP

public static final int DCF_SHOW_ON_OBJECT_TOOLTIP

See Also:

Constant Field Values

DCF_AGGREGATE_FUNCTION_MASK

public static final int DCF_AGGREGATE_FUNCTION_MASK

See Also:

Constant Field Values

DCF_CALCULATE_NODE_STATUS

public static final int DCF_CALCULATE_NODE_STATUS

See Also:

Constant Field Values

DCF_SHOW_IN_OBJECT_OVERVIEW

public static final int DCF_SHOW_IN_OBJECT_OVERVIEW

See Also:

Constant Field Values

DCF_FUNCTION_SUM

public static final int DCF_FUNCTION_SUM

See Also:

Constant Field Values

DCF_FUNCTION_AVG

public static final int DCF_FUNCTION_AVG

See Also:

Constant Field Values

DCF_FUNCTION_MIN

public static final int DCF_FUNCTION_MIN

See Also:

Constant Field Values

DCF_FUNCTION_MAX

public static final int DCF_FUNCTION_MAX

See Also:

Constant Field Values

DELTA_NONE

public static final int DELTA_NONE

See Also:

Constant Field Values

DELTA_SIMPLE

public static final int DELTA_SIMPLE

See Also:

Constant Field Values

DELTA_AVERAGE_PER_SECOND

public static final int DELTA_AVERAGE_PER_SECOND

See Also:

Constant Field Values

DELTA_AVERAGE_PER_MINUTE

public static final int DELTA_AVERAGE_PER_MINUTE

See Also:

Constant Field Values

SNMP_RAWTYPE_NONE

public static final int SNMP_RAWTYPE_NONE

See Also:

Constant Field Values

SNMP_RAWTYPE_INT32

public static final int SNMP_RAWTYPE_INT32

See Also:

Constant Field Values

SNMP_RAWTYPE_UINT32

public static final int SNMP_RAWTYPE_UINT32

See Also:

Constant Field Values

SNMP_RAWTYPE_INT64

public static final int SNMP_RAWTYPE_INT64

See Also:

Constant Field Values

SNMP_RAWTYPE_UINT64

public static final int SNMP_RAWTYPE_UINT64

See Also:

Constant Field Values

SNMP_RAWTYPE_DOUBLE

public static final int SNMP_RAWTYPE_DOUBLE

See Also:

Constant Field Values

SNMP_RAWTYPE_IP_ADDR

public static final int SNMP_RAWTYPE_IP_ADDR

See Also:

Constant Field Values

SNMP_RAWTYPE_MAC_ADDR

public static final int SNMP_RAWTYPE_MAC_ADDR

See Also:

Constant Field Values

Constructor Detail

DataCollectionItem

public DataCollectionItem(DataCollectionConfiguration owner,
                          org.netxms.base.NXCPMessage msg)

Create data collection item object from NXCP message

Parameters:

owner - Owning configuration object

msg - NXCP message

DataCollectionItem

public DataCollectionItem(DataCollectionConfiguration owner,
                          long id)

Constructor for new data collection items.

Parameters:

owner - Owning configuration object

id - Identifier assigned to new item

DataCollectionItem

protected DataCollectionItem(DataCollectionConfiguration owner,
                             DataCollectionItem dco)

Object copy constructor

Parameters:

owner - object owner

dco - object to copy

Method Detail

fillMessage

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

Fill NXCP message with item's data.

Overrides:

fillMessage in class DataCollectionObject

Parameters:

msg - NXCP message

getDataType

public DataType getDataType()

Returns:

the dataType

setDataType

public void setDataType(DataType dataType)

Parameters:

dataType - the dataType to set

getDeltaCalculation

public int getDeltaCalculation()

Returns:

the deltaCalculation

setDeltaCalculation

public void setDeltaCalculation(int deltaCalculation)

Parameters:

deltaCalculation - the deltaCalculation to set

isProcessAllThresholds

public boolean isProcessAllThresholds()

Returns:

the processAllThresholds

setProcessAllThresholds

public void setProcessAllThresholds(boolean processAllThresholds)

Parameters:

processAllThresholds - the processAllThresholds to set

isSnmpRawValueInOctetString

public boolean isSnmpRawValueInOctetString()

Returns:

State of DCF_RAW_VALUE_OCTET_STRING flag

setSnmpRawValueInOctetString

public void setSnmpRawValueInOctetString(boolean enable)

Set state of DCF_RAW_VALUE_OCTET_STRING flag

Parameters:

enable - true to enable

isShowOnObjectTooltip

public boolean isShowOnObjectTooltip()

Returns:

true of DCI should be shown on object tooltip

setShowOnObjectTooltip

public void setShowOnObjectTooltip(boolean show)

Parameters:

show - indicator if DCI should be shown on object tooltip

isShowInObjectOverview

public boolean isShowInObjectOverview()

Returns:

true of DCI should be shown in object overview

setShowInObjectOverview

public void setShowInObjectOverview(boolean show)

Parameters:

show - indicator if DCI should be shown in object overview

getAggregationFunction

public int getAggregationFunction()

Returns:

aggregation function

setAggregationFunction

public void setAggregationFunction(int func)

Parameters:

func - The function to set

getBaseUnits

public int getBaseUnits()

Returns:

the baseUnits

setBaseUnits

public void setBaseUnits(int baseUnits)

Parameters:

baseUnits - the baseUnits to set

getMultiplier

public int getMultiplier()

Returns:

the multiplier

setMultiplier

public void setMultiplier(int multiplier)

Parameters:

multiplier - the multiplier to set

getCustomUnitName

public String getCustomUnitName()

Returns:

the customUnitName

setCustomUnitName

public void setCustomUnitName(String customUnitName)

Parameters:

customUnitName - the customUnitName to set

getThresholds

public ArrayList<Threshold> getThresholds()

Returns:

the thresholds

getSnmpRawValueType

public int getSnmpRawValueType()

Returns:

the snmpRawValueType

setSnmpRawValueType

public void setSnmpRawValueType(int snmpRawValueType)

Parameters:

snmpRawValueType - the snmpRawValueType to set

getSampleCount

public int getSampleCount()

Returns:

the sampleCount

setSampleCount

public void setSampleCount(int sampleCount)

Parameters:

sampleCount - the sampleCount to set

isUsedForNodeStatusCalculation

public boolean isUsedForNodeStatusCalculation()

Returns:

State of DCF_CALCULATE_NODE_STATUS flag

setUsedForNodeStatusCalculation

public void setUsedForNodeStatusCalculation(boolean enable)

Enable or disable usage of this DCI for node status calculation

Parameters:

enable - true to enable

getPredictionEngine

public String getPredictionEngine()

Returns:

the predictionEngine

setPredictionEngine

public void setPredictionEngine(String predictionEngine)

Parameters:

predictionEngine - the predictionEngine to set