org.jamesframework.core.subset.neigh.moves

Class GeneralSubsetMove

java.lang.Object

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

org.jamesframework.core.subset.neigh.moves.GeneralSubsetMove

All Implemented Interfaces:

Move<SubsetSolution>, SubsetMove

public class GeneralSubsetMove
extends AbstractSubsetMove

A general subset move may simultaneously add and/or remove several IDs to/from the current selection of a subset solution.

Author:

Herman De Beukelaer

Constructor Summary

Constructors

Constructor and Description
GeneralSubsetMove(Set<Integer> add, Set<Integer> delete) Creates a general subset move, indicating which IDs are to be added to and deleted from 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 move to a given subset solution.
Set<Integer>	getAddedIDs() Returns an unmodifiable view of the set of IDs added to the selection when applying this move to a subset solution.
Set<Integer>	getDeletedIDs() Returns an unmodifiable view of the set of IDs removed from the selection when applying this move to a subset solution.
int	getNumAdded() Returns the number of added IDs.
int	getNumDeleted() Returns the number of removed IDs.
void	undo(SubsetSolution solution) Undo this move after it has been successfully applied to the given subset solution, by removing all added IDs and adding all removed IDs.

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

GeneralSubsetMove

public GeneralSubsetMove(Set<Integer> add,
                         Set<Integer> delete)

Creates a general subset move, indicating which IDs are to be added to and deleted from the current selection when being applied to a given subset solution. Note that the sets add and delete are not copied: a reference to the given sets is stored in the subset move. If any of both sets is null, it will be replaced with an empty set.

Parameters:

add - set of IDs to add to the selection

delete - set of IDs to delete from the selection

Method Detail

getAddedIDs

public Set<Integer> getAddedIDs()

Returns an unmodifiable view of the set of IDs added to the selection when applying this move to a subset solution. The returned set may be empty.

Returns:

set of added IDs

getDeletedIDs

public Set<Integer> getDeletedIDs()

Returns an unmodifiable view of the set of IDs removed from the selection when applying this move to a subset solution. The returned set may be empty.

Returns:

set of removed IDs

getNumAdded

public int getNumAdded()

Returns the number of added IDs. May be zero.

Returns:

number of added IDs

getNumDeleted

public int getNumDeleted()

Returns the number of removed IDs. May be zero.

Returns:

number of removed IDs

apply

public void apply(SubsetSolution solution)

Apply this move to a given subset solution. The move can only be applied to a solution for which none of the added IDs are currently already selected and none of the removed IDs are currently not selected. This guarantees that calling undo(SubsetSolution) will correctly undo the move.

Parameters:

solution - solution to which to move will be applied

Throws:

SolutionModificationException - if some added ID is already selected, some removed ID is currently not selected, or any ID does not correspond to an underlying entity

undo

public void undo(SubsetSolution solution)

Undo this move after it has been successfully applied to the given subset solution, by removing all added IDs and adding all removed IDs. If the subset solution has been modified since successful application of this move, the result of this operation is undefined.

Parameters:

solution - solution to which the move has been successfully applied