com.togethersoft.sca.core.plugin.report
Interface IMessageFilter

All Superinterfaces:

IExtensionExecutable

All Known Implementing Classes:

SubsetFilter, SortFilter

public interface IMessageFilter

extends IExtensionExecutable

Interface for message filtering the message filter performs transformation of message lists. Such transformation can be both simple as in case of trivial sorting or smart enough as in case of some AI-based summary/annotation generator

Method Summary

java.lang.String[]	analyzersRequired() gives names of analyzers required to produce messages of interest for the filter.
MessageList	apply(MessageList list) Perform filtering of the message list according to preconfigured parameters
java.lang.String	description() gives the informative description of the filter
IParameterRegistry	getParameterRegistry() Returns the parameter registry that holds the parameters of this extension.
java.lang.String	name() gives the short name of message filter.

Methods inherited from interface com.togethersoft.sca.core.IExtensionExecutable

setParameters

Method Detail

analyzersRequired

public java.lang.String[] analyzersRequired()

gives names of analyzers required to produce messages of interest for the filter. If the filter is generic (i.e. has no specific requirement) the list may be empty.

Returns:

the array of required analyzer names

apply

public MessageList apply(MessageList list)

Perform filtering of the message list according to preconfigured parameters

Parameters:

list - the input message list

Returns:

the new message list produced after filtering the input

description

public java.lang.String description()

gives the informative description of the filter

Returns:

the informative filter description

getParameterRegistry

public IParameterRegistry getParameterRegistry()

Returns the parameter registry that holds the parameters of this extension. Returns an empty registry, if no parameters are provided.

Returns:

the parameter registry of this extension.

name

public java.lang.String name()

gives the short name of message filter. As a convention the name MUST end with "Filter" suffix.

Returns:

the shot name of the filter