APIdia Launch Partner
Top Fields Constructors Methods
net.ucanaccess.commands

public Class DeleteCommand

extends AbstractCursorCommand
Class Inheritance
Imports
io.github.spannm.jackcess.Cursor, .Table, net.ucanaccess.converters.Persist2Jet, net.ucanaccess.exception.UcanaccessSQLException, net.ucanaccess.util.Try, java.io.IOException, java.sql.SQLException, java.util.Map

Field Summary

Modifier and TypeField and Description
private final String
private final IndexSelector
private final Map<String, Object>
private final Table

Constructor Summary

AccessConstructor and Description
public
DeleteCommand(Table table, Map<String, Object> rowPattern, String execId)

Method Summary

Modifier and TypeMethod and Description
public String
getExecId()

Implements net.ucanaccess.commands.ICommand.getExecId.

Returns the unique execution identifier.

public IndexSelector
getIndexSelector()

Implements net.ucanaccess.commands.ICursorCommand.getIndexSelector.

Returns the IndexSelector used to obtain the appropriate cursor for this command.

public Map<String, Object>
getRowPattern()

Implements net.ucanaccess.commands.ICursorCommand.getRowPattern.

Returns the pattern of column names and values used to identify the target row.

public String
getTableName()

Implements net.ucanaccess.commands.ICommand.getTableName.

Returns the name of the table affected by this command.

public ICommand.CommandType
getType()

Implements net.ucanaccess.commands.ICommand.getType.

Returns the type of this command.

public IFeedbackAction
persist()

Implements net.ucanaccess.commands.ICommand.persist.

Persists the changes to the underlying Access database file.

public CompositeFeedbackAction
persistCurrentRow(Cursor cur)

Implements net.ucanaccess.commands.ICursorCommand.persistCurrentRow.

Persists the command's changes to the row currently pointed to by the cursor.

public IFeedbackAction
rollback()

Implements net.ucanaccess.commands.ICommand.rollback.

Reverts the changes made by this command.

Inherited from net.ucanaccess.commands.AbstractCursorCommand:
currentRowMatchesreplaceAutoincrementtoString

Field Detail

execIdback to summary
private final String execId
indexSelectorback to summary
private final IndexSelector indexSelector
rowPatternback to summary
private final Map<String, Object> rowPattern
tableback to summary
private final Table table

Constructor Detail

DeleteCommandback to summary
public DeleteCommand(Table table, Map<String, Object> rowPattern, String execId)

Method Detail

getExecIdback to summary
public String getExecId()

Implements net.ucanaccess.commands.ICommand.getExecId.

Doc from net.ucanaccess.commands.ICommand.getExecId.

Returns the unique execution identifier.

Annotations
@Override
getIndexSelectorback to summary
public IndexSelector getIndexSelector()

Implements net.ucanaccess.commands.ICursorCommand.getIndexSelector.

Doc from net.ucanaccess.commands.ICursorCommand.getIndexSelector.

Returns the IndexSelector used to obtain the appropriate cursor for this command.

Annotations
@Override
getRowPatternback to summary
public Map<String, Object> getRowPattern()

Implements net.ucanaccess.commands.ICursorCommand.getRowPattern.

Doc from net.ucanaccess.commands.ICursorCommand.getRowPattern.

Returns the pattern of column names and values used to identify the target row.

Annotations
@Override
getTableNameback to summary
public String getTableName()

Implements net.ucanaccess.commands.ICommand.getTableName.

Doc from net.ucanaccess.commands.ICommand.getTableName.

Returns the name of the table affected by this command.

Annotations
@Override
getTypeback to summary
public ICommand.CommandType getType()

Implements net.ucanaccess.commands.ICommand.getType.

Doc from net.ucanaccess.commands.ICommand.getType.

Returns the type of this command.

Annotations
@Override
persistback to summary
public IFeedbackAction persist() throws SQLException

Implements net.ucanaccess.commands.ICommand.persist.

Doc from net.ucanaccess.commands.ICommand.persist.

Persists the changes to the underlying Access database file.

Annotations
@Override
Exceptions
SQLException:
if a database error occurs during persistence
persistCurrentRowback to summary
public CompositeFeedbackAction persistCurrentRow(Cursor cur) throws IOException

Implements net.ucanaccess.commands.ICursorCommand.persistCurrentRow.

Doc from net.ucanaccess.commands.ICursorCommand.persistCurrentRow.

Persists the command's changes to the row currently pointed to by the cursor.

This is typically used by CompositeCommand to perform batch-like updates while iterating over a table.

Annotations
@Override
Exceptions
IOException:
if an I/O error occurs during the Jackcess operation
rollbackback to summary
public IFeedbackAction rollback() throws SQLException

Implements net.ucanaccess.commands.ICommand.rollback.

Doc from net.ucanaccess.commands.ICommand.rollback.

Reverts the changes made by this command.

Annotations
@Override
Exceptions
SQLException:
if a database error occurs during rollback