org.squashtest.tm.service.internal.deletion

Class AbstractNodeDeletionHandler<NODE extends org.squashtest.tm.domain.library.LibraryNode,FOLDER extends org.squashtest.tm.domain.library.Folder<NODE>>

java.lang.Object

org.squashtest.tm.service.internal.deletion.AbstractNodeDeletionHandler<NODE,FOLDER>

Type Parameters:

NODE - a kind of LibraryNode

FOLDER - the corresponding Folder

All Implemented Interfaces:

NodeDeletionHandler<NODE,FOLDER>

Direct Known Subclasses:

CampaignDeletionHandlerImpl, RequirementDeletionHandlerImpl, TestCaseNodeDeletionHandlerImpl

public abstract class AbstractNodeDeletionHandler<NODE extends org.squashtest.tm.domain.library.LibraryNode,FOLDER extends org.squashtest.tm.domain.library.Folder<NODE>>
extends Object
implements NodeDeletionHandler<NODE,FOLDER>

This class is a abstract and generic implementation of NodeDeletionHandler that implements a few basic rules. Regardless of the end domain object (TestCase, Campaign etc) the common rules are :

• both methods must cover the children of the selected nodes,
• a folder is not removable if at least itself or one of its children is not removable (now the details of what is a non removable children is still to be implemented by subclasses).

Basically this class covers the tasks related to the directory structure (subtree coverage and detection of locked folders) by implementing those two features. On the other hand subclasses must determine, by implementing #diagnoseSuppression(List) and #detectLockedNodes(List), which nodes are locked for other reasons. See the documentations of the subclasses for more informations.

Author:

bsiri

Constructor Summary

Constructors

Constructor and Description
AbstractNodeDeletionHandler()

Method Summary

Methods

Modifier and Type	Method and Description
protected abstract OperationReport	batchDeleteNodes(List<Long> ids, Long milestoneId) Will delete the nodes identified by the ids parameter.
protected abstract OperationReport	batchUnbindFromMilestone(List<Long> ids, Long milestoneId) Will unbind the given nodes from the given milestone.
protected LockedFolderInferenceTree	createLockedFileInferenceTree(List<Long> targetIds, Long milestoneId)
OperationReport	deleteNodes(List<Long> targetIds, Long milestoneId) NodeDeletionHandler#deleteNodes(List)
protected abstract List<Long>	detectLockedNodes(List<Long> nodeIds, Long milestoneId) Given a list of node ids, returns a sublist corresponding to the ids of the nodes which cannot be deleted according to the specs.
protected abstract List<SuppressionPreviewReport>	diagnoseSuppression(List<Long> nodeIds, Long milestoneId) Given their ids, that method should check the nodes and actually report the informations as specified in NodeDeletionHandler#simulateDeletion(List).
protected List<Long>	findNodeHierarchy(List<Long> rootNodeIds) Accepts a list of node ids and returns themselves and their children as a flat list.
protected List<Long[]>	findPairedNodeHierarchy(List<Long> rootNodeIds) Accepts a list of ids and returns themselves and their children as a list of pairs, each pair being an array of long (node ids) such as [ parent.id, child.id ].
protected abstract FolderDao<FOLDER,NODE>	getFolderDao() The implemention should return which FolderDao to use depending on the end domain object.
List<SuppressionPreviewReport>	simulateDeletion(List<Long> targetIds, Long milestoneId) NodeDeletionHandler#simulateDeletion(List)

Methods inherited from class java.lang.Object

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

Constructor Detail

AbstractNodeDeletionHandler

public AbstractNodeDeletionHandler()

Method Detail

getFolderDao

protected abstract FolderDao<FOLDER,NODE> getFolderDao()

The implemention should return which FolderDao to use depending on the end domain object.

Returns:

an appropriate FolderDao.

simulateDeletion

public List<SuppressionPreviewReport> simulateDeletion(List<Long> targetIds,
                                              Long milestoneId)

NodeDeletionHandler#simulateDeletion(List)

Specified by:

simulateDeletion in interface NodeDeletionHandler<NODE extends org.squashtest.tm.domain.library.LibraryNode,FOLDER extends org.squashtest.tm.domain.library.Folder<NODE>>

Parameters:

targetIds - the ids of the input node.

milestoneId - if non null, will carry on the simulation on milestone mode.

Returns:

a list of SuppressionPreviewReport.

deleteNodes

public OperationReport deleteNodes(List<Long> targetIds,
                          Long milestoneId)

NodeDeletionHandler#deleteNodes(List)

Specified by:

deleteNodes in interface NodeDeletionHandler<NODE extends org.squashtest.tm.domain.library.LibraryNode,FOLDER extends org.squashtest.tm.domain.library.Folder<NODE>>

Parameters:

targetIds - the list of node ids selected by the user.

milestoneId - if non null, deletion will be performed in milestone mode

Returns:

an OperationReport saying what happened.

createLockedFileInferenceTree

protected LockedFolderInferenceTree createLockedFileInferenceTree(List<Long> targetIds,
                                                      Long milestoneId)

findPairedNodeHierarchy

protected List<Long[]> findPairedNodeHierarchy(List<Long> rootNodeIds)

Accepts a list of ids and returns themselves and their children as a list of pairs, each pair being an array of long (node ids) such as [ parent.id, child.id ]. see FolderDao.findPairedContentForList(List) for details. The nodes input nodes will be paired with null (no parents), and the leaves will be be paired with null (for children).

Parameters:

rootNodesIds - the ids defining the upper level of the hierarchy.

Returns:

the rootNodeIds and the ids of their children, paired together as described above.

findNodeHierarchy

protected List<Long> findNodeHierarchy(List<Long> rootNodeIds)

Accepts a list of node ids and returns themselves and their children as a flat list.

Parameters:

rootNodeIds - rootNodesIds the ids defining the upper level of the hierarchy.

Returns:

the rootNodeIds and the ids of their children.

detectLockedNodes

protected abstract List<Long> detectLockedNodes(List<Long> nodeIds,
                           Long milestoneId)

Given a list of node ids, returns a sublist corresponding to the ids of the nodes which cannot be deleted according to the specs. The input list includes all the nodes and their children in the directory structure. The implementation is responsible to fetch any other dependencies needed for the completion of its task. The implementation is not required to resolve which folders are locked : this abstract class will handle that on the basis of the returned value.

Parameters:

nodeIds - all the node ids.

milestoneId - if not null, the milestone mode will apply to the locked node detection.

Returns:

the sublist of node ids that should NOT be deleted.

diagnoseSuppression

protected abstract List<SuppressionPreviewReport> diagnoseSuppression(List<Long> nodeIds,
                                                 Long milestoneId)

Given their ids, that method should check the nodes and actually report the informations as specified in NodeDeletionHandler#simulateDeletion(List). See #detectLockedNodes(List) for details regarding the input list.

Parameters:

nodeIds - the complete list of the nodes involved in that report.

Returns:

a list of reports summarizing in human readable format what will happen.

batchDeleteNodes

protected abstract OperationReport batchDeleteNodes(List<Long> ids,
                               Long milestoneId)

Will delete the nodes identified by the ids parameter. Those nodes have been identified as legal for deletion and the implementation should only care of deleting them and unbinding them from the rest of the domain. If performed in milestone mode, the implementor must spare the elements that should not be removed according to those rules.

Parameters:

ids - the doomed node ids.

milestoneId - if non null, the deletion will be peformed in milestone mode.

Returns:

batchUnbindFromMilestone

protected abstract OperationReport batchUnbindFromMilestone(List<Long> ids,
                                       Long milestoneId)

Will unbind the given nodes from the given milestone. The operation report must report such nodes as 'deleted', in order to notify the tree not to display them anymore.

Parameters:

ids -

milestoneId -

Returns: