org.electrocodeogram.cpc.imports.api.imports.strategy
Interface IImportFilterStrategy

public interface IImportFilterStrategy

Import filter strategies are applied to the output of an IImportToolAdapter.
These strategies will usually be used to filter out obviously irrelevant or incorrect clones returned by an import tool adapter. They might also be used to merge or modify clones if this seems prudent.

Implementations need to be registered with the CPC Imports extension point "org.electrocodeogram.cpc.imports.importFilterStrategies".

Author:

vw

Nested Class Summary

static class

IImportFilterStrategy.Status Return status for the filterImport(Map, Map) method.

Method Summary

IImportFilterStrategy.Status

filterImport(java.util.Map<ICloneFile,java.util.List<IClone>> cloneResults, java.util.Map<java.lang.String,java.lang.String> options) Takes the result of an import operation and filters out clones which are deemed not be be worth importing.

Method Detail

filterImport

IImportFilterStrategy.Status filterImport(java.util.Map<ICloneFile,java.util.List<IClone>> cloneResults,
                                          java.util.Map<java.lang.String,java.lang.String> options)

Takes the result of an import operation and filters out clones which are deemed not be be worth importing. Clones may also be modified by this operation.

All modifications are to be done in place, in the provided clone results map.

Parameters:

cloneResults - the result map of the clone import, never null.

options - a configuration options map, never null.

Returns:

whether further filters should be executed or not, never null.