com.sabratec.applinx.baseobject.table

Interface GXITable

All Superinterfaces:

Serializable

All Known Implementing Classes:

GXAbstractTable, GXDefaultTable, GXMasterTable, GXMultipleRecordsTable, GXPartialRowsTable

public interface GXITable
extends Serializable

General table entity.

The external table interface.

Method Summary

Modifier and Type	Method and Description
void	addColumn(GXITableColumn column) Adds a column at the end of the table.
void	addColumn(String columnName) Creates a new table column of the specified name and adds it at the end of the table.
void	addColumns(String[] columnNames) Creates new table columns of the specified names and adds them at the end of the table, according to their order in the names array.
void	createTable(GXIScreen screen)
void	createTable(GXIScreenCollection screenCollection)
void	createTable(GXIScreenCollection screenCollection, GXVariables variables) Creates a table based on Base Object screens and variables and on the table's columns schema.
GXITableColumnCollection	getColumns()
String	getName()
GXITableRow	getNewRow() Used to programmatically add a new row to the table.
GXITableColumn[]	getPrimaryKey() The table's primary key is based on one or more columns.
GXITableRowCollection	getRows()
void	removeColumn(int columnIndex) Removes the column at the specified index.
void	removeColumn(String columnName) Removes the column of the specified name.
void	setPrimaryKey(GXITableColumn primaryKey) Sets one table column as the primary key.
void	setPrimaryKey(GXITableColumn[] primaryKey) Sets the columns that compose the table's primary key.
void	sort(int[] columnIndices, boolean[] isAscending) Sorts table rows according to specified columns indices.
void	sort(int columnIndex, boolean isAscending) Sorts table rows according to specified column index.
void	sort(String[] columnNames, boolean[] isAscending) Sorts table rows according to specified column names.
void	sort(String columnName, boolean isAscending) Sorts table rows according to specified column name.

Method Detail

getName

String getName()

Returns:

table's name, defined in the table entity definition.

getColumns

GXITableColumnCollection getColumns()

Returns:

table's defined columns.

addColumn

void addColumn(GXITableColumn column)

Adds a column at the end of the table.

Parameters:

column - the column to add.

addColumn

void addColumn(String columnName)

Creates a new table column of the specified name and adds it at the end of the table.

Parameters:

columnName - name of the column to create and add.

addColumns

void addColumns(String[] columnNames)

Creates new table columns of the specified names and adds them at the end of the table, according to their order in the names array.

Parameters:

columnNames - names of the column to create and add.

removeColumn

void removeColumn(int columnIndex)

Removes the column at the specified index.

Parameters:

columnIndex - column index to remove, should range between 0 to columnCount - 1.

removeColumn

void removeColumn(String columnName)

Removes the column of the specified name.

Parameters:

columnName - column name to remove.

getRows

GXITableRowCollection getRows()

Returns:

table's data rows.

getNewRow

GXITableRow getNewRow()

Used to programmatically add a new row to the table. Done by getting a new row, filling in its cells and then adding it to the table.

Returns:

a new empty row, containing the table's defined columns.

getPrimaryKey

GXITableColumn[] getPrimaryKey()

The table's primary key is based on one or more columns. The key should yield a unique record. If two records have the same key, one is chosen arbitrarily when searching a row according to the primary key. If no primary key column is specified, the default key is the screen index + row index (in the host screen).

Returns:

table's columns that compose the primary key definition.

setPrimaryKey

void setPrimaryKey(GXITableColumn[] primaryKey)

Sets the columns that compose the table's primary key.

Parameters:

primaryKey - the columns that compose the primary key.

See Also:

getPrimaryKey()

setPrimaryKey

void setPrimaryKey(GXITableColumn primaryKey)

Sets one table column as the primary key.

Parameters:

primaryKey - the table column to serve as the primary key.

See Also:

getPrimaryKey()

createTable

void createTable(GXIScreenCollection screenCollection,
                 GXVariables variables)
          throws GXColumnNotFoundException

Creates a table based on Base Object screens and variables and on the table's columns schema.

Parameters:

screenCollection - a collection of screen(s).

variables - path variables.

Throws:

GXColumnNotFoundException - when the field or variable associated to the column is not found in the input.

createTable

void createTable(GXIScreenCollection screenCollection)
          throws GXColumnNotFoundException

Throws:

GXColumnNotFoundException

See Also:

createTable(GXIScreenCollection, GXVariables)

createTable

void createTable(GXIScreen screen)
          throws GXColumnNotFoundException

Throws:

GXColumnNotFoundException

See Also:

createTable(GXIScreenCollection, GXVariables)

sort

void sort(String[] columnNames,
          boolean[] isAscending)

Sorts table rows according to specified column names. Sort priority is determined by the order of the columns in the names array.

Parameters:

columnNames - sorting columns.

isAscending - whether they should be sorted in ascending or descending order. Note: the sort is case-sensitive.

sort

void sort(String columnName,
          boolean isAscending)

Sorts table rows according to specified column name.

Parameters:

columnName - sorting column.

isAscending - whether they should be sorted in ascending or descending order. Note: the sort is case-sensitive.

sort

void sort(int[] columnIndices,
          boolean[] isAscending)

Sorts table rows according to specified columns indices. Sort priority is determined by the order of columns in the names array.

Parameters:

columnIndices - sorting columns.

isAscending - whether they should be sorted in ascending or descending order. Note: the sort is case-sensitive.

sort

void sort(int columnIndex,
          boolean isAscending)

Sorts table rows according to specified column index.

Parameters:

columnIndex - sorting column.

isAscending - whether they should be sorted in ascending or descending order. Note: the sort is case-sensitive.