com.sabratec.applinx.baseobject.table

Class GXAbstractTable

java.lang.Object

com.sabratec.applinx.baseobject.table.GXAbstractTable

All Implemented Interfaces:

GXITable, Externalizable, Serializable

Direct Known Subclasses:

GXDefaultTable, GXMasterTable, GXMultipleRecordsTable, GXPartialRowsTable

public abstract class GXAbstractTable
extends Object
implements GXITable, Externalizable

See Also:

Serialized Form

Constructor Summary

Constructors

Constructor and Description
GXAbstractTable()
GXAbstractTable(String name)
GXAbstractTable(String name, GXIScreen screen) Creates a new table with all the multiple application fields in the screen as the table's columns.
GXAbstractTable(String name, GXIScreenCollection screens) Creates a new table with all the multiple application fields in all the screens in the screen collection as the table's columns.
GXAbstractTable(String name, String[] columnsNames)

Method Summary

Modifier and Type	Method and Description
void	addColumn(GXITableColumn column) Adds a column at the end of the table.
void	addColumn(String column) Creates a new table column of the specified name and adds it at the end of the table.
void	addColumns(String[] columns) 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, GXVariables variables) Creates a table based on Base Object screens and variables and on the table's columns schema.
boolean	equals(Object obj)
GXITableColumnCollection	getColumns()
GXRectangle	getCornersCoordinates()
GXRectangle	getHeaderCoordinates()
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	readExternal(ObjectInput in)
void	removeColumn(int columnIndex) Removes the column at the specified index.
void	removeColumn(String columnName) Removes the column of the specified name.
void	setCornersCoordinates(GXRectangle corners)
void	setHeaderCoordinates(GXRectangle header)
void	setName(String 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	toString()
void	writeExternal(ObjectOutput out)

Methods inherited from class java.lang.Object

getClass, hashCode, notify, notifyAll, wait, wait, wait

Methods inherited from interface com.sabratec.applinx.baseobject.table.GXITable

createTable

Constructor Detail

GXAbstractTable

public GXAbstractTable(String name)

GXAbstractTable

public GXAbstractTable()

GXAbstractTable

public GXAbstractTable(String name,
                       String[] columnsNames)

GXAbstractTable

public GXAbstractTable(String name,
                       GXIScreenCollection screens)

Creates a new table with all the multiple application fields in all the screens in the screen collection as the table's columns.

GXAbstractTable

public GXAbstractTable(String name,
                       GXIScreen screen)

Creates a new table with all the multiple application fields in the screen as the table's columns.

Method Detail

createTable

public void createTable(GXIScreen screen)
                 throws GXColumnNotFoundException

Specified by:

createTable in interface GXITable

Throws:

GXColumnNotFoundException

See Also:

GXITable.createTable(GXIScreenCollection, GXVariables)

createTable

public void createTable(GXIScreenCollection screenCollection,
                        GXVariables variables)
                 throws GXColumnNotFoundException

Description copied from interface: GXITable

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

Specified by:

createTable in interface GXITable

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.

removeColumn

public void removeColumn(int columnIndex)

Description copied from interface: GXITable

Removes the column at the specified index.

Specified by:

removeColumn in interface GXITable

Parameters:

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

removeColumn

public void removeColumn(String columnName)

Description copied from interface: GXITable

Removes the column of the specified name.

Specified by:

removeColumn in interface GXITable

Parameters:

columnName - column name to remove.

sort

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

Description copied from interface: GXITable

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

Specified by:

sort in interface GXITable

Parameters:

columnNames - sorting columns.

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

sort

public void sort(String columnName,
                 boolean isAscending)

Description copied from interface: GXITable

Sorts table rows according to specified column name.

Specified by:

sort in interface GXITable

Parameters:

columnName - sorting column.

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

sort

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

Description copied from interface: GXITable

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

Specified by:

sort in interface GXITable

Parameters:

columnIndices - sorting columns.

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

sort

public void sort(int columnIndex,
                 boolean isAscending)

Description copied from interface: GXITable

Sorts table rows according to specified column index.

Specified by:

sort in interface GXITable

Parameters:

columnIndex - sorting column.

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

getName

public String getName()

Specified by:

getName in interface GXITable

Returns:

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

setName

public void setName(String name)

getColumns

public GXITableColumnCollection getColumns()

Specified by:

getColumns in interface GXITable

Returns:

table's defined columns.

addColumn

public void addColumn(GXITableColumn column)

Description copied from interface: GXITable

Adds a column at the end of the table.

Specified by:

addColumn in interface GXITable

Parameters:

column - the column to add.

addColumn

public void addColumn(String column)

Description copied from interface: GXITable

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

Specified by:

addColumn in interface GXITable

Parameters:

column - name of the column to create and add.

addColumns

public void addColumns(String[] columns)

Description copied from interface: GXITable

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.

Specified by:

addColumns in interface GXITable

Parameters:

columns - names of the column to create and add.

getRows

public GXITableRowCollection getRows()

Specified by:

getRows in interface GXITable

Returns:

table's data rows.

getNewRow

public GXITableRow getNewRow()

Description copied from interface: GXITable

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.

Specified by:

getNewRow in interface GXITable

Returns:

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

getPrimaryKey

public GXITableColumn[] getPrimaryKey()

Description copied from interface: GXITable

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).

Specified by:

getPrimaryKey in interface GXITable

Returns:

table's columns that compose the primary key definition.

setPrimaryKey

public void setPrimaryKey(GXITableColumn[] primaryKey)

Description copied from interface: GXITable

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

Specified by:

setPrimaryKey in interface GXITable

Parameters:

primaryKey - the columns that compose the primary key.

See Also:

GXITable.getPrimaryKey()

setPrimaryKey

public void setPrimaryKey(GXITableColumn primaryKey)

Description copied from interface: GXITable

Sets one table column as the primary key.

Specified by:

setPrimaryKey in interface GXITable

Parameters:

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

See Also:

GXITable.getPrimaryKey()

setCornersCoordinates

public void setCornersCoordinates(GXRectangle corners)

setHeaderCoordinates

public void setHeaderCoordinates(GXRectangle header)

getCornersCoordinates

public GXRectangle getCornersCoordinates()

getHeaderCoordinates

public GXRectangle getHeaderCoordinates()

equals

public boolean equals(Object obj)

Overrides:

equals in class Object

writeExternal

public void writeExternal(ObjectOutput out)
                   throws IOException

Specified by:

writeExternal in interface Externalizable

Throws:

IOException

readExternal

public void readExternal(ObjectInput in)
                  throws IOException,
                         ClassNotFoundException

Specified by:

readExternal in interface Externalizable

Throws:

IOException

ClassNotFoundException

toString

public String toString()

Overrides:

toString in class Object