Package org.netxms.client.datacollection
Class DataCollectionItem
java.lang.Object
org.netxms.client.datacollection.DataCollectionObject
org.netxms.client.datacollection.DataCollectionItem
Data Collection Item representation
-
Field Summary
Modifier and TypeFieldDescriptionstatic final int
static final int
static final int
static final int
static final int
static final int
static final int
static final int
static final int
static final int
static final int
static final int
static final int
static final int
static final int
static final int
static final int
static final int
static final int
static final int
static final int
static final int
static final int
static final int
static final int
Fields inherited from class org.netxms.client.datacollection.DataCollectionObject
accessList, ACTIVE, 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, DISABLED, flags, id, IDM_AGENT_LIST, IDM_AGENT_TABLE, IDM_INTERNAL_TABLE, IDM_NONE, IDM_SCRIPT, IDM_SNMP_WALK_OIDS, IDM_SNMP_WALK_VALUES, IDM_WEB_SERVICE, IDM_WINPERF, instanceDiscoveryData, instanceDiscoveryFilter, instanceDiscoveryMethod, instanceName, instanceRetentionTime, name, nodeId, NOT_SUPPORTED, origin, owner, perfTabSettings, POLLING_SCHEDULE_ADVANCED, POLLING_SCHEDULE_CUSTOM, POLLING_SCHEDULE_DEFAULT, pollingInterval, pollingScheduleType, relatedObject, resourceId, RETENTION_CUSTOM, RETENTION_DEFAULT, RETENTION_NONE, retentionTime, retentionType, schedules, snmpPort, snmpVersion, sourceNode, stateFlags, status, systemTag, templateId, templateItemId, transformationScript, userData
-
Constructor Summary
ModifierConstructorDescriptionprotected
Default constructor (intended for deserialization)DataCollectionItem
(long nodeId, long id) Constructor for new data collection items.DataCollectionItem
(DataCollectionConfiguration owner, long id) Constructor for new data collection items.protected
DataCollectionItem
(DataCollectionConfiguration owner, long nodeId, long id) Constructor for new data collection items.DataCollectionItem
(DataCollectionConfiguration owner, NXCPMessage msg) Create data collection item object from NXCP messageprotected
Object copy constructor -
Method Summary
Modifier and TypeMethodDescriptionvoid
fillMessage
(NXCPMessage msg) Fill NXCP message with item's data.int
int
int
int
Get multiplier usage mode (DEFAULT, YES, or NO).int
int
boolean
boolean
boolean
boolean
boolean
boolean
boolean
void
setAggregationFunction
(int func) void
setAnomalyDetectionEnabled
(boolean enable) Enable or disable anomaly detection for this DCIvoid
setDataType
(DataType dataType) void
setDeltaCalculation
(int deltaCalculation) void
setMultiplier
(int multiplier) void
setMultiplierSelection
(int mode) Set multiplier usage mode.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 flagvoid
setSnmpRawValueType
(int snmpRawValueType) void
setStoreChangesOnly
(boolean storeChangesOnly) void
setUnitName
(String unitName) void
setUsedForNodeStatusCalculation
(boolean enable) Enable or disable usage of this DCI for node status calculationMethods inherited from class org.netxms.client.datacollection.DataCollectionObject
getAccessList, getCacheMode, getComments, getComparablePollingInterval, getComparableRetentionTime, getDescription, getFlags, getId, getInstanceDiscoveryData, getInstanceDiscoveryFilter, getInstanceDiscoveryMethod, getInstanceName, getInstanceRetentionTime, getName, getNodeId, getOrigin, getOwner, getPerfTabSettings, getPollingInterval, getPollingScheduleType, getRelatedObject, getResourceId, getRetentionTime, getRetentionType, getSchedules, getSnmpPort, getSnmpVersion, getSourceNode, getStateFlags, getStatus, getSystemTag, getTemplateId, getTemplateItemId, getTransformationScript, getUserData, isAggregateOnCluster, isAggregateWithErrors, isHideOnLastValuesView, isNewItem, isTransformAggregated, isUseAdvancedSchedule, setAccessList, setAggregateOnCluster, setAggregateWithErrors, setCacheMode, setComments, setDescription, setFlags, setHideOnLastValuesView, setId, setInstanceDiscoveryData, setInstanceDiscoveryFilter, setInstanceDiscoveryMethod, setInstanceName, setInstanceRetentionTime, setName, setNodeId, setOrigin, setPerfTabSettings, setPollingInterval, setPollingScheduleType, setRelatedObject, setResourceId, setRetentionTime, setRetentionType, setSchedules, setSnmpPort, setSnmpVersion, setSourceNode, setStatus, setSystemTag, setTemplateId, setTransformAggregated, setTransformationScript, setUserData
-
Field Details
-
DCF_DETECT_ANOMALIES
public static final int DCF_DETECT_ANOMALIES- See Also:
-
DCF_ALL_THRESHOLDS
public static final int DCF_ALL_THRESHOLDS- See Also:
-
DCF_RAW_VALUE_OCTET_STRING
public static final int DCF_RAW_VALUE_OCTET_STRING- See Also:
-
DCF_SHOW_ON_OBJECT_TOOLTIP
public static final int DCF_SHOW_ON_OBJECT_TOOLTIP- See Also:
-
DCF_AGGREGATE_FUNCTION_MASK
public static final int DCF_AGGREGATE_FUNCTION_MASK- See Also:
-
DCF_CALCULATE_NODE_STATUS
public static final int DCF_CALCULATE_NODE_STATUS- See Also:
-
DCF_SHOW_IN_OBJECT_OVERVIEW
public static final int DCF_SHOW_IN_OBJECT_OVERVIEW- See Also:
-
DCF_MULTIPLIERS_MASK
public static final int DCF_MULTIPLIERS_MASK- See Also:
-
DCF_STORE_CHANGES_ONLY
public static final int DCF_STORE_CHANGES_ONLY- See Also:
-
DCF_FUNCTION_SUM
public static final int DCF_FUNCTION_SUM- See Also:
-
DCF_FUNCTION_AVG
public static final int DCF_FUNCTION_AVG- See Also:
-
DCF_FUNCTION_MIN
public static final int DCF_FUNCTION_MIN- See Also:
-
DCF_FUNCTION_MAX
public static final int DCF_FUNCTION_MAX- See Also:
-
DELTA_NONE
public static final int DELTA_NONE- See Also:
-
DELTA_SIMPLE
public static final int DELTA_SIMPLE- See Also:
-
DELTA_AVERAGE_PER_SECOND
public static final int DELTA_AVERAGE_PER_SECOND- See Also:
-
DELTA_AVERAGE_PER_MINUTE
public static final int DELTA_AVERAGE_PER_MINUTE- See Also:
-
SNMP_RAWTYPE_NONE
public static final int SNMP_RAWTYPE_NONE- See Also:
-
SNMP_RAWTYPE_INT32
public static final int SNMP_RAWTYPE_INT32- See Also:
-
SNMP_RAWTYPE_UINT32
public static final int SNMP_RAWTYPE_UINT32- See Also:
-
SNMP_RAWTYPE_INT64
public static final int SNMP_RAWTYPE_INT64- See Also:
-
SNMP_RAWTYPE_UINT64
public static final int SNMP_RAWTYPE_UINT64- See Also:
-
SNMP_RAWTYPE_DOUBLE
public static final int SNMP_RAWTYPE_DOUBLE- See Also:
-
SNMP_RAWTYPE_IP_ADDR
public static final int SNMP_RAWTYPE_IP_ADDR- See Also:
-
SNMP_RAWTYPE_MAC_ADDR
public static final int SNMP_RAWTYPE_MAC_ADDR- See Also:
-
-
Constructor Details
-
DataCollectionItem
Create data collection item object from NXCP message- Parameters:
owner
- Owning configuration objectmsg
- NXCP message
-
DataCollectionItem
Constructor for new data collection items.- Parameters:
owner
- Owning configuration objectnodeId
- Owning node IDid
- Identifier assigned to new item
-
DataCollectionItem
Constructor for new data collection items.- Parameters:
owner
- Owning configuration objectid
- Identifier assigned to new item
-
DataCollectionItem
public DataCollectionItem(long nodeId, long id) Constructor for new data collection items.- Parameters:
nodeId
- Owning node IDid
- Identifier assigned to new item
-
DataCollectionItem
protected DataCollectionItem()Default constructor (intended for deserialization) -
DataCollectionItem
Object copy constructor- Parameters:
owner
- object ownersrc
- object to copy
-
-
Method Details
-
fillMessage
Fill NXCP message with item's data.- Overrides:
fillMessage
in classDataCollectionObject
- Parameters:
msg
- NXCP message
-
getDataType
- Returns:
- the dataType
-
setDataType
- 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
-
getMultiplier
public int getMultiplier()- Returns:
- the multiplier
-
setMultiplier
public void setMultiplier(int multiplier) - Parameters:
multiplier
- the multiplier to set
-
getUnitName
- Returns:
- the customUnitName
-
setUnitName
- Parameters:
unitName
- the customUnitName to set
-
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
-
isAnomalyDetectionEnabled
public boolean isAnomalyDetectionEnabled()- Returns:
- State of DCF_DETECT_ANOMALIES flag
-
setAnomalyDetectionEnabled
public void setAnomalyDetectionEnabled(boolean enable) Enable or disable anomaly detection for this DCI- Parameters:
enable
- true to enable
-
getPredictionEngine
- Returns:
- the predictionEngine
-
setPredictionEngine
- Parameters:
predictionEngine
- the predictionEngine to set
-
getMultipliersSelection
public int getMultipliersSelection()Get multiplier usage mode (DEFAULT, YES, or NO).- Returns:
- multiplier usage mode (DEFAULT, YES, or NO).
-
setMultiplierSelection
public void setMultiplierSelection(int mode) Set multiplier usage mode.- Parameters:
mode
- multiplier usage mode (DEFAULT, YES, or NO).
-
isStoreChangesOnly
public boolean isStoreChangesOnly()- Returns:
- the storeChangesOnly.
-
setStoreChangesOnly
public void setStoreChangesOnly(boolean storeChangesOnly) - Parameters:
storeChangesOnly
- the storeChangesOnly to set
-