public interface GXITable extends Serializable
General table entity.
The external table interface.
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.
|
String getName()
GXITableColumnCollection getColumns()
void addColumn(GXITableColumn column)
column
- the column to add.void addColumn(String columnName)
columnName
- name of the column to create and add.void addColumns(String[] columnNames)
columnNames
- names of the column to create and add.void removeColumn(int columnIndex)
columnIndex
- column index to remove, should range between 0 to columnCount - 1.void removeColumn(String columnName)
columnName
- column name to remove.GXITableRowCollection getRows()
GXITableRow getNewRow()
GXITableColumn[] getPrimaryKey()
void setPrimaryKey(GXITableColumn[] primaryKey)
primaryKey
- the columns that compose the primary key.getPrimaryKey()
void setPrimaryKey(GXITableColumn primaryKey)
primaryKey
- the table column to serve as the primary key.getPrimaryKey()
void createTable(GXIScreenCollection screenCollection, GXVariables variables) throws GXColumnNotFoundException
screenCollection
- a collection of screen(s).variables
- path variables.GXColumnNotFoundException
- when the field or variable associated to the column
is not found in the input.void createTable(GXIScreenCollection screenCollection) throws GXColumnNotFoundException
void createTable(GXIScreen screen) throws GXColumnNotFoundException
void sort(String[] columnNames, boolean[] isAscending)
columnNames
- sorting columns.isAscending
- whether they should be sorted in ascending or descending order.
Note: the sort is case-sensitive.void sort(String columnName, boolean isAscending)
columnName
- sorting column.isAscending
- whether they should be sorted in ascending or descending order.
Note: the sort is case-sensitive.void sort(int[] columnIndices, boolean[] isAscending)
columnIndices
- sorting columns.isAscending
- whether they should be sorted in ascending or descending order.
Note: the sort is case-sensitive.void sort(int columnIndex, boolean isAscending)
columnIndex
- sorting column.isAscending
- whether they should be sorted in ascending or descending order.
Note: the sort is case-sensitive.Copyright 2015 Software AG. All rights reserved. Use is subject to license terms.