org.netxms.client.datacollection

Class DataCollectionObject

java.lang.Object

org.netxms.client.datacollection.DataCollectionObject

Direct Known Subclasses:

DataCollectionItem, DataCollectionTable

public abstract class DataCollectionObject
extends java.lang.Object

Abstract data collection object

Field Summary

Fields

Modifier and Type	Field and Description
static int	ACTIVE
static int	AGENT
static int	CHECKPOINT_SNMP
static int	DCF_ADVANCED_SCHEDULE
static int	DCF_AGGREGATE_ON_CLUSTER
static int	DCF_TRANSFORM_AGGREGATED
static int	DCO_TYPE_GENERIC
static int	DCO_TYPE_ITEM
static int	DCO_TYPE_TABLE
protected java.lang.String	description
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
protected int	flags
protected long	id
static int	ILO
static int	INTERNAL
protected java.lang.String	name
static int	NOT_SUPPORTED
protected int	origin
protected DataCollectionConfiguration	owner
protected java.lang.String	perfTabSettings
protected int	pollingInterval
protected long	proxyNode
static int	PUSH
protected long	resourceId
protected int	retentionTime
protected java.util.ArrayList<java.lang.String>	schedules
static int	SNMP
protected int	snmpPort
protected int	status
protected java.lang.String	systemTag
protected long	templateId
protected java.lang.String	transformationScript
protected java.lang.Object	userData
static int	WINPERF

Constructor Summary

Constructors

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

Method Summary

Methods

Modifier and Type	Method and Description
void	fillMessage(NXCPMessage msg) Fill NXCP message with item's data.
java.lang.String	getDescription()
int	getFlags()
long	getId()
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.lang.String	getTransformationScript()
java.lang.Object	getUserData()
boolean	isAggregateOnCluster()
boolean	isTransformAggregated()
boolean	isUseAdvancedSchedule()
void	setAggregateOnCluster(boolean enable)
void	setDescription(java.lang.String description)
void	setFlags(int flags)
void	setName(java.lang.String name)
void	setOrigin(int origin)
void	setPerfTabSettings(java.lang.String perfTabSettings)
void	setPollingInterval(int pollingInterval)
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	setTransformAggregated(boolean enable)
void	setTransformationScript(java.lang.String transformationScript)
void	setUseAdvancedSchedule(boolean useAdvancedSchedule)
void	setUserData(java.lang.Object userData)

Methods inherited from class java.lang.Object

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

Field Detail

DCO_TYPE_GENERIC

public static final int DCO_TYPE_GENERIC

See Also:

Constant Field Values

DCO_TYPE_ITEM

public static final int DCO_TYPE_ITEM

See Also:

Constant Field Values

DCO_TYPE_TABLE

public static final int DCO_TYPE_TABLE

See Also:

Constant Field Values

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

WINPERF

public static final int WINPERF

See Also:

Constant Field Values

ILO

public static final int ILO

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

DCF_ADVANCED_SCHEDULE

public static final int DCF_ADVANCED_SCHEDULE

See Also:

Constant Field Values

DCF_AGGREGATE_ON_CLUSTER

public static final int DCF_AGGREGATE_ON_CLUSTER

See Also:

Constant Field Values

DCF_TRANSFORM_AGGREGATED

public static final int DCF_TRANSFORM_AGGREGATED

See Also:

Constant Field Values

owner

protected DataCollectionConfiguration owner

id

protected long id

templateId

protected long templateId

resourceId

protected long resourceId

proxyNode

protected long proxyNode

pollingInterval

protected int pollingInterval

retentionTime

protected int retentionTime

origin

protected int origin

status

protected int status

flags

protected int flags

transformationScript

protected java.lang.String transformationScript

name

protected java.lang.String name

description

protected java.lang.String description

systemTag

protected java.lang.String systemTag

perfTabSettings

protected java.lang.String perfTabSettings

snmpPort

protected int snmpPort

schedules

protected java.util.ArrayList<java.lang.String> schedules

userData

protected java.lang.Object userData

Constructor Detail

DataCollectionObject

protected DataCollectionObject(DataCollectionConfiguration owner,
                    NXCPMessage msg)

Create data collection object from NXCP message

Parameters:

owner - Owning configuration object

msg - NXCP message

DataCollectionObject

protected DataCollectionObject(DataCollectionConfiguration owner,
                    long id)

Constructor for new data collection objects.

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

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

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

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

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

getFlags

public int getFlags()

Returns:

the flags

setFlags

public void setFlags(int flags)

Parameters:

flags - the flags 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

getUserData

public java.lang.Object getUserData()

Returns:

the userData

setUserData

public void setUserData(java.lang.Object userData)

Parameters:

userData - the userData to set

isAggregateOnCluster

public boolean isAggregateOnCluster()

Returns:

the processAllThresholds

setAggregateOnCluster

public void setAggregateOnCluster(boolean enable)

Parameters:

enable -

isTransformAggregated

public boolean isTransformAggregated()

Returns:

setTransformAggregated

public void setTransformAggregated(boolean enable)

Parameters:

enable -