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 Details

  • Constructor Details

    • DataCollectionItem

      public 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 nodeId, long id)
      Constructor for new data collection items.
      Parameters:
      owner - Owning configuration object
      nodeId - Owning node ID
      id - Identifier assigned to new item

    • 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

      public DataCollectionItem(long nodeId, long id)
      Constructor for new data collection items.
      Parameters:
      nodeId - Owning node ID
      id - Identifier assigned to new item

    • DataCollectionItem

      protected DataCollectionItem()
      Default constructor (intended for deserialization)

    • DataCollectionItem

      protected DataCollectionItem(DataCollectionConfiguration owner, DataCollectionItem src)
      Object copy constructor
      Parameters:
      owner - object owner
      src - object to copy

  • Method Details

    • fillMessage

      public void fillMessage(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

    • getTransformedDataType

      public DataType getTransformedDataType()
      Returns:
      the transformedDataType

    • setTransformedDataType

      public void setTransformedDataType(DataType transformedDataType)
      Parameters:
      transformedDataType - the transformedDataType 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

      public String getUnitName()
      Returns:
      the customUnitName

    • setUnitName

      public void setUnitName(String unitName)
      Parameters:
      unitName - the customUnitName to set

    • getThresholds

      public List<Threshold> getThresholds()
      Returns:
      the thresholds

    • getAllThresholdsRearmEvent

      public int getAllThresholdsRearmEvent()
      Returns:
      the allThresholdsRearmEvent

    • setAllThresholdsRearmEvent

      public void setAllThresholdsRearmEvent(int allThresholdsRearmEvent)
      Parameters:
      allThresholdsRearmEvent - the allThresholdsRearmEvent to set

    • 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

    • isAnomalyDetectionEnabledIF

      public boolean isAnomalyDetectionEnabledIF()
      Check if anomaly detection using isolation forest is enabled for this DCI
      Returns:
      true if enabled

    • isAnomalyDetectionEnabledAI

      public boolean isAnomalyDetectionEnabledAI()
      Check if anomaly detection using AI is enabled for this DCI
      Returns:
      true if enabled

    • setAnomalyDetectionEnabled

      public void setAnomalyDetectionEnabled(boolean enableIF, boolean enableAI)
      Enable or disable anomaly detection for this DCI
      Parameters:
      enableIF - true to enable isolation forest based anomaly detection
      enableAI - true to enable AI based anomaly detection

    • 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

    • isUseMibEnumValues

      public boolean isUseMibEnumValues()
      Returns:
      state of DCF_USE_SNMP_MIB_ENUM flag

    • setUseMibEnumValues

      public void setUseMibEnumValues(boolean enable)
      Set state of DCF_USE_SNMP_MIB_ENUM flag.
      Parameters:
      enable - true to enable MIB enum label substitution on display

    • getSampleSaveInterval

      public int getSampleSaveInterval()
      Get sample save interval (save every N-th sample).
      Returns:
      sample save interval (1 = save all samples)

    • setSampleSaveInterval

      public void setSampleSaveInterval(int sampleSaveInterval)
      Set sample save interval (save every N-th sample).
      Parameters:
      sampleSaveInterval - sample save interval (1 = save all samples)

    • getAiHint

      public String getAiHint()
      Returns:
      the aiHint

    • setAiHint

      public void setAiHint(String aiHint)
      Parameters:
      aiHint - the aiHint to set

    • getAggregationMode

      public DciAggregationMode getAggregationMode()
      Get per-DCI aggregation mode override (INHERIT defers to global switch).
      Returns:
      aggregation mode

    • setAggregationMode

      public void setAggregationMode(DciAggregationMode aggregationMode)
      Parameters:
      aggregationMode - aggregation mode to set

    • getHourlyRetention

      public int getHourlyRetention()
      Get per-DCI hourly aggregate retention override in days. 0 means use the global default.
      Returns:
      hourly retention override in days, or 0 for default

    • setHourlyRetention

      public void setHourlyRetention(int hourlyRetention)
      Parameters:
      hourlyRetention - hourly retention in days, or 0 to use default

    • getDailyRetention

      public int getDailyRetention()
      Get per-DCI daily aggregate retention override in days. 0 means use the global default.
      Returns:
      daily retention override in days, or 0 for default

    • setDailyRetention

      public void setDailyRetention(int dailyRetention)
      Parameters:
      dailyRetention - daily retention in days, or 0 to use default