org.netxms.client

Class Table

java.lang.Object

org.netxms.client.Table

public class Table
extends Object

Generic class for holding data in tabular format. Table has named columns. All data stored as strings.

Constructor Summary

Constructors

Constructor and Description
Table() Create empty table
Table(org.netxms.base.NXCPMessage msg) Create table from data in NXCP message

Method Summary

Methods

Modifier and Type	Method and Description
void	addAll(Table src) Append all records from given table to this table.
void	addDataFromMessage(org.netxms.base.NXCPMessage msg) Add data from additional messages
void	addRow() Add new row
void	fillMessage(org.netxms.base.NXCPMessage msg) Fill NXCP message with table's data
TableRow[]	getAllRows() Get all rows.
TableCell	getCell(int row, int column)
String	getCellValue(int row, int column) Get cell value at given row and column
int	getColumnCount() Get number of columns in table
int[]	getColumnDataTypes() Get display names of all columns
TableColumnDefinition	getColumnDefinition(int column) Get column definition
String	getColumnDisplayName(int column) Get column display name
String[]	getColumnDisplayNames() Get display names of all columns
int	getColumnFormat(int column) Deprecated.
int	getColumnIndex(String name) Get column index by name
String	getColumnName(int column) Get column name
TableColumnDefinition[]	getColumns() Get names of all columns
TableRow	getRow(int row) Get row.
int	getRowCount() Get number of rows in table
int	getSource()
String	getTitle()
boolean	isExtendedFormat()
void	setCell(int row, int col, String value) Set cell value
void	setExtendedFormat(boolean extendedFormat)
void	setSource(int source)
void	setTitle(String title)
String	toString()

Methods inherited from class java.lang.Object

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

Constructor Detail

Table

public Table()

Create empty table

Table

public Table(org.netxms.base.NXCPMessage msg)

Create table from data in NXCP message

Parameters:

msg - NXCP message

Method Detail

addDataFromMessage

public void addDataFromMessage(org.netxms.base.NXCPMessage msg)

Add data from additional messages

Parameters:

msg -

fillMessage

public void fillMessage(org.netxms.base.NXCPMessage msg)

Fill NXCP message with table's data

Parameters:

msg - NXCP message

getColumnCount

public int getColumnCount()

Get number of columns in table

Returns:

Number of columns

getRowCount

public int getRowCount()

Get number of rows in table

Returns:

Number of rows

getColumnDefinition

public TableColumnDefinition getColumnDefinition(int column)
                                          throws IndexOutOfBoundsException

Get column definition

Parameters:

column - Column index (zero-based)

Returns:

Column name

Throws:

IndexOutOfBoundsException - if column index is out of range (column < 0 || column >= getColumnCount())

getColumnName

public String getColumnName(int column)
                     throws IndexOutOfBoundsException

Get column name

Parameters:

column - Column index (zero-based)

Returns:

Column name

Throws:

IndexOutOfBoundsException - if column index is out of range (column < 0 || column >= getColumnCount())

getColumnDisplayName

public String getColumnDisplayName(int column)
                            throws IndexOutOfBoundsException

Get column display name

Parameters:

column - Column index (zero-based)

Returns:

Column name

Throws:

IndexOutOfBoundsException - if column index is out of range (column < 0 || column >= getColumnCount())

getColumnFormat

@Deprecated
public int getColumnFormat(int column)
                    throws IndexOutOfBoundsException

Deprecated.

Get column format

Parameters:

column - Column index (zero-based)

Returns:

Column format

Throws:

IndexOutOfBoundsException - if column index is out of range (column < 0 || column >= getColumnCount())

getColumnIndex

public int getColumnIndex(String name)

Get column index by name

Parameters:

name - Column name

Returns:

0-based column index or -1 if column with given name does not exist

getColumns

public TableColumnDefinition[] getColumns()

Get names of all columns

Returns:

array of column names

getCellValue

public String getCellValue(int row,
                  int column)
                    throws IndexOutOfBoundsException

Get cell value at given row and column

Parameters:

row - Row index (zero-based)

column - Column index (zero-based)

Returns:

Data from given cell

Throws:

IndexOutOfBoundsException - if column index is out of range (column < 0 || column >= getColumnCount()) or row index is out of range (row < 0 || row >= getRowCount())

getCell

public TableCell getCell(int row,
                int column)
                  throws IndexOutOfBoundsException

Parameters:

row -

column -

Returns:

Throws:

IndexOutOfBoundsException

getRow

public TableRow getRow(int row)
                throws IndexOutOfBoundsException

Get row.

Parameters:

row - Row index (zero-based)

Returns:

table row

Throws:

IndexOutOfBoundsException - if row index is out of range (row < 0 || row >= getRowCount())

getAllRows

public TableRow[] getAllRows()

Get all rows.

Returns:

Array of all rows in a table

getTitle

public String getTitle()

Returns:

the title

setTitle

public void setTitle(String title)

Parameters:

title - the title to set

toString

public String toString()

Overrides:

toString in class Object

addAll

public void addAll(Table src)

Append all records from given table to this table. Source table must have same column set.

Parameters:

src - source table

addRow

public void addRow()

Add new row

setCell

public void setCell(int row,
           int col,
           String value)

Set cell value

Parameters:

row -

col -

value -

getSource

public int getSource()

Returns:

the source

setSource

public void setSource(int source)

Parameters:

source - the source to set

getColumnDisplayNames

public String[] getColumnDisplayNames()

Get display names of all columns

Returns:

getColumnDataTypes

public int[] getColumnDataTypes()

Get display names of all columns

Returns:

isExtendedFormat

public boolean isExtendedFormat()

Returns:

the extendedFormat

setExtendedFormat

public void setExtendedFormat(boolean extendedFormat)

Parameters:

extendedFormat - the extendedFormat to set