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 and Description
static int	DCF_AGGREGATE_FUNCTION_MASK
static int	DCF_ALL_THRESHOLDS
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_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	IDM_AGENT_LIST
static int	IDM_AGENT_TABLE
static int	IDM_NONE
static int	IDM_SNMP_WALK_OIDS
static int	IDM_SNMP_WALK_VALUES
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

ACTIVE, AGENT, CHECKPOINT_SNMP, DCF_ADVANCED_SCHEDULE, DCF_AGGREGATE_ON_CLUSTER, DCF_TRANSFORM_AGGREGATED, DCO_TYPE_GENERIC, DCO_TYPE_ITEM, DCO_TYPE_TABLE, description, DISABLED, DT_FLOAT, DT_INT, DT_INT64, DT_NULL, DT_STRING, DT_UINT, DT_UINT64, flags, id, ILO, INTERNAL, name, NOT_SUPPORTED, origin, owner, perfTabSettings, pollingInterval, proxyNode, PUSH, resourceId, retentionTime, schedules, SNMP, snmpPort, status, systemTag, templateId, transformationScript, userData, WINPERF

Constructor Summary

Constructors

Modifier	Constructor and Description
protected	DataCollectionItem(DataCollectionConfiguration owner, long id) Constructor for new data collection items.
protected	DataCollectionItem(DataCollectionConfiguration owner, NXCPMessage msg) Create data collection item object from NXCP message

Method Summary

Methods

Modifier and Type	Method and Description
void	fillMessage(NXCPMessage msg) Fill NXCP message with item's data.
int	getAggregationFunction()
int	getBaseUnits()
java.lang.String	getCustomUnitName()
int	getDataType()
int	getDeltaCalculation()
java.lang.String	getInstance()
java.lang.String	getInstanceDiscoveryData()
java.lang.String	getInstanceDiscoveryFilter()
int	getInstanceDiscoveryMethod()
int	getMultiplier()
int	getSampleCount()
int	getSnmpRawValueType()
java.util.ArrayList<Threshold>	getThresholds()
boolean	isProcessAllThresholds()
boolean	isShowOnObjectTooltip()
boolean	isSnmpRawValueInOctetString()
void	setAggregationFunction(int func)
void	setBaseUnits(int baseUnits)
void	setCustomUnitName(java.lang.String customUnitName)
void	setDataType(int dataType)
void	setDeltaCalculation(int deltaCalculation)
void	setInstance(java.lang.String instance)
void	setInstanceDiscoveryData(java.lang.String instanceDiscoveryData)
void	setInstanceDiscoveryFilter(java.lang.String instanceDiscoveryFilter)
void	setInstanceDiscoveryMethod(int instanceDiscoveryMethod)
void	setMultiplier(int multiplier)
void	setProcessAllThresholds(boolean processAllThresholds)
void	setSampleCount(int sampleCount)
void	setShowOnObjectTooltip(boolean show)
void	setSnmpRawValueInOctetString(boolean enable) Set state of DCF_RAW_VALUE_OCTET_STRING flag
void	setSnmpRawValueType(int snmpRawValueType)

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

getDescription, getFlags, getId, getName, getNodeId, getOrigin, getOwner, getPerfTabSettings, getPollingInterval, getProxyNode, getResourceId, getRetentionTime, getSchedules, getSnmpPort, getStatus, getSystemTag, getTemplateId, getTransformationScript, getUserData, isAggregateOnCluster, isTransformAggregated, isUseAdvancedSchedule, setAggregateOnCluster, setDescription, setFlags, setName, setOrigin, setPerfTabSettings, setPollingInterval, setProxyNode, setResourceId, setRetentionTime, setSchedules, setSnmpPort, setStatus, setSystemTag, setTemplateId, setTransformAggregated, setTransformationScript, setUseAdvancedSchedule, 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_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

IDM_NONE

public static final int IDM_NONE

See Also:

Constant Field Values

IDM_AGENT_LIST

public static final int IDM_AGENT_LIST

See Also:

Constant Field Values

IDM_AGENT_TABLE

public static final int IDM_AGENT_TABLE

See Also:

Constant Field Values

IDM_SNMP_WALK_VALUES

public static final int IDM_SNMP_WALK_VALUES

See Also:

Constant Field Values

IDM_SNMP_WALK_OIDS

public static final int IDM_SNMP_WALK_OIDS

See Also:

Constant Field Values

Constructor Detail

DataCollectionItem

protected DataCollectionItem(DataCollectionConfiguration owner,
                  NXCPMessage msg)

Create data collection item object from NXCP message

Parameters:

owner - Owning configuration object

msg - NXCP message

DataCollectionItem

protected DataCollectionItem(DataCollectionConfiguration owner,
                  long id)

Constructor for new data collection items.

Parameters:

owner - Owning configuration object

id - Identifier assigned to new item

Method Detail

fillMessage

public void fillMessage(NXCPMessage msg)

Fill NXCP message with item's data.

Overrides:

fillMessage in class DataCollectionObject

Parameters:

msg - NXCP message

getDataType

public int getDataType()

Returns:

the dataType

setDataType

public void setDataType(int 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 -

isShowOnObjectTooltip

public boolean isShowOnObjectTooltip()

Returns:

the processAllThresholds

setShowOnObjectTooltip

public void setShowOnObjectTooltip(boolean show)

Parameters:

processAllThresholds - the processAllThresholds to set

getAggregationFunction

public int getAggregationFunction()

Returns:

aggregation function

setAggregationFunction

public void setAggregationFunction(int func)

Parameters:

func -

getInstance

public java.lang.String getInstance()

Returns:

the instance

setInstance

public void setInstance(java.lang.String instance)

Parameters:

instance - the instance 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 java.lang.String getCustomUnitName()

Returns:

the customUnitName

setCustomUnitName

public void setCustomUnitName(java.lang.String customUnitName)

Parameters:

customUnitName - the customUnitName to set

getThresholds

public java.util.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

getInstanceDiscoveryMethod

public final int getInstanceDiscoveryMethod()

Returns:

the instanceDiscoveryMethod

setInstanceDiscoveryMethod

public final void setInstanceDiscoveryMethod(int instanceDiscoveryMethod)

Parameters:

instanceDiscoveryMethod - the instanceDiscoveryMethod to set

getInstanceDiscoveryData

public final java.lang.String getInstanceDiscoveryData()

Returns:

the instanceDiscoveryData

setInstanceDiscoveryData

public final void setInstanceDiscoveryData(java.lang.String instanceDiscoveryData)

Parameters:

instanceDiscoveryData - the instanceDiscoveryData to set

getInstanceDiscoveryFilter

public final java.lang.String getInstanceDiscoveryFilter()

Returns:

the instanceDiscoveryFilter

setInstanceDiscoveryFilter

public final void setInstanceDiscoveryFilter(java.lang.String instanceDiscoveryFilter)

Parameters:

instanceDiscoveryFilter - the instanceDiscoveryFilter to set

getSampleCount

public int getSampleCount()

Returns:

the sampleCount

setSampleCount

public void setSampleCount(int sampleCount)

Parameters:

sampleCount - the sampleCount to set