UCanAccess 5.2.0 · net.ucanaccess.converters.UcanaccessTable

Modifier and Type	Field and Description
private final String	tableName
private final Table	wrapped

Access	Constructor and Description
public	UcanaccessTable(Table table, String tableName)

Method Summary

Modifier and Type	Method and Description
public Object[]	addRow(Object... row) Implements io.github.spannm.jackcess.Table.addRow. Adds a single row to this table and writes it to disk.
public <M extends Map<String, Object>> M	addRowFromMap(M row) Implements io.github.spannm.jackcess.Table.addRowFromMap. Calls `asRow` on the given row map and passes the result to `addRow`.
public List<? extends Object[]>	addRows(List<? extends Object[]> rows) Implements io.github.spannm.jackcess.Table.addRows. Add multiple rows to this table, only writing to disk after all rows have been written, and every time a data page is filled.
public <M extends Map<String, Object>> List<M>	addRowsFromMaps(List<M> rows) Implements io.github.spannm.jackcess.Table.addRowsFromMaps. Calls `asRow` on the given row maps and passes the results to `addRows`.
public Object[]	asRow(Map<String, ?> rowMap) Implements io.github.spannm.jackcess.Table.asRow. Converts a map of columnName -> columnValue to an array of row values appropriate for a call to `addRow(Object...)`.
public Object[]	asUpdateRow(Map<String, ?> rowMap) Implements io.github.spannm.jackcess.Table.asUpdateRow. Converts a map of columnName -> columnValue to an array of row values appropriate for a call to `Cursor#updateCurrentRow(Object...)`.
public TableImpl.RowState	createRowState()
public Row	deleteRow(Row row) Implements io.github.spannm.jackcess.Table.deleteRow. Delete the given row.
public Column	getColumn(String name) Implements io.github.spannm.jackcess.Table.getColumn. Returns the column with the given name.
public int	getColumnCount() Implements io.github.spannm.jackcess.Table.getColumnCount. Returns the number of columns in this table.
public List<? extends Column>	getColumns() Implements io.github.spannm.jackcess.Table.getColumns. Returns all of the columns in this table (unmodifiable List).
public LocalDateTime	getCreatedDate() Implements io.github.spannm.jackcess.Table.getCreatedDate. Returns the created date for this table if available.
public Database	getDatabase() Implements io.github.spannm.jackcess.Table.getDatabase. Returns the database to which this table belongs.
public Cursor	getDefaultCursor() Implements io.github.spannm.jackcess.Table.getDefaultCursor. Returns a simple Cursor, initialized on demand and held by this table.
public ErrorHandler	getErrorHandler() Implements io.github.spannm.jackcess.Table.getErrorHandler. Gets the currently configured ErrorHandler (always non-`null`).
public Index	getForeignKeyIndex(Table otherTable) Implements io.github.spannm.jackcess.Table.getForeignKeyIndex. Returns the foreign key index joining this table to the given other table.
public Index	getIndex(String name) Implements io.github.spannm.jackcess.Table.getIndex. Returns the index with the given name.
public List<? extends Index>	getIndexes() Implements io.github.spannm.jackcess.Table.getIndexes. Returns all of the Indexes on this table (unmodifiable List).
public String	getName() Implements io.github.spannm.jackcess.Table.getName. Returns the name of the table.
public Row	getNextRow() Implements io.github.spannm.jackcess.Table.getNextRow. Returns the next row in this table (Column name -> Column value) (uses the `default cursor`).
public Index	getPrimaryKeyIndex() Implements io.github.spannm.jackcess.Table.getPrimaryKeyIndex. Returns the primary key index for this table.
public PropertyMap	getProperties() Implements io.github.spannm.jackcess.Table.getProperties. Returns the properties for this table.
public int	getRowCount() Implements io.github.spannm.jackcess.Table.getRowCount. Returns the number of rows currently stored in this table.
public LocalDateTime	getUpdatedDate() Implements io.github.spannm.jackcess.Table.getUpdatedDate. Note jackcess does not automatically update the modified date of a Table.
public boolean	isAllowAutoNumberInsert() Implements io.github.spannm.jackcess.Table.isAllowAutoNumberInsert. Gets the currently configured auto number insert policy.
public boolean	isHidden() Implements io.github.spannm.jackcess.Table.isHidden. Whether or not this table has been marked as hidden.
public boolean	isSystem() Implements io.github.spannm.jackcess.Table.isSystem. Whether or not this table is a system (internal) table.
public Iterator<Row>	iterator() Implements io.github.spannm.jackcess.Table.iterator. Calls `reset` on this table and returns a modifiable Iterator which will iterate through all the rows of this table.
public CursorBuilder	newCursor() Implements io.github.spannm.jackcess.Table.newCursor. Convenience method for constructing a new CursorBuilder for this Table.
public void	reset() Implements io.github.spannm.jackcess.Table.reset. After calling this method, `getNextRow` will return the first row in the table, see `Cursor#reset` (uses the `default cursor`).
public void	setAllowAutoNumberInsert(Boolean arg0) Implements io.github.spannm.jackcess.Table.setAllowAutoNumberInsert. Sets the new auto number insert policy for the Table.
public void	setErrorHandler(ErrorHandler newErrorHandler) Implements io.github.spannm.jackcess.Table.setErrorHandler. Sets a new ErrorHandler.
public String	toString() Overrides java.lang.Object.toString. Returns a string representation of the object.
public Row	updateRow(Row row) Implements io.github.spannm.jackcess.Table.updateRow. Update the given row.

Inherited from java.lang.Object:: clone equals finalize getClass hashCode notify notifyAll wait wait wait

tableName	back to summary
private final String tableName

wrapped	back to summary
private final Table wrapped

UcanaccessTable	back to summary
public UcanaccessTable(Table table, String tableName)

Method Detail

addRow back to summary

addRow	back to summary
public Object[] addRow(Object... row) throws IOException Implements io.github.spannm.jackcess.Table.addRow. Doc from io.github.spannm.jackcess.Table.addRow. Adds a single row to this table and writes it to disk. The values are expected to be given in the order that the Columns are listed by the `getColumns` method. This is by default the storage order of the Columns in the database, however this order can be influenced by setting the ColumnOrder via `Database#setColumnOrder` prior to opening the Table. The `asRow` method can be used to easily convert a row Map into the appropriate row array for this Table. Note, if this table has an auto-number column, the value generated will be put back into the given row array (assuming the given row array is at least as long as the number of Columns in this Table). Annotations @Override

public Object[] addRow(Object... row) throws IOException

Implements io.github.spannm.jackcess.Table.addRow.

Doc from io.github.spannm.jackcess.Table.addRow.

Adds a single row to this table and writes it to disk. The values are expected to be given in the order that the Columns are listed by the getColumns method. This is by default the storage order of the Columns in the database, however this order can be influenced by setting the ColumnOrder via Database#setColumnOrder prior to opening the Table. The asRow method can be used to easily convert a row Map into the appropriate row array for this Table.

Note, if this table has an auto-number column, the value generated will be put back into the given row array (assuming the given row array is at least as long as the number of Columns in this Table).

Annotations

@Override

addRowFromMap back to summary

addRowFromMap	back to summary
public <M extends Map<String, Object>> M addRowFromMap(M row) throws IOException Implements io.github.spannm.jackcess.Table.addRowFromMap. Doc from io.github.spannm.jackcess.Table.addRowFromMap. Calls `asRow` on the given row map and passes the result to `addRow`. Note, if this table has an auto-number column, the value generated will be put back into the given row map. Annotations @Override

public <M extends Map<String, Object>> M addRowFromMap(M row) throws IOException

Implements io.github.spannm.jackcess.Table.addRowFromMap.

Doc from io.github.spannm.jackcess.Table.addRowFromMap.

Calls asRow on the given row map and passes the result to addRow.

Note, if this table has an auto-number column, the value generated will be put back into the given row map.

Annotations

@Override

addRows back to summary

addRows	back to summary
public List<? extends Object[]> addRows(List<? extends Object[]> rows) throws IOException Implements io.github.spannm.jackcess.Table.addRows. Doc from io.github.spannm.jackcess.Table.addRows. Add multiple rows to this table, only writing to disk after all rows have been written, and every time a data page is filled. This is much more efficient than calling `addRow` multiple times. Note, if this table has an auto-number column, the values written will be put back into the given row arrays (assuming the given row array is at least as long as the number of Columns in this Table). Most exceptions thrown from this method will be wrapped with a `BatchUpdateException` which gives useful information in the case of a partially successful write. Annotations @Override

public List<? extends Object[]> addRows(List<? extends Object[]> rows) throws IOException

Implements io.github.spannm.jackcess.Table.addRows.

Doc from io.github.spannm.jackcess.Table.addRows.

Add multiple rows to this table, only writing to disk after all rows have been written, and every time a data page is filled. This is much more efficient than calling addRow multiple times.

Note, if this table has an auto-number column, the values written will be put back into the given row arrays (assuming the given row array is at least as long as the number of Columns in this Table).

Most exceptions thrown from this method will be wrapped with a BatchUpdateException which gives useful information in the case of a partially successful write.

Annotations

@Override

addRowsFromMaps back to summary

addRowsFromMaps	back to summary
public <M extends Map<String, Object>> List<M> addRowsFromMaps(List<M> rows) throws IOException Implements io.github.spannm.jackcess.Table.addRowsFromMaps. Doc from io.github.spannm.jackcess.Table.addRowsFromMaps. Calls `asRow` on the given row maps and passes the results to `addRows`. Note, if this table has an auto-number column, the values generated will be put back into the appropriate row maps. Most exceptions thrown from this method will be wrapped with a `BatchUpdateException` which gives useful information in the case of a partially successful write. Annotations @Override

public <M extends Map<String, Object>> List<M> addRowsFromMaps(List<M> rows) throws IOException

Implements io.github.spannm.jackcess.Table.addRowsFromMaps.

Doc from io.github.spannm.jackcess.Table.addRowsFromMaps.

Calls asRow on the given row maps and passes the results to addRows.

Note, if this table has an auto-number column, the values generated will be put back into the appropriate row maps.

Most exceptions thrown from this method will be wrapped with a BatchUpdateException which gives useful information in the case of a partially successful write.

Annotations

@Override

asRow back to summary

asRow	back to summary
public Object[] asRow(Map<String, ?> rowMap) Implements io.github.spannm.jackcess.Table.asRow. Doc from io.github.spannm.jackcess.Table.asRow. Converts a map of columnName -> columnValue to an array of row values appropriate for a call to `addRow(Object...)`. Annotations @Override

public Object[] asRow(Map<String, ?> rowMap)

Implements io.github.spannm.jackcess.Table.asRow.

Doc from io.github.spannm.jackcess.Table.asRow.

Converts a map of columnName -> columnValue to an array of row values appropriate for a call to addRow(Object...).

Annotations

@Override

asUpdateRow back to summary

asUpdateRow	back to summary
public Object[] asUpdateRow(Map<String, ?> rowMap) Implements io.github.spannm.jackcess.Table.asUpdateRow. Doc from io.github.spannm.jackcess.Table.asUpdateRow. Converts a map of columnName -> columnValue to an array of row values appropriate for a call to `Cursor#updateCurrentRow(Object...)`. Annotations @Override

public Object[] asUpdateRow(Map<String, ?> rowMap)

Implements io.github.spannm.jackcess.Table.asUpdateRow.

Doc from io.github.spannm.jackcess.Table.asUpdateRow.

Converts a map of columnName -> columnValue to an array of row values appropriate for a call to Cursor#updateCurrentRow(Object...).

Annotations

@Override

createRowState	back to summary
public TableImpl.RowState createRowState()

deleteRow	back to summary
public Row deleteRow(Row row) throws IOException Implements io.github.spannm.jackcess.Table.deleteRow. Doc from io.github.spannm.jackcess.Table.deleteRow. Delete the given row. Provided Row must have previously been returned from this Table. Annotations @Override

deleteRow

public Class UcanaccessTable

Field Summary

Constructor Summary

Method Summary

Field Detail

Constructor Detail

Method Detail