Package com.e1c.g5.v8.dt.check.components

Class TopObjectFilterExtension

java.lang.Object

com.e1c.g5.v8.dt.check.components.TopObjectFilterExtension

All Implemented Interfaces:

IBasicCheckExtension

public class TopObjectFilterExtension
extends Object
implements IBasicCheckExtension

Common filtering of the top object via the parameter-defined name pattern

Field Summary

Fields

Modifier and Type	Field	Description
static String	EXCLUDE_TOP_MD_OBJECT_NAME_PATTERN_PARAMETER_NAME

Constructor Summary

Constructors

Constructor	Description
TopObjectFilterExtension()	Constructs an instance of the extension with default parameter name and value bound to the MdClassPackage.Literals.MD_OBJECT__NAME as a filtering medium
TopObjectFilterExtension(String parameterName, String parameterTitle, String defaultValue, org.eclipse.emf.ecore.EStructuralFeature nameFeature)	Constructs an instance of the extension
TopObjectFilterExtension(org.eclipse.emf.ecore.EStructuralFeature nameFeature)	Constructs an instance of the extension with default parameter name and value

Method Summary

Modifier and Type	Method	Description
void	configureContextCollector(ICheckDefinition definition)	This method allows to add settings to the ICheckDefinition during the check configuration cycle
ITopObjectFilter	contributeTopObjectFilter()	Contributes the top object model filter if necessary

Methods inherited from class java.lang.Object

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

Methods inherited from interface com.e1c.g5.v8.dt.check.components.IBasicCheckExtension

preCheck

Field Detail

EXCLUDE_TOP_MD_OBJECT_NAME_PATTERN_PARAMETER_NAME

public static final String EXCLUDE_TOP_MD_OBJECT_NAME_PATTERN_PARAMETER_NAME

See Also:

Constant Field Values

Constructor Detail

TopObjectFilterExtension

public TopObjectFilterExtension()

Constructs an instance of the extension with default parameter name and value bound to the MdClassPackage.Literals.MD_OBJECT__NAME as a filtering medium

TopObjectFilterExtension

public TopObjectFilterExtension(org.eclipse.emf.ecore.EStructuralFeature nameFeature)

Constructs an instance of the extension with default parameter name and value

Parameters:

nameFeature - The name feature of the target object type. May not be null

TopObjectFilterExtension

public TopObjectFilterExtension(String parameterName,
                                String parameterTitle,
                                String defaultValue,
                                org.eclipse.emf.ecore.EStructuralFeature nameFeature)

Constructs an instance of the extension

Parameters:

parameterName - The filtering parameter name. May not be null

parameterTitle - The parameter title. May not be null

defaultValue - The default value of the parameter. May be left null

nameFeature - The name feature of the target object type. May not be null

Method Detail

configureContextCollector

public void configureContextCollector(ICheckDefinition definition)

Description copied from interface: IBasicCheckExtension

This method allows to add settings to the ICheckDefinition during the check configuration cycle

Specified by:

configureContextCollector in interface IBasicCheckExtension

Parameters:

definition - The check definition. May not be null

contributeTopObjectFilter

public ITopObjectFilter contributeTopObjectFilter()

Description copied from interface: IBasicCheckExtension

Contributes the top object model filter if necessary

Specified by:

contributeTopObjectFilter in interface IBasicCheckExtension

Returns:

The filter to contribute. May be left null in case if the filter isn't necessary