DataTable

Packages

java.lang.Object
- com.groupdocs.assembly.system.data.DataTable

All Implemented Interfaces:

DataTableEventListener
```
public class DataTable
extends java.lang.Object
implements DataTableEventListener
```
Represents one table of in-memory data.

Constructor Summary

Constructors
Constructor and Description
`DataTable()` Initializes a new instance of the `DataTable` class with no arguments.
`DataTable(java.sql.ResultSet resultSet)` Creates an object by wrapping the specified ResultSet.
`DataTable(java.sql.ResultSet resultSet, java.lang.String tableName)` Creates an object by wrapping the specified ResultSet.
`DataTable(java.lang.String tableName)` Initializes a new instance of the `DataTable` class with the specified table name.

Method Summary

All Methods Instance Methods Concrete Methods Deprecated Methods
Modifier and Type	Method and Description
`void`	`acceptChanges()` Commits all the changes made to this table since the last time `acceptChanges()` was called.
`void`	`addEventListener(DataTableEventListener listener)`
`void`	`clearEventListneers()`
`void`	`close()`
`boolean`	`containsColumn(java.lang.String columnName)` Deprecated. Please use `getColumns().contains(String)` method.
`DataRelationCollection`	`getChildRelations()` Gets the collection of child relations for this `DataTable`.
`java.lang.String`	`getColumnName(int index)` Analog for .Net DataTable.Columns[i].ColumnName
`DataColumnCollection`	`getColumns()` Gets the collection of columns that belong to this table.
`int`	`getColumnsCount()`
`ConstraintCollection`	`getConstraints()` Gets the collection of constraints maintained by this table.
`DataSet`	`getDataSet()` Gets the `DataSet` to which this table belongs.
`boolean`	`getEnforceConstraints()`
`java.lang.String`	`getNamespace()` Gets the namespace for the XML representation of the data stored in the `DataTable`.
`DataRelationCollection`	`getParentRelations()` Gets the collection of parent relations for this `DataTable`.
`DataColumn[]`	`getPrimaryKey()` Gets an array of columns that function as primary keys for the data table.
`java.sql.ResultSet`	`getResultSet()` Returns the underlying Java ResultSet object.
`DataRowCollection`	`getRows()` Gets the collection of rows that belong to this table.
`java.lang.String`	`getTableName()` Gets the name of the `DataTable`.
`DataRow`	`newRow()` Creates a new `DataRow` with the same schema as the table.
`void`	`onDataColumnDeleted(DataColumn column)`
`void`	`onDataColumnInserted(DataColumn column)`
`void`	`onDataRowChanged(DataRow row)`
`void`	`onDataRowDeleted(DataRow row)`
`void`	`onDataRowInserted(DataRow row)`
`void`	`refresh()` Reloads all the data from ResultSet if it is present.
`void`	`setEnforceConstraints(boolean enforceConstraints)`
`void`	`setNamespace(java.lang.String value)` Sets the namespace for the XML representation of the data stored in the `DataTable`.
`void`	`setPrimaryKey(DataColumn[] value)` Sets an array of columns that function as primary keys for the data table.
`void`	`setTableName(java.lang.String value)` Sets the name of the `DataTable`.

Methods inherited from class java.lang.Object
clone, equals, finalize, getClass, hashCode, notify, notifyAll, toString, wait, wait, wait

- Constructor Detail
  - DataTable
```
public DataTable()
```
    Initializes a new instance of the DataTable class with no arguments.
  - DataTable
```
public DataTable(java.lang.String tableName)
```
    Initializes a new instance of the DataTable class with the specified table name.
    
    Parameters:
    
    tableName - The name to give the table. If tableName is null or an empty string, a default name is given when added to the DataTableCollection.
  - DataTable
```
public DataTable(java.sql.ResultSet resultSet)
          throws java.sql.SQLException
```
    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:
    
    resultSet - data set
    
    Throws:
    
    java.sql.SQLException - if a database access error occurs or this method is
  - DataTable
```
public DataTable(java.sql.ResultSet resultSet,
                 java.lang.String tableName)
          throws java.sql.SQLException
```
    Creates an object by wrapping the specified ResultSet.
    
    Parameters:
    
    resultSet - data set
    
    tableName - name of the table
    
    Throws:
    
    java.sql.SQLException - if a database access error occurs or this method is
- Method Detail
  - close
```
public void close()
           throws java.lang.Exception
```
    Throws:
    
    java.lang.Exception
  - getTableName
```
public java.lang.String getTableName()
```
    Gets the name of the DataTable.
    
    Returns:
    
    The name of the DataTable.
  - setTableName
```
public void setTableName(java.lang.String value)
```
    Sets the name of the DataTable.
    
    Parameters:
    
    value - The name of the DataTable.
  - containsColumn
```
public boolean containsColumn(java.lang.String columnName)
```
    Deprecated. Please use getColumns().contains(String) method.
    
    Check whether the given column exists or not
    
    Parameters:
    
    columnName - name of the column
    
    Returns:
    
    true is column can be found by the given columnName
  - getColumnsCount
```
public int getColumnsCount()
```
    Returns:
    
    columns count
  - getColumnName
```
public java.lang.String getColumnName(int index)
```
    Analog for .Net DataTable.Columns[i].ColumnName
    
    Parameters:
    
    index - - column's index
    
    Returns:
    
    column's name by its index.
  - getResultSet
```
public java.sql.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:
    
    the underlying ResultSet
  - getDataSet
```
public DataSet getDataSet()
```
    Gets the DataSet to which this table belongs.
    
    Returns:
    
    The DataSet to which this table belongs.
  - getChildRelations
```
public DataRelationCollection getChildRelations()
```
    Gets the collection of child relations for this DataTable.
    
    Returns:
    
    A DataRelationCollection that contains the child relations for the table. An empty collection is returned if no DataRelation objects exist.
  - getParentRelations
```
public DataRelationCollection getParentRelations()
```
    Gets the collection of parent relations for this DataTable.
    
    Returns:
    
    A DataRelationCollection that contains the parent relations for the table. An empty collection is returned if no DataRelation objects exist.
  - getRows
```
public DataRowCollection getRows()
```
    Gets the collection of rows that belong to this table.
    
    Returns:
    
    A DataRowCollection that contains DataRow objects; otherwise a null value if no DataRow objects exist.
  - getColumns
```
public DataColumnCollection getColumns()
```
    Gets the collection of columns that belong to this table.
    
    Returns:
    
    A DataColumnCollection that contains the collection of DataColumn objects for the table. An empty collection is returned if no DataColumn objects exist.
  - newRow
```
public DataRow newRow()
```
    Creates a new DataRow with the same schema as the table.
    
    Returns:
    
    A DataRow with the same schema as the DataTable.
  - getConstraints
```
public ConstraintCollection getConstraints()
```
    Gets the collection of constraints maintained by this table.
    
    Returns:
    
    A ConstraintCollection that contains the collection of Constraint objects for the table. An empty collection is returned if no Constraint objects exist.
  - getPrimaryKey
```
public DataColumn[] getPrimaryKey()
```
    Gets an array of columns that function as primary keys for the data table.
    
    Returns:
    
    An array of DataColumn objects.
  - setPrimaryKey
```
public void setPrimaryKey(DataColumn[] value)
                   throws DataException,
                          InvalidConstraintException
```
    Sets an array of columns that function as primary keys for the data table.
    
    Parameters:
    
    value - An array of DataColumn objects.
    
    Throws:
    
    DataException
    
    InvalidConstraintException
  - getNamespace
```
public java.lang.String getNamespace()
```
    Gets the namespace for the XML representation of the data stored in the DataTable.
    
    Returns:
    
    The namespace of the DataTable.
  - setNamespace
```
public void setNamespace(java.lang.String value)
```
    Sets the namespace for the XML representation of the data stored in the DataTable.
    
    Parameters:
    
    value - The namespace of the DataTable.
  - getEnforceConstraints
```
public boolean getEnforceConstraints()
```
    Returns:
    
    flag which indicates whether check constraint violation or not
  - setEnforceConstraints
```
public void setEnforceConstraints(boolean enforceConstraints)
```
    Parameters:
    
    enforceConstraints - is the flag which indicates whether check constraint violation or not
  - refresh
```
public void refresh()
```
    Reloads all the data from ResultSet if it is present.
  - acceptChanges
```
public void acceptChanges()
                   throws java.sql.SQLException
```
    Commits all the changes made to this table since the last time acceptChanges() was called.
    
    Throws:
    
    java.sql.SQLException
  - addEventListener
```
public void addEventListener(DataTableEventListener listener)
```
  - clearEventListneers
```
public void clearEventListneers()
```
  - onDataRowChanged
```
public void onDataRowChanged(DataRow row)
```
    Specified by:
    
    onDataRowChanged in interface DataTableEventListener
  - onDataRowInserted
```
public void onDataRowInserted(DataRow row)
```
    Specified by:
    
    onDataRowInserted in interface DataTableEventListener
  - onDataRowDeleted
```
public void onDataRowDeleted(DataRow row)
```
    Specified by:
    
    onDataRowDeleted in interface DataTableEventListener
  - onDataColumnInserted
```
public void onDataColumnInserted(DataColumn column)
```
    Specified by:
    
    onDataColumnInserted in interface DataTableEventListener
  - onDataColumnDeleted
```
public void onDataColumnDeleted(DataColumn column)
```
    Specified by:
    
    onDataColumnDeleted in interface DataTableEventListener

Packages

com.groupdocs.assembly.system.data

Interfaces

Classes

Enums

Exceptions

Class DataTable

Constructor Summary

Method Summary

Methods inherited from class java.lang.Object

Constructor Detail

DataTable

DataTable

DataTable

Method Detail

close

getTableName

setTableName

containsColumn

getColumnsCount

getColumnName

getResultSet

getDataSet

getChildRelations

getParentRelations

getRows

getColumns

newRow

getConstraints

getPrimaryKey

setPrimaryKey

getNamespace

setNamespace

getEnforceConstraints

setEnforceConstraints

refresh

acceptChanges

addEventListener

clearEventListneers

onDataRowChanged

onDataRowInserted

onDataRowDeleted

onDataColumnInserted

onDataColumnDeleted