Interface IDetector<T extends DetectorWorker>
-
- All Known Implementing Classes:
Detector
,NGramDetector
,PairwiseDetector
,VariableNameDetector
public interface IDetector<T extends DetectorWorker>
Low level interface for implementing a detection algorithm. The AbstractDetector
class should be used over this
Supports adjustable parameters seeAdjustableParameter
-
-
Method Summary
All Methods Instance Methods Abstract Methods Modifier and Type Method Description java.util.List<T>
buildWorkers(java.util.List<ModelDataItem> data)
Builds a set of workers on a passed dataset, these workers are executed in parallel to produce the algorithm resultjava.lang.String
getDescription()
Fetches the description string for the detectorjava.lang.String
getDisplayName()
Fetches the display name for the detectorjava.util.List<PreProcessingStrategy>
getPreProcessors()
Specify the preprocessors required for this detector.
-
-
-
Method Detail
-
buildWorkers
java.util.List<T> buildWorkers(java.util.List<ModelDataItem> data)
Builds a set of workers on a passed dataset, these workers are executed in parallel to produce the algorithm result- Parameters:
data
- preprocessed dataset- Returns:
- list of configured workers ready to be executed
-
getDescription
java.lang.String getDescription()
Fetches the description string for the detector- Returns:
- the description
-
getDisplayName
java.lang.String getDisplayName()
Fetches the display name for the detector- Returns:
- the display name
-
getPreProcessors
java.util.List<PreProcessingStrategy> getPreProcessors()
Specify the preprocessors required for this detector.
The individual strategies in the list can be produced using the generic methodsPreProcessingStrategy.of(String, Class...)
orPreProcessingStrategy.of(String, boolean, Class...)
in the interface, or using a fully customPreProcessingStrategy
class.
The string name of each of the strategies is used as the key reference in the preprocessed dataset given to thebuildWorkers(List)
method- Returns:
- a list of the required preprocessing strategies
-
-