org.assertj.db.type

Class Table

java.lang.Object

org.assertj.db.type.AbstractDbElement<D>

org.assertj.db.type.AbstractDbData<Table>

org.assertj.db.type.Table

All Implemented Interfaces:

DbElement, WithColumnLetterCase, WithLetterCase, WithPrimaryKeyLetterCase, WithTableLetterCase

public class Table
extends AbstractDbData<Table>

A table in the database to read to get the values.

The different information of the table are Source or DataSource, name of the table and optionally the columns to check and to exclude.

Examples of instantiation :

• This Table point to a table called movie in a H2 database in memory like indicated in the Source.

   
   Source source = new Source("jdbc:h2:mem:test", "sa", "");
   Table table = new Table(source, "movie");
   
   

• Below the Table table1 point to a table called song (but only on the columns called number and title).
  And the Table table2 point to a table called musician (but ignore on the column called birthday).
  The Table use a DataSource instead of a Source like above.

   
   DataSource dataSource = ...;
   Table table1 = new Table(dataSource, "song", new String[] { "number", "title" }, null);
   Table table2 = new Table(dataSource, "musician", null, new String[] { "birthday" });
   
   

Author:

Régis Pouiller

Nested Class Summary

Nested Classes

Modifier and Type	Class and Description
static class	Table.Order Indicates an order with the name on which is the order and the type.

Field Summary

Fields inherited from class org.assertj.db.type.AbstractDbElement

myself

Constructor Summary

Constructors

Constructor and Description
Table() Default constructor.
Table(DataSource dataSource, String name) Constructor with a dataSource and the name of the table.
Table(DataSource dataSource, String name, Character startDelimiter, Character endDelimiter) Constructor with a dataSource and the name of the table.
Table(DataSource dataSource, String name, Character startDelimiter, Character endDelimiter, String[] columnsToCheck, String[] columnsToExclude) Constructor with a connection, the name of the table and the columns to check and to exclude.
Table(DataSource dataSource, String name, Character startDelimiter, Character endDelimiter, Table.Order[] columnsToOrder) Constructor with a dataSource and the name of the table.
Table(DataSource dataSource, String name, Character startDelimiter, Character endDelimiter, Table.Order[] columnsToOrder, String[] columnsToCheck, String[] columnsToExclude) Constructor with a connection, the name of the table and the columns to check and to exclude.
Table(DataSource dataSource, String name, String[] columnsToCheck, String[] columnsToExclude) Constructor with a connection, the name of the table and the columns to check and to exclude.
Table(DataSource dataSource, String name, Table.Order[] columnsToOrder) Constructor with a dataSource and the name of the table.
Table(DataSource dataSource, String name, Table.Order[] columnsToOrder, String[] columnsToCheck, String[] columnsToExclude) Constructor with a connection, the name of the table and the columns to check and to exclude.
Table(Source source, String name) Constructor with a Source and the name of the table.
Table(Source source, String name, Character startDelimiter, Character endDelimiter) Constructor with a Source and the name of the table.
Table(Source source, String name, Character startDelimiter, Character endDelimiter, String[] columnsToCheck, String[] columnsToExclude) Constructor with a Source, the name of the table and the columns to check and to exclude.
Table(Source source, String name, Character startDelimiter, Character endDelimiter, Table.Order[] columnsToOrder) Constructor with a Source and the name of the table.
Table(Source source, String name, Character startDelimiter, Character endDelimiter, Table.Order[] columnsToOrder, String[] columnsToCheck, String[] columnsToExclude) Constructor with a Source, the name of the table and the columns to check and to exclude.
Table(Source source, String name, String[] columnsToCheck, String[] columnsToExclude) Constructor with a Source, the name of the table and the columns to check and to exclude.
Table(Source source, String name, Table.Order[] columnsToOrder) Constructor with a Source and the name of the table.
Table(Source source, String name, Table.Order[] columnsToOrder, String[] columnsToCheck, String[] columnsToExclude) Constructor with a Source, the name of the table and the columns to check and to exclude.

Method Summary

Modifier and Type	Method and Description
String[]	getColumnsToCheck() Returns the columns to check (which are present in AbstractDbData.getColumnsNameList()).
String[]	getColumnsToExclude() Returns the columns to exclude (which are not present in AbstractDbData.getColumnsNameList()).
Table.Order[]	getColumnsToOrder() Returns the columns to order (which are used in ORDER BY).
Character	getEndDelimiter() Returns the end delimiter for column name and table name.
String	getName() Return the name of the table.
String	getRequest() Returns the SQL request.
Character	getStartDelimiter() Returns the start delimiter for column name and table name.
protected void	loadImpl(Connection connection) Specific implementation of the loading for a Table.
Table	setColumnsToCheck(String[] columnsToCheck) Sets the columns to check (which are present in AbstractDbData.getColumnsNameList()).
Table	setColumnsToExclude(String[] columnsToExclude) Sets the columns to exclude (which are not present in AbstractDbData.getColumnsNameList()).
Table	setColumnsToOrder(Table.Order[] columnsToOrder) Sets the columns to order (which are used in ORDER BY).
Table	setDataSource(DataSource dataSource) Sets the data source.
Table	setEndDelimiter(Character endDelimiter) Sets the end delimiter for column name and table name.
Table	setName(String name) Sets the name of the table.
Table	setSource(Source source) Sets the source.
Table	setStartDelimiter(Character startDelimiter) Sets the start delimiter for column name and table name.

Methods inherited from class org.assertj.db.type.AbstractDbData

collectRowsFromResultSet, controlIfAllThePksNameExistInTheColumns, getColumn, getColumnsList, getColumnsNameList, getDataType, getPksNameList, getRow, getRowFromPksValues, getRowsList, setColumnsNameList, setPksNameList, sortRows

Methods inherited from class org.assertj.db.type.AbstractDbElement

getCatalog, getColumnLetterCase, getConnection, getDataSource, getPrimaryKeyLetterCase, getSchema, getSource, getTableLetterCase

Methods inherited from class java.lang.Object

clone, equals, finalize, getClass, hashCode, notify, notifyAll, toString, wait, wait, wait

Constructor Detail

Table

public Table()

Default constructor.

Table

public Table(Source source,
             String name)

Constructor with a Source and the name of the table.

Parameters:

source - Source to connect to the database.

name - Name of the table.

Table

public Table(Source source,
             String name,
             String[] columnsToCheck,
             String[] columnsToExclude)

Constructor with a Source, the name of the table and the columns to check and to exclude.

Parameters:

source - Source to connect to the database.

name - Name of the table.

columnsToCheck - Array of the name of the columns to check. If null that means to check all the columns.

columnsToExclude - Array of the name of the columns to exclude. If null that means to exclude no column.

Table

public Table(DataSource dataSource,
             String name)

Constructor with a dataSource and the name of the table.

Parameters:

dataSource - DataSource of the database.

name - Name of the table.

Table

public Table(DataSource dataSource,
             String name,
             String[] columnsToCheck,
             String[] columnsToExclude)

Constructor with a connection, the name of the table and the columns to check and to exclude.

Parameters:

dataSource - DataSource of the database.

name - Name of the table.

columnsToCheck - Array of the name of the columns to check. If null that means to check all the columns.

columnsToExclude - Array of the name of the columns to exclude. If null that means to exclude no column.

Table

public Table(Source source,
             String name,
             Table.Order[] columnsToOrder)

Constructor with a Source and the name of the table.

Parameters:

source - Source to connect to the database.

name - Name of the table.

Since:

1.2.0

Table

public Table(Source source,
             String name,
             Table.Order[] columnsToOrder,
             String[] columnsToCheck,
             String[] columnsToExclude)

Constructor with a Source, the name of the table and the columns to check and to exclude.

Parameters:

source - Source to connect to the database.

name - Name of the table.

columnsToCheck - Array of the name of the columns to check. If null that means to check all the columns.

columnsToExclude - Array of the name of the columns to exclude. If null that means to exclude no column.

Since:

1.2.0

Table

public Table(DataSource dataSource,
             String name,
             Table.Order[] columnsToOrder)

Constructor with a dataSource and the name of the table.

Parameters:

dataSource - DataSource of the database.

name - Name of the table.

Since:

1.2.0

Table

public Table(DataSource dataSource,
             String name,
             Table.Order[] columnsToOrder,
             String[] columnsToCheck,
             String[] columnsToExclude)

Constructor with a connection, the name of the table and the columns to check and to exclude.

Parameters:

dataSource - DataSource of the database.

name - Name of the table.

columnsToCheck - Array of the name of the columns to check. If null that means to check all the columns.

columnsToExclude - Array of the name of the columns to exclude. If null that means to exclude no column.

Since:

1.2.0

Table

public Table(Source source,
             String name,
             Character startDelimiter,
             Character endDelimiter)

Constructor with a Source and the name of the table.

Parameters:

source - Source to connect to the database.

name - Name of the table.

startDelimiter - Start delimiter for column name and table name.

endDelimiter - End delimiter for column name and table name.

Since:

1.2.0

Table

public Table(Source source,
             String name,
             Character startDelimiter,
             Character endDelimiter,
             String[] columnsToCheck,
             String[] columnsToExclude)

Constructor with a Source, the name of the table and the columns to check and to exclude.

Parameters:

source - Source to connect to the database.

name - Name of the table.

startDelimiter - Start delimiter for column name and table name.

endDelimiter - End delimiter for column name and table name.

columnsToCheck - Array of the name of the columns to check. If null that means to check all the columns.

columnsToExclude - Array of the name of the columns to exclude. If null that means to exclude no column.

Since:

1.2.0

Table

public Table(DataSource dataSource,
             String name,
             Character startDelimiter,
             Character endDelimiter)

Constructor with a dataSource and the name of the table.

Parameters:

dataSource - DataSource of the database.

name - Name of the table.

startDelimiter - Start delimiter for column name and table name.

endDelimiter - End delimiter for column name and table name.

Since:

1.2.0

Table

public Table(DataSource dataSource,
             String name,
             Character startDelimiter,
             Character endDelimiter,
             String[] columnsToCheck,
             String[] columnsToExclude)

Constructor with a connection, the name of the table and the columns to check and to exclude.

Parameters:

dataSource - DataSource of the database.

name - Name of the table.

startDelimiter - Start delimiter for column name and table name.

endDelimiter - End delimiter for column name and table name.

columnsToCheck - Array of the name of the columns to check. If null that means to check all the columns.

columnsToExclude - Array of the name of the columns to exclude. If null that means to exclude no column.

Since:

1.2.0

Table

public Table(Source source,
             String name,
             Character startDelimiter,
             Character endDelimiter,
             Table.Order[] columnsToOrder)

Constructor with a Source and the name of the table.

Parameters:

source - Source to connect to the database.

name - Name of the table.

startDelimiter - Start delimiter for column name and table name.

endDelimiter - End delimiter for column name and table name.

Since:

1.2.0

Table

public Table(Source source,
             String name,
             Character startDelimiter,
             Character endDelimiter,
             Table.Order[] columnsToOrder,
             String[] columnsToCheck,
             String[] columnsToExclude)

Constructor with a Source, the name of the table and the columns to check and to exclude.

Parameters:

source - Source to connect to the database.

name - Name of the table.

startDelimiter - Start delimiter for column name and table name.

endDelimiter - End delimiter for column name and table name.

columnsToCheck - Array of the name of the columns to check. If null that means to check all the columns.

columnsToExclude - Array of the name of the columns to exclude. If null that means to exclude no column.

Since:

1.2.0

Table

public Table(DataSource dataSource,
             String name,
             Character startDelimiter,
             Character endDelimiter,
             Table.Order[] columnsToOrder)

Constructor with a dataSource and the name of the table.

Parameters:

dataSource - DataSource of the database.

name - Name of the table.

startDelimiter - Start delimiter for column name and table name.

endDelimiter - End delimiter for column name and table name.

Since:

1.2.0

Table

public Table(DataSource dataSource,
             String name,
             Character startDelimiter,
             Character endDelimiter,
             Table.Order[] columnsToOrder,
             String[] columnsToCheck,
             String[] columnsToExclude)

Constructor with a connection, the name of the table and the columns to check and to exclude.

Parameters:

dataSource - DataSource of the database.

name - Name of the table.

startDelimiter - Start delimiter for column name and table name.

endDelimiter - End delimiter for column name and table name.

columnsToCheck - Array of the name of the columns to check. If null that means to check all the columns.

columnsToExclude - Array of the name of the columns to exclude. If null that means to exclude no column.

Since:

1.2.0

Method Detail

getName

public String getName()

Return the name of the table.

Returns:

the name of the table.

See Also:

setName(String)

setName

public Table setName(String name)

Sets the name of the table.

Parameters:

name - The name of the table.

Returns:

The actual instance.

See Also:

getName()

setDataSource

public Table setDataSource(DataSource dataSource)

Sets the data source.

Overrides:

setDataSource in class AbstractDbElement<Table>

Parameters:

dataSource - The DataSource (must be not null).

Returns:

The actual instance.

See Also:

AbstractDbElement.getDataSource()

setSource

public Table setSource(Source source)

Sets the source.

Overrides:

setSource in class AbstractDbElement<Table>

Parameters:

source - Source to connect to the database (must be not null).

Returns:

The actual instance.

See Also:

AbstractDbElement.getSource()

getColumnsToCheck

public String[] getColumnsToCheck()

Returns the columns to check (which are present in AbstractDbData.getColumnsNameList()).

Returns:

Array of the name of the columns to check. If null that means to check all the columns.

See Also:

setColumnsToCheck(String[])

setColumnsToCheck

public Table setColumnsToCheck(String[] columnsToCheck)

Sets the columns to check (which are present in AbstractDbData.getColumnsNameList()).

Parameters:

columnsToCheck - Array of the name of the columns to check. If null that means to check all the columns.

Returns:

The actual instance.

Throws:

NullPointerException - If one of the name in columnsToCheck is null.

See Also:

getColumnsToCheck()

getColumnsToExclude

public String[] getColumnsToExclude()

Returns the columns to exclude (which are not present in AbstractDbData.getColumnsNameList()).

Returns:

The columns.

See Also:

setColumnsToExclude(String[])

setColumnsToExclude

public Table setColumnsToExclude(String[] columnsToExclude)

Sets the columns to exclude (which are not present in AbstractDbData.getColumnsNameList()).

Parameters:

columnsToExclude - The columns.

Returns:

The actual instance.

See Also:

getColumnsToExclude()

getColumnsToOrder

public Table.Order[] getColumnsToOrder()

Returns the columns to order (which are used in ORDER BY).

Returns:

Array of the name of the columns to order. If null that means not to do order.

See Also:

setColumnsToOrder(Order[])

setColumnsToOrder

public Table setColumnsToOrder(Table.Order[] columnsToOrder)

Sets the columns to order (which are used in ORDER BY).

Parameters:

columnsToOrder - The columns.

Returns:

The actual instance.

See Also:

getColumnsToOrder()

getStartDelimiter

public Character getStartDelimiter()

Returns the start delimiter for column name and table name.

Returns:

The start delimiter for column name and table name.

Since:

1.2.0

See Also:

setStartDelimiter(Character)

setStartDelimiter

public Table setStartDelimiter(Character startDelimiter)

Sets the start delimiter for column name and table name.

Parameters:

startDelimiter - The start delimiter for column name and table name.

Since:

1.2.0

See Also:

getStartDelimiter()

getEndDelimiter

public Character getEndDelimiter()

Returns the end delimiter for column name and table name.

Returns:

The end delimiter for column name and table name.

Since:

1.2.0

See Also:

setEndDelimiter(Character)

setEndDelimiter

public Table setEndDelimiter(Character endDelimiter)

Sets the end delimiter for column name and table name.

Parameters:

endDelimiter - The end delimiter for column name and table name.

Since:

1.2.0

See Also:

getEndDelimiter()

getRequest

public String getRequest()

Returns the SQL request.

Specified by:

getRequest in class AbstractDbData<Table>

Returns:

The SQL request.

Throws:

NullPointerException - If the name field is null.

See Also:

AbstractDbData.getRequest()

loadImpl

protected void loadImpl(Connection connection)
                 throws SQLException

Specific implementation of the loading for a Table.

Specified by:

loadImpl in class AbstractDbData<Table>

Parameters:

connection - Connection to the database provided by AbstractDbData.load() private method.

Throws:

NullPointerException - If the name field is null.

SQLException - SQL Exception.

See Also:

AbstractDbData.loadImpl(Connection)