org.netxms.client.datacollection
Class DataCollectionItem

java.lang.Object
  extended by org.netxms.client.datacollection.DataCollectionItem

public class DataCollectionItem
extends java.lang.Object

Author:
Victor

Field Summary
static int ACTIVE
           
static int AGENT
           
static int CHECKPOINT_SNMP
           
static int DELTA_AVERAGE_PER_MINUTE
           
static int DELTA_AVERAGE_PER_SECOND
           
static int DELTA_NONE
           
static int DELTA_SIMPLE
           
static int DISABLED
           
static int DT_FLOAT
           
static int DT_INT
           
static int DT_INT64
           
static int DT_NULL
           
static int DT_STRING
           
static int DT_UINT
           
static int DT_UINT64
           
static int INTERNAL
           
static int NOT_SUPPORTED
           
static int PUSH
           
static int SNMP
           
 
Constructor Summary
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
 void fillMessage(NXCPMessage msg)
          Fill NXCP message with item's data.
 int getBaseUnits()
           
 java.lang.String getCustomUnitName()
           
 int getDataType()
           
 int getDeltaCalculation()
           
 java.lang.String getDescription()
           
 long getId()
           
 java.lang.String getInstance()
           
 int getMultiplier()
           
 java.lang.String getName()
           
 long getNodeId()
          Get ID of owning node.
 int getOrigin()
           
 DataCollectionConfiguration getOwner()
          Get owning data collection configuration.
 java.lang.String getPerfTabSettings()
           
 int getPollingInterval()
           
 long getProxyNode()
           
 long getResourceId()
           
 int getRetentionTime()
           
 java.util.ArrayList<java.lang.String> getSchedules()
           
 int getSnmpPort()
           
 int getStatus()
           
 java.lang.String getSystemTag()
          Get system tag.
 long getTemplateId()
           
 java.util.ArrayList<Threshold> getThresholds()
           
 java.lang.String getTransformationScript()
           
 boolean isProcessAllThresholds()
           
 boolean isUseAdvancedSchedule()
           
 void setBaseUnits(int baseUnits)
           
 void setCustomUnitName(java.lang.String customUnitName)
           
 void setDataType(int dataType)
           
 void setDeltaCalculation(int deltaCalculation)
           
 void setDescription(java.lang.String description)
           
 void setInstance(java.lang.String instance)
           
 void setMultiplier(int multiplier)
           
 void setName(java.lang.String name)
           
 void setOrigin(int origin)
           
 void setPerfTabSettings(java.lang.String perfTabSettings)
           
 void setPollingInterval(int pollingInterval)
           
 void setProcessAllThresholds(boolean processAllThresholds)
           
 void setProxyNode(long proxyNode)
           
 void setResourceId(long resourceId)
           
 void setRetentionTime(int retentionTime)
           
 void setSchedules(java.util.Collection<java.lang.String> newSchedules)
          Set schedules
 void setSnmpPort(int snmpPort)
           
 void setStatus(int status)
           
 void setSystemTag(java.lang.String systemTag)
          Set system tag.
 void setTemplateId(long templateId)
           
 void setTransformationScript(java.lang.String transformationScript)
           
 void setUseAdvancedSchedule(boolean useAdvancedSchedule)
           
 
Methods inherited from class java.lang.Object
clone, equals, finalize, getClass, hashCode, notify, notifyAll, toString, wait, wait, wait
 

Field Detail

INTERNAL

public static final int INTERNAL
See Also:
Constant Field Values

AGENT

public static final int AGENT
See Also:
Constant Field Values

SNMP

public static final int SNMP
See Also:
Constant Field Values

CHECKPOINT_SNMP

public static final int CHECKPOINT_SNMP
See Also:
Constant Field Values

PUSH

public static final int PUSH
See Also:
Constant Field Values

ACTIVE

public static final int ACTIVE
See Also:
Constant Field Values

DISABLED

public static final int DISABLED
See Also:
Constant Field Values

NOT_SUPPORTED

public static final int NOT_SUPPORTED
See Also:
Constant Field Values

DT_INT

public static final int DT_INT
See Also:
Constant Field Values

DT_UINT

public static final int DT_UINT
See Also:
Constant Field Values

DT_INT64

public static final int DT_INT64
See Also:
Constant Field Values

DT_UINT64

public static final int DT_UINT64
See Also:
Constant Field Values

DT_STRING

public static final int DT_STRING
See Also:
Constant Field Values

DT_FLOAT

public static final int DT_FLOAT
See Also:
Constant Field Values

DT_NULL

public static final int DT_NULL
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
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.

Parameters:
msg - NXCP message

getTemplateId

public long getTemplateId()
Returns:
the templateId

setTemplateId

public void setTemplateId(long templateId)
Parameters:
templateId - the templateId to set

getResourceId

public long getResourceId()
Returns:
the resourceId

setResourceId

public void setResourceId(long resourceId)
Parameters:
resourceId - the resourceId to set

getProxyNode

public long getProxyNode()
Returns:
the proxyNode

setProxyNode

public void setProxyNode(long proxyNode)
Parameters:
proxyNode - the proxyNode to set

getDataType

public int getDataType()
Returns:
the dataType

setDataType

public void setDataType(int dataType)
Parameters:
dataType - the dataType to set

getPollingInterval

public int getPollingInterval()
Returns:
the pollingInterval

setPollingInterval

public void setPollingInterval(int pollingInterval)
Parameters:
pollingInterval - the pollingInterval to set

getRetentionTime

public int getRetentionTime()
Returns:
the retentionTime

setRetentionTime

public void setRetentionTime(int retentionTime)
Parameters:
retentionTime - the retentionTime to set

getOrigin

public int getOrigin()
Returns:
the origin

setOrigin

public void setOrigin(int origin)
Parameters:
origin - the origin to set

getStatus

public int getStatus()
Returns:
the status

setStatus

public void setStatus(int status)
Parameters:
status - the status 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

isUseAdvancedSchedule

public boolean isUseAdvancedSchedule()
Returns:
the useAdvancedSchedule

setUseAdvancedSchedule

public void setUseAdvancedSchedule(boolean useAdvancedSchedule)
Parameters:
useAdvancedSchedule - the useAdvancedSchedule to set

getName

public java.lang.String getName()
Returns:
the name

setName

public void setName(java.lang.String name)
Parameters:
name - the name to set

getDescription

public java.lang.String getDescription()
Returns:
the description

setDescription

public void setDescription(java.lang.String description)
Parameters:
description - the description to set

getTransformationScript

public java.lang.String getTransformationScript()
Returns:
the transformationScript

setTransformationScript

public void setTransformationScript(java.lang.String transformationScript)
Parameters:
transformationScript - the transformationScript to set

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

getId

public long getId()
Returns:
the id

getSchedules

public java.util.ArrayList<java.lang.String> getSchedules()
Returns:
the schedules

setSchedules

public void setSchedules(java.util.Collection<java.lang.String> newSchedules)
Set schedules

Parameters:
newSchedules - Collection containing new schedules

getThresholds

public java.util.ArrayList<Threshold> getThresholds()
Returns:
the thresholds

getOwner

public DataCollectionConfiguration getOwner()
Get owning data collection configuration.

Returns:
the owner

getNodeId

public long getNodeId()
Get ID of owning node.

Returns:

getSystemTag

public java.lang.String getSystemTag()
Get system tag. In most situations, system tag should not be shown to user.

Returns:
System tag associated with this DCI

setSystemTag

public void setSystemTag(java.lang.String systemTag)
Set system tag. In most situations, user should not have possibility to set system tag manually.

Parameters:
systemTag - New system tag for DCI

getPerfTabSettings

public java.lang.String getPerfTabSettings()
Returns:
the perfTabSettings

setPerfTabSettings

public void setPerfTabSettings(java.lang.String perfTabSettings)
Parameters:
perfTabSettings - the perfTabSettings to set

getSnmpPort

public int getSnmpPort()
Returns:
the snmpPort

setSnmpPort

public void setSnmpPort(int snmpPort)
Parameters:
snmpPort - the snmpPort to set


Copyright © 2011. All Rights Reserved.