org.apache.metamodel.delete

Class DeleteFrom

java.lang.Object

org.apache.metamodel.delete.DeleteFrom

All Implemented Interfaces:

WhereClauseBuilder<DeleteFrom>, UpdateScript, Action<UpdateCallback>

public final class DeleteFrom
extends Object
implements UpdateScript, WhereClauseBuilder<DeleteFrom>

Represents a single DELETE FROM operation to be applied to a UpdateableDataContext. Instead of providing a custom implementation of the UpdateScript interface, one can use this pre-built delete from implementation. Some DataContexts may even optimize specifically based on the knowledge that there will only be a single delete from statement executed.

Constructor Summary

Constructors

Constructor and Description
DeleteFrom(Table table)

Method Summary

Methods

Modifier and Type	Method and Description
void	run(UpdateCallback callback) Invoked by MetaModel when the update script should be run.
FilterBuilder<DeleteFrom>	where(Column column) Defines a where item to set as a criteria
DeleteFrom	where(FilterItem... filterItems) Applies where items to set criteria
DeleteFrom	where(Iterable<FilterItem> filterItems) Applies where items to set criteria
FilterBuilder<DeleteFrom>	where(String columnName) Defines a where item to set as a criteria

Methods inherited from class java.lang.Object

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

Constructor Detail

DeleteFrom

public DeleteFrom(Table table)

Method Detail

run

public void run(UpdateCallback callback)

Description copied from interface: UpdateScript

Invoked by MetaModel when the update script should be run. User should implement this method and invoke update operations on the UpdateCallback.

Specified by:

run in interface UpdateScript

Specified by:

run in interface Action<UpdateCallback>

where

public FilterBuilder<DeleteFrom> where(Column column)

Description copied from interface: WhereClauseBuilder

Defines a where item to set as a criteria

Specified by:

where in interface WhereClauseBuilder<DeleteFrom>

Parameters:

column - a column to apply a criteria for

Returns:

a builder object for further building the where item

where

public FilterBuilder<DeleteFrom> where(String columnName)

Description copied from interface: WhereClauseBuilder

Defines a where item to set as a criteria

Specified by:

where in interface WhereClauseBuilder<DeleteFrom>

Parameters:

columnName - the name of the colum to which the criteria will be applied

Returns:

a builder object for further building the where item

where

public DeleteFrom where(FilterItem... filterItems)

Description copied from interface: WhereClauseBuilder

Applies where items to set criteria

Specified by:

where in interface WhereClauseBuilder<DeleteFrom>

Parameters:

filterItems - the where items to set

Returns:

the builder object itself, for further building of the update

where

public DeleteFrom where(Iterable<FilterItem> filterItems)

Description copied from interface: WhereClauseBuilder

Applies where items to set criteria

Specified by:

where in interface WhereClauseBuilder<DeleteFrom>

Parameters:

filterItems - the where items to set

Returns:

the builder object, for further building of the update