org.jamesframework.core.subset.neigh.moves

Class DeletionMove

java.lang.Object

org.jamesframework.core.subset.neigh.moves.AbstractSubsetMove

org.jamesframework.core.subset.neigh.moves.DeletionMove

All Implemented Interfaces:

Move<SubsetSolution>, SubsetMove

public class DeletionMove
extends AbstractSubsetMove

Simple subset move that removes a single ID from the current selection.

Author:

Herman De Beukelaer

Constructor Summary

Constructors

Constructor and Description
DeletionMove(int delete) Create a new deletion move, specifying the ID that will be removed from the selection when this moves is applied to a given subset solution.

Method Summary

Modifier and Type	Method and Description
void	apply(SubsetSolution solution) Apply this deletion move to the given subset solution.
Set<Integer>	getAddedIDs() Returns an unmodifiable empty set, as no IDs are added.
int	getDeletedID() Returns the deleted ID.
Set<Integer>	getDeletedIDs() Returns an unmodifiable singleton, containing the only deleted ID.
int	getNumAdded() Always returns 0, as no IDs are added.
int	getNumDeleted() Always returns 1, as a single ID is deleted.
void	undo(SubsetSolution solution) Undo this deletion move after it has been successfully applied to the given subset solution, by re-adding the deleted ID to the selection.

Methods inherited from class org.jamesframework.core.subset.neigh.moves.AbstractSubsetMove

equals, hashCode

Methods inherited from class java.lang.Object

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

Constructor Detail

DeletionMove

public DeletionMove(int delete)

Create a new deletion move, specifying the ID that will be removed from the selection when this moves is applied to a given subset solution.

Parameters:

delete - ID to be removed from the selection

Method Detail

getAddedIDs

public Set<Integer> getAddedIDs()

Returns an unmodifiable empty set, as no IDs are added.

Returns:

empty set

getDeletedIDs

public Set<Integer> getDeletedIDs()

Returns an unmodifiable singleton, containing the only deleted ID.

Returns:

singleton containing deleted ID

getDeletedID

public int getDeletedID()

Returns the deleted ID.

Returns:

deleted ID

getNumAdded

public int getNumAdded()

Always returns 0, as no IDs are added.

Returns:

0

getNumDeleted

public int getNumDeleted()

Always returns 1, as a single ID is deleted.

Returns:

1

apply

public void apply(SubsetSolution solution)

Apply this deletion move to the given subset solution. The move can only be applied if the ID to be deleted from the selection is currently indeed selected. This guarantees that calling undo(SubsetSolution) will correctly undo the move.

Parameters:

solution - solution to which to move is applied

Throws:

SolutionModificationException - if the deleted ID is currently not selected or does not correspond to an entity

undo

public void undo(SubsetSolution solution)

Undo this deletion move after it has been successfully applied to the given subset solution, by re-adding the deleted ID to the selection.

Parameters:

solution - solution to which the move has been applied