org.jamesframework.core.subset.neigh.moves

Class AdditionMove

java.lang.Object

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

org.jamesframework.core.subset.neigh.moves.AdditionMove

All Implemented Interfaces:

Move<SubsetSolution>, SubsetMove

public class AdditionMove
extends AbstractSubsetMove

Simple subset move that adds a single ID to the current selection.

Author:

Herman De Beukelaer

Constructor Summary

Constructors

Constructor and Description
AdditionMove(int add) Create a new addition move that will add the specified ID to the current selection when being applied to a given subset solution.

Method Summary

Modifier and Type	Method and Description
void	apply(SubsetSolution solution) Apply this addition move to the given subset solution.
int	getAddedID() Returns the added ID.
Set<Integer>	getAddedIDs() Returns an unmodifiable singleton containing the only added ID.
Set<Integer>	getDeletedIDs() Returns an unmodifiable empty set, as no IDs are deleted by this move.
int	getNumAdded() Always return 1, as a single ID is added.
int	getNumDeleted() Always returns 0, as no IDs are deleted.
void	undo(SubsetSolution solution) Undo this addition move after it has been successfully applied to the given subset solution, by removing the newly added ID from 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

AdditionMove

public AdditionMove(int add)

Create a new addition move that will add the specified ID to the current selection when being applied to a given subset solution.

Parameters:

add - ID to add to selection

Method Detail

getAddedIDs

public Set<Integer> getAddedIDs()

Returns an unmodifiable singleton containing the only added ID.

Returns:

unmodifiable singleton containing added ID

getAddedID

public int getAddedID()

Returns the added ID.

Returns:

added ID

getDeletedIDs

public Set<Integer> getDeletedIDs()

Returns an unmodifiable empty set, as no IDs are deleted by this move.

Returns:

empty set

getNumAdded

public int getNumAdded()

Always return 1, as a single ID is added.

Returns:

1

getNumDeleted

public int getNumDeleted()

Always returns 0, as no IDs are deleted.

Returns:

0

apply

public void apply(SubsetSolution solution)

Apply this addition move to the given subset solution. The move can only be applied if the ID that will be added to the selection is currently not already 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 added ID is currently already selected or does not correspond to an entity

undo

public void undo(SubsetSolution solution)

Undo this addition move after it has been successfully applied to the given subset solution, by removing the newly added ID from the selection.

Parameters:

solution - solution to which the move has been applied