DataTable Leave feedback
On this page
Inheritance: java.lang.Object
All Implemented Interfaces: com.groupdocs.assembly.system.data.DataTableEventListener
public class DataTable implements DataTableEventListener
Represents one table of in-memory data.
| Constructor | Description |
|---|---|
| DataTable() | Initializes a new instance of the DataTable class with no arguments. |
| DataTable(String tableName) | Initializes a new instance of the DataTable class with the specified table name. |
| DataTable(ResultSet resultSet) | Creates an object by wrapping the specified ResultSet. |
| DataTable(ResultSet resultSet, String tableName) | Creates an object by wrapping the specified ResultSet. |
| Method | Description |
|---|---|
| close() | This method is not used in real life. |
| getTableName() | Gets the name of the DataTable. |
| setTableName(String tableName) | Sets the name of the DataTable. |
| getColumnsCount() | |
| getColumnName(int index) | Analog for .Net DataTable.Columns[i].ColumnName |
| getResultSet() | Returns the underlying Java ResultSet object. |
| getDataSet() | |
| getChildRelations() | Gets the collection of child relations for this DataTable. |
| getParentRelations() | Gets the collection of parent relations for this DataTable. |
| getRows() | Gets the collection of rows that belong to this table. |
| getColumns() | Gets the collection of columns that belong to this table. |
| newRow() | Creates a new DataRow with the same schema as the table. |
| getConstraints() | Gets the collection of constraints maintained by this table. |
| getPrimaryKey() | Gets an array of columns that function as primary keys for the data table. |
| setPrimaryKey(DataColumn[] value) | Sets an array of columns that function as primary keys for the data table. |
| getNamespace() | Gets the namespace for the XML representation of the data stored in the DataTable. |
| setNamespace(String namespace) | Sets the namespace for the XML representation of the data stored in the DataTable. |
| getEnforceConstraints() | |
| setEnforceConstraints(boolean enforceConstraints) | |
| refresh() | Reloads all the data from ResultSet if it is present. |
| acceptChanges() | |
| addEventListener(DataTableEventListener listener) | |
| removeEventListener(DataTableReaderListener listener) | |
| clearEventListneers() | |
| onDataRowChanged(DataRow row) | |
| onDataRowInserted(DataRow row) | |
| onDataRowDeleted(DataRow row) | |
| onDataColumnInserted(DataColumn column) | |
| onDataColumnDeleted(DataColumn column) |
public DataTable()
Initializes a new instance of the DataTable class with no arguments.
public DataTable(String tableName)
Initializes a new instance of the DataTable class with the specified table name.
Parameters:
| Parameter | Type | Description |
|---|---|---|
| tableName | java.lang.String | name of the table |
public DataTable(ResultSet resultSet)
Creates an object by wrapping the specified ResultSet. Attempts to retrieve the table name from the metadata of the first column of the ResultSet.
Parameters:
| Parameter | Type | Description |
|---|---|---|
| resultSet | java.sql.ResultSet | data set |
public DataTable(ResultSet resultSet, String tableName)
Creates an object by wrapping the specified ResultSet.
Parameters:
| Parameter | Type | Description |
|---|---|---|
| resultSet | java.sql.ResultSet | data set |
| tableName | java.lang.String | name of the table |
public void close()
This method is not used in real life.
public String getTableName()
Gets the name of the DataTable.
Returns: java.lang.String - the name of the DataTable.
public void setTableName(String tableName)
Sets the name of the DataTable.
Parameters:
| Parameter | Type | Description |
|---|---|---|
| tableName | java.lang.String | name of the table |
public int getColumnsCount()
Returns: int - columns count
public String getColumnName(int index)
Analog for .Net DataTable.Columns[i].ColumnName
Parameters:
| Parameter | Type | Description |
|---|---|---|
| index | int | - column’s index |
Returns: java.lang.String - column’s name by its index.
public ResultSet getResultSet()
Returns the underlying Java ResultSet object. Ideally we would like to work with DataTable in .Net manner. But some users and even some ours sample code are using this property.
Returns: java.sql.ResultSet - the underlying ResultSet
public DataSet getDataSet()
Returns: DataSet - the DataSet to which this table belongs.
public DataRelationCollection getChildRelations()
Gets the collection of child relations for this DataTable.
Returns: DataRelationCollection - A DataRelationCollection that contains the child relations for the table. An empty collection is returned if no DataRelation objects exist.
public DataRelationCollection getParentRelations()
Gets the collection of parent relations for this DataTable.
Returns: DataRelationCollection - A DataRelationCollection that contains the parent relations for the table. An empty collection is returned if no DataRelation objects exist.
public DataRowCollection getRows()
Gets the collection of rows that belong to this table.
Returns: DataRowCollection - A DataRowCollection that contains DataRow objects; otherwise a null value if no DataRow objects exist.
public DataColumnCollection getColumns()
Gets the collection of columns that belong to this table.
Returns: DataColumnCollection - A DataColumnCollection that contains the collection of DataColumn objects for the table. An empty collection is returned if no DataColumn objects exist.
public DataRow newRow()
Creates a new DataRow with the same schema as the table.
Returns: DataRow - A DataRow with the same schema as the DataTable.
public ConstraintCollection getConstraints()
Gets the collection of constraints maintained by this table.
Returns: ConstraintCollection - A ConstraintCollection that contains the collection of Constraint objects for the table. An empty collection is returned if no Constraint objects exist.
public DataColumn[] getPrimaryKey()
Gets an array of columns that function as primary keys for the data table.
Returns: com.groupdocs.assembly.system.data.DataColumn[] - An array of DataColumn objects.
public void setPrimaryKey(DataColumn[] value)
Sets an array of columns that function as primary keys for the data table.
Parameters:
| Parameter | Type | Description |
|---|---|---|
| value | DataColumn[] | An array of DataColumn objects. |
public String getNamespace()
Gets the namespace for the XML representation of the data stored in the DataTable.
Returns: java.lang.String - The namespace of the DataTable.
public void setNamespace(String namespace)
Sets the namespace for the XML representation of the data stored in the DataTable.
Parameters:
| Parameter | Type | Description |
|---|---|---|
| namespace | java.lang.String | The namespace of the DataTable. |
public boolean getEnforceConstraints()
Returns: boolean - flag which indicates whether check constraint violation or not
public void setEnforceConstraints(boolean enforceConstraints)
Parameters:
| Parameter | Type | Description |
|---|---|---|
| enforceConstraints | boolean | is the flag which indicates whether check constraint violation or not |
public void refresh()
Reloads all the data from ResultSet if it is present.
public void acceptChanges()
public synchronized void addEventListener(DataTableEventListener listener)
Parameters:
| Parameter | Type | Description |
|---|---|---|
| listener | DataTableEventListener |
public void removeEventListener(DataTableReaderListener listener)
Parameters:
| Parameter | Type | Description |
|---|---|---|
| listener | com.groupdocs.assembly.system.data.DataTableReaderListener |
public synchronized void clearEventListneers()
public void onDataRowChanged(DataRow row)
Parameters:
| Parameter | Type | Description |
|---|---|---|
| row | DataRow |
public void onDataRowInserted(DataRow row)
Parameters:
| Parameter | Type | Description |
|---|---|---|
| row | DataRow |
public void onDataRowDeleted(DataRow row)
Parameters:
| Parameter | Type | Description |
|---|---|---|
| row | DataRow |
public void onDataColumnInserted(DataColumn column)
Parameters:
| Parameter | Type | Description |
|---|---|---|
| column | DataColumn |
public void onDataColumnDeleted(DataColumn column)
Parameters:
| Parameter | Type | Description |
|---|---|---|
| column | DataColumn |
Was this page helpful?
Any additional feedback you'd like to share with us?
Please tell us how we can improve this page.
Thank you for your feedback!
We value your opinion. Your feedback will help us improve our documentation.
