Package org.netxms.client.datacollection

Class DataCollectionTable

java.lang.Object

org.netxms.client.datacollection.DataCollectionObject

org.netxms.client.datacollection.DataCollectionTable

public class DataCollectionTable
extends DataCollectionObject

Tabular data collection object

Field Summary

Fields

Modifier and Type	Field	Description
static final int	DCF_ADD_INSTANCE_OID_COLUMN
static final int	IDM_AGENT_LIST
static final int	IDM_AGENT_TABLE
static final int	IDM_NONE
static final int	IDM_SCRIPT
static final int	IDM_SNMP_WALK_OIDS
static final int	IDM_SNMP_WALK_VALUES

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

accessList, comments, DCF_AGGREGATE_ON_CLUSTER, DCF_AGGREGATE_WITH_ERRORS, DCF_CACHE_MODE_MASK, DCF_HIDE_ON_LAST_VALUES_PAGE, DCF_TRANSFORM_AGGREGATED, DCF_UNSUPPORTED_AS_ERROR, DCO_TYPE_GENERIC, DCO_TYPE_ITEM, DCO_TYPE_TABLE, description, flags, id, IDM_INTERNAL_TABLE, IDM_OTLP, IDM_PUSH, IDM_SMCLP_PROPERTIES, IDM_SMCLP_TARGETS, IDM_WEB_SERVICE, IDM_WINPERF, instanceDiscoveryData, instanceDiscoveryFilter, instanceDiscoveryMethod, instanceName, instanceRetentionTime, name, nodeId, 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, snmpContext, snmpPort, snmpVersion, sourceNode, stateFlags, status, systemTag, templateId, templateItemId, thresholdDisableEndTime, transformationScript, userData, userTag

Constructor Summary

Constructors

Modifier	Constructor	Description
protected	DataCollectionTable()	Default constructor (intended for deserialization)
	DataCollectionTable(long nodeId, long id)	Constructor for new data collection objects.
	DataCollectionTable(DataCollectionConfiguration owner, long id)	Constructor for new data collection objects.
	DataCollectionTable(DataCollectionConfiguration owner, long nodeId, long id)	Constructor for new data collection objects.
	DataCollectionTable(DataCollectionConfiguration owner, NXCPMessage msg)	Create data collection object from NXCP message.
protected	DataCollectionTable(DataCollectionConfiguration owner, DataCollectionTable src)	Object copy constructor

Method Summary

Modifier and Type	Method	Description
void	fillMessage(NXCPMessage msg)	Fill NXCP message with item's data.
List<ColumnDefinition>	getColumns()
String	getInstanceColumn()
List<TableThreshold>	getThresholds()
boolean	isInstanceOidColumnEnabled()	Check if synthetic instance column containing instance part of SNMP OID should be added to collected table.
void	setColumns(List<ColumnDefinition> columns)
void	setInstanceColumn(String instanceColumn)
void	setInstanceOidColumnEnabled(boolean enable)	Enable or disable synthetic instance column containing instance part of SNMP OID.
void	setThresholds(List<TableThreshold> thresholds)

Methods 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, getSnmpContext, getSnmpPort, getSnmpVersion, getSourceNode, getStateFlags, getStatus, getSystemTag, getTemplateId, getTemplateItemId, getThresholdDisableEndTime, getTransformationScript, getUserData, getUserTag, isAggregateOnCluster, isAggregateWithErrors, isHideOnLastValuesView, isNewItem, isTransformAggregated, isUnsupportedAsError, 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, setSnmpContext, setSnmpPort, setSnmpVersion, setSourceNode, setStatus, setSystemTag, setTemplateId, setThresholdDisableEndTime, setTransformAggregated, setTransformationScript, setUnsupportedAsError, setUserData, setUserTag

Methods inherited from class java.lang.Object

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

Field Details

DCF_ADD_INSTANCE_OID_COLUMN

public static final int DCF_ADD_INSTANCE_OID_COLUMN

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

IDM_SCRIPT

public static final int IDM_SCRIPT

See Also:

• Constant Field Values

Constructor Details

DataCollectionTable

public DataCollectionTable(DataCollectionConfiguration owner,
 NXCPMessage msg)

Create data collection object from NXCP message.

Parameters:

owner - The owner object

msg - The NXCPMessage

DataCollectionTable

public DataCollectionTable(DataCollectionConfiguration owner,
 long nodeId,
 long id)

Constructor for new data collection objects.

Parameters:

owner - The owner object

nodeId - Owning node ID

id - The table ID

DataCollectionTable

public DataCollectionTable(DataCollectionConfiguration owner,
 long id)

Constructor for new data collection objects.

Parameters:

owner - The owner object

id - The table ID

DataCollectionTable

public DataCollectionTable(long nodeId,
 long id)

Constructor for new data collection objects.

Parameters:

nodeId - Owning node ID

id - The table ID

DataCollectionTable

protected DataCollectionTable()

Default constructor (intended for deserialization)

DataCollectionTable

protected DataCollectionTable(DataCollectionConfiguration owner,
 DataCollectionTable 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

getInstanceColumn

public String getInstanceColumn()

Returns:

the instanceColumn

setInstanceColumn

public void setInstanceColumn(String instanceColumn)

Parameters:

instanceColumn - the instanceColumn to set

isInstanceOidColumnEnabled

public boolean isInstanceOidColumnEnabled()

Check if synthetic instance column containing instance part of SNMP OID should be added to collected table.

Returns:

true if instance OID column is enabled

setInstanceOidColumnEnabled

public void setInstanceOidColumnEnabled(boolean enable)

Enable or disable synthetic instance column containing instance part of SNMP OID.

Parameters:

enable - true to enable instance OID column

getColumns

public List<ColumnDefinition> getColumns()

Returns:

the columns

setColumns

public void setColumns(List<ColumnDefinition> columns)

Parameters:

columns - the columns to set

getThresholds

public List<TableThreshold> getThresholds()

Returns:

the thresholds

setThresholds

public void setThresholds(List<TableThreshold> thresholds)

Parameters:

thresholds - the thresholds to set