Class BasicCheck.TopObjectFeatureConfigurationBuilder
- java.lang.Object
-
- com.e1c.g5.v8.dt.check.components.BasicCheck.TopObjectFeatureConfigurationBuilder
-
- Enclosing class:
- BasicCheck
public static final class BasicCheck.TopObjectFeatureConfigurationBuilder extends Object
Builder that supports building of the top object feature tracking rules configuration. See methods documentation for the usage guides.
-
-
Method Summary
All Methods Instance Methods Concrete Methods Modifier and Type Method Description BasicCheck.ContainmentConfigurationBuilder
containment(org.eclipse.emf.ecore.EClass containmentEClass)
Defines the type of the containment object of a current top object to track.
Example: track the tabular section attribute of the Catalog:
...
  builder.topObject(CATALOG).
    containment(TABULAR_SECTION_ATTRIBUTE);
...BasicCheck.TopObjectFeatureConfigurationBuilder
features(org.eclipse.emf.ecore.EStructuralFeature... observedFeatures)
Configures the change tracking for the set of top object features.BasicCheck.CheckParameterBuilder
parameter(String name, Class<?> type, String defaultValue, String title)
Defines a parameter of the check.BasicCheck.TopObjectConfigurationBuilder
topObject(org.eclipse.emf.ecore.EClass topObjectEClass)
Defines the check running rule on change of model top object data.
-
-
-
Method Detail
-
containment
public BasicCheck.ContainmentConfigurationBuilder containment(org.eclipse.emf.ecore.EClass containmentEClass)
Defines the type of the containment object of a current top object to track.
Example: track the tabular section attribute of the Catalog:
...
  builder.topObject(CATALOG).
    containment(TABULAR_SECTION_ATTRIBUTE);
...- Parameters:
containmentEClass
- The type of the containment object. May not benull
or empty- Returns:
- The
BasicCheck.ContainmentConfigurationBuilder
for configuration chaining. May not benull
-
features
public BasicCheck.TopObjectFeatureConfigurationBuilder features(org.eclipse.emf.ecore.EStructuralFeature... observedFeatures)
Configures the change tracking for the set of top object features. The check will be called in case if any of these features will be changed.
Example: track changes of the Catalog name:
...
  builder.topObject(CATALOG).
    features(MD_OBJECT__NAME).
...- Parameters:
observedFeatures
- The set of features of the corresponding top object to track changes for. May not benull
or empty- Returns:
- The
BasicCheck.TopObjectFeatureConfigurationBuilder
for configuration chaining. May not benull
-
parameter
public BasicCheck.CheckParameterBuilder parameter(String name, Class<?> type, String defaultValue, String title)
Defines a parameter of the check. The parameter will be available on the check preferences page for the editing and its value will be accessible during the check via theICheckParameters
Example: add Integer parameter to the check:
...
  builder.topObject(CATALOG).
    MIN_LENGTH_PARAMETER_NAME, Integer.class, "8", Messages.CatalogCodeLengthCheck_MinLengthParameter_Title).
...- Parameters:
name
- The name of the parameter. May not benull
. Must be unique among other parameters being defined for this check. In case if the name is not unqiue any arbitrary parameter definition may be selected as final parameter definitiontype
- The type of the parameter. May not benull
. The following set of the parameter types are supported:
- Boolean - supported values are: True, False, TRUE, FALSE
- Integer - matches requirements of the
Integer.valueOf(String)
- Long - - matches requirements of the
Long.valueOf(String)
- Double - supports dot separated format (XXXX.YYYY)
- String - any generic string
defaultValue
- The default value (as String). May benull
or empty. See the type parameter for the available values.title
- The title of the parameter to display to the user in the check preferences page. May benull
or empty- Returns:
- The
BasicCheck.TopObjectFeatureConfigurationBuilder
for configuration chaining. May not benull
-
topObject
public BasicCheck.TopObjectConfigurationBuilder topObject(org.eclipse.emf.ecore.EClass topObjectEClass)
Defines the check running rule on change of model top object data. The object is defined by the correspondingEClass
.
The rest of check launching configuration for this object should be done via the object being returned by this method
Example: Start the configuration of check running rules for the Catalog object:
...
  builder.topObject(CATALOG).
... Please note, that calling of this method will effectively finish the configuration of the currently selected top object and begins the configuration of a new one. It's impossible to proceed with the configuration of the previous top object after the call of this method- Parameters:
topObjectEClass
- TheEClass
of the target top object. May not benull
- Returns:
BasicCheck.TopObjectConfigurationBuilder
bound to the context of the selectedEClass
and ready for further configuration. May not benull
-
-