Package org.netxms.client.datacollection

Class ColumnDefinition

java.lang.Object

org.netxms.client.datacollection.ColumnDefinition

public class ColumnDefinition
extends Object

Column definition for data collection table

Field Summary

Fields

Modifier and Type	Field	Description
static int	TCF_AGGREGATE_FUNCTION_MASK
static int	TCF_DATA_TYPE_MASK
static int	TCF_INSTANCE_COLUMN
static int	TCF_INSTANCE_LABEL_COLUMN
static int	TCF_SNMP_HEX_STRING

Constructor Summary

Constructors

Modifier	Constructor	Description
	ColumnDefinition(String name, String displayName)	Create new column definition.
protected	ColumnDefinition(org.netxms.base.NXCPMessage msg, long baseId)	Create column definition from NXCP message
	ColumnDefinition(ColumnDefinition src)	Copy constructor

Method Summary

Modifier and Type	Method	Description
void	fillMessage(org.netxms.base.NXCPMessage msg, long baseId)	Fill NXCP message with column's data
int	getAggregationFunction()
DataType	getDataType()
String	getDisplayName()
int	getFlags()
String	getName()
SnmpObjectId	getSnmpObjectId()
boolean	isConvertSnmpStringToHex()	Get SNMP string to hexadecimal string conversion flag
boolean	isInstanceColumn()	Get "instance column" flag
boolean	isInstanceLabelColumn()	Get "instance label column" flag
void	setAggregationFunction(int function)
void	setConvertSnmpStringToHex(boolean convert)	Set SNMP string to hexadecimal string conversion flag
void	setDataType(DataType dataType)
void	setDisplayName(String displayName)
void	setFlags(int flags)
void	setInstanceColumn(boolean isInstance)	Set "instance column" flag
void	setInstanceLabelColumn(boolean isInstanceLabel)	Set "instance label column" flag
void	setName(String name)	Set column name
void	setSnmpObjectId(SnmpObjectId snmpObjectId)

Methods inherited from class java.lang.Object

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

Field Detail

TCF_DATA_TYPE_MASK

public static final int TCF_DATA_TYPE_MASK

See Also:

Constant Field Values

TCF_AGGREGATE_FUNCTION_MASK

public static final int TCF_AGGREGATE_FUNCTION_MASK

See Also:

Constant Field Values

TCF_INSTANCE_COLUMN

public static final int TCF_INSTANCE_COLUMN

See Also:

Constant Field Values

TCF_INSTANCE_LABEL_COLUMN

public static final int TCF_INSTANCE_LABEL_COLUMN

See Also:

Constant Field Values

TCF_SNMP_HEX_STRING

public static final int TCF_SNMP_HEX_STRING

See Also:

Constant Field Values

Constructor Detail

ColumnDefinition

public ColumnDefinition(String name,
                        String displayName)

Create new column definition.

Parameters:

name - column name

displayName - The display name

ColumnDefinition

public ColumnDefinition(ColumnDefinition src)

Copy constructor

Parameters:

src - source object

ColumnDefinition

protected ColumnDefinition(org.netxms.base.NXCPMessage msg,
                           long baseId)

Create column definition from NXCP message

Parameters:

msg - NXCP message

baseId - base variable ID

Method Detail

fillMessage

public void fillMessage(org.netxms.base.NXCPMessage msg,
                        long baseId)

Fill NXCP message with column's data

Parameters:

msg - NXCP message

baseId - base variable ID

getDataType

public DataType getDataType()

Returns:

the dataType

setDataType

public void setDataType(DataType dataType)

Parameters:

dataType - the dataType to set

getAggregationFunction

public int getAggregationFunction()

Returns:

the dataType

setAggregationFunction

public void setAggregationFunction(int function)

Parameters:

function - new aggregation function

getSnmpObjectId

public SnmpObjectId getSnmpObjectId()

Returns:

the snmpObjectId

setSnmpObjectId

public void setSnmpObjectId(SnmpObjectId snmpObjectId)

Parameters:

snmpObjectId - the snmpObjectId to set

getName

public String getName()

Returns:

the name

getDisplayName

public String getDisplayName()

Returns:

the displayName

setDisplayName

public void setDisplayName(String displayName)

Parameters:

displayName - the displayName to set

getFlags

public int getFlags()

Returns:

the flags

setFlags

public void setFlags(int flags)

Parameters:

flags - the flags to set

isInstanceColumn

public boolean isInstanceColumn()

Get "instance column" flag

Returns:

"instance column" flag

setInstanceColumn

public void setInstanceColumn(boolean isInstance)

Set "instance column" flag

Parameters:

isInstance - true to set flag

isInstanceLabelColumn

public boolean isInstanceLabelColumn()

Get "instance label column" flag

Returns:

"instance label column" flag

setInstanceLabelColumn

public void setInstanceLabelColumn(boolean isInstanceLabel)

Set "instance label column" flag

Parameters:

isInstanceLabel - true to set flag

isConvertSnmpStringToHex

public boolean isConvertSnmpStringToHex()

Get SNMP string to hexadecimal string conversion flag

Returns:

SNMP string to hexadecimal string conversion flag

setConvertSnmpStringToHex

public void setConvertSnmpStringToHex(boolean convert)

Set SNMP string to hexadecimal string conversion flag

Parameters:

convert - true to set flag

setName

public void setName(String name)

Set column name

Parameters:

name - new column name