Package com.e1c.langtool.v8.dt.check

Class AbstractTranslationValidator

java.lang.Object

com.e1c.g5.v8.dt.check.components.BasicCheck<AbstractTranslationValidator.TranslationValidatorContext>

com.e1c.langtool.v8.dt.check.AbstractTranslationValidator

All Implemented Interfaces:

ITopObjectFilter, ICheck<AbstractTranslationValidator.TranslationValidatorContext>

Direct Known Subclasses:

DcsModelTranslationCheck, DynamicFeatureAccessTranslationCheck, MethodTranslationValidator, NotAllowedTranslationCheck, NstrLiteralPramTranslationCheck, NstrLiteralValidator, PresentationTranslationCheck, RegionTranslationValidator, StringLiteralKeysTranslationValidator, StringLiteralValidator, StructureKeysTranslationValidator, TableKeysTranslationValidator, VariableTranslationValidator

public abstract class AbstractTranslationValidator
extends BasicCheck<AbstractTranslationValidator.TranslationValidatorContext>

The abstract validator class to check translations for EObject features. It collects model feature values and get translation from each ITranslationStorageProvider.Storage of project.

Nested Class Summary

Nested Classes

Modifier and Type	Class	Description
class	AbstractTranslationValidator.TranslationValidatorContext	Standard context for translation validators Contains useful data and services that are required by validators to speed up the process

Nested classes/interfaces inherited from class com.e1c.g5.v8.dt.check.components.BasicCheck

BasicCheck.CheckConfigurer, BasicCheck.CheckParameterBuilder, BasicCheck.ContainmentConfigurationBuilder, BasicCheck.DelegateCheckConfigurationBuilder, BasicCheck.ModuleConfigurationBuilder, BasicCheck.ResultAcceptor, BasicCheck.TopObjectConfigurationBuilder, BasicCheck.TopObjectFeatureConfigurationBuilder

Field Summary

Fields

Modifier and Type	Field	Description
protected IFeatureValueCollectingService	collectingService
protected IComputedNameService	computedNameService
protected ITranslationFeatureKeyProvider	featureKeyProvider
protected ITranslatingProjectManager	projectManager
protected IResourceLookup	resourceLookup
protected IFeatureSettingsService	settingsService
protected IStorageSettingsManager	storageSettingsManager
protected IV8ProjectManager	v8ProjectManager

Constructor Summary

Constructors

Constructor	Description
AbstractTranslationValidator()

Method Summary

Modifier and Type	Method	Description
protected void	addNoTranslationMessage(org.eclipse.emf.ecore.EObject object, BasicCheck.ResultAcceptor resultAcceptor, String value, FeatureKey key, FeatureSettings featureSettings, Collection<String> languages)	Adds the message about empty translation for specific languages.
protected void	checkTranslation(org.eclipse.emf.ecore.EObject object, BasicCheck.ResultAcceptor resultAcceptor, ICheckParameters parameters, org.eclipse.core.runtime.IProgressMonitor monitor)
protected void	configureCheck(BasicCheck.CheckConfigurer builder)	The check is performed in case of changes of the tracjed object model/language module changes.
protected org.eclipse.emf.ecore.EStructuralFeature	getMessageFeature(FeatureSettings featureSettings)
protected ICollectingParameters	getParameters(org.eclipse.core.resources.IProject project, ICheckParameters parameters)
protected IProjectTranslationReader	getReader(org.eclipse.core.resources.IProject project)
protected String	getTranslation(org.eclipse.core.resources.IProject project, FeatureValue featureValue, TranslateLanguage language, org.eclipse.emf.ecore.EObject object, BasicCheck.ResultAcceptor resultAcceptor, ICheckParameters parameters)	Gets the translation.
AbstractTranslationValidator.TranslationValidatorContext	prepareContext(Object object, ICheckParameters parameters, org.eclipse.core.runtime.IProgressMonitor progressMonitor)	Prepares context of the check if applicable.

Methods inherited from class com.e1c.g5.v8.dt.check.components.BasicCheck

check, check, check, configureContextCollector, isCheckApplicable, postConfigureContextCollector

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.ICheck

check, getCheckId, prepareContext

Field Details

resourceLookup

@Inject
protected IResourceLookup resourceLookup

storageSettingsManager

@Inject
protected IStorageSettingsManager storageSettingsManager

collectingService

@Inject
protected IFeatureValueCollectingService collectingService

settingsService

@Inject
protected IFeatureSettingsService settingsService

featureKeyProvider

@Inject
protected ITranslationFeatureKeyProvider featureKeyProvider

computedNameService

@Inject
protected IComputedNameService computedNameService

v8ProjectManager

@Inject
protected IV8ProjectManager v8ProjectManager

projectManager

@Inject
protected ITranslatingProjectManager projectManager

Constructor Details

AbstractTranslationValidator

public AbstractTranslationValidator()

Method Details

configureCheck

protected void configureCheck(BasicCheck.CheckConfigurer builder)

Description copied from class: BasicCheck

The check is performed in case of changes of the tracjed object model/language module changes. In order to define the rules of the check performing, the developer should define the set of EClass'es and their features those changes are being tracked/or be targets of the validation

Specified by:

configureCheck in class BasicCheck<AbstractTranslationValidator.TranslationValidatorContext>

prepareContext

public AbstractTranslationValidator.TranslationValidatorContext prepareContext(Object object,
 ICheckParameters parameters,
 org.eclipse.core.runtime.IProgressMonitor progressMonitor)

Description copied from interface: ICheck

Prepares context of the check if applicable. Context may be used to provide commonly used data and facilities, as well as collect data during subsequent calls of the check on the same data subtree

Parameters:

object - The initial object for the check. Usually is a top BM object or top object in the resource. May not be null

parameters - check execution parameters from settings, not null

progressMonitor - progress monitor, not null

Returns:

Context if any. May be null

checkTranslation

protected void checkTranslation(org.eclipse.emf.ecore.EObject object,
 BasicCheck.ResultAcceptor resultAcceptor,
 ICheckParameters parameters,
 org.eclipse.core.runtime.IProgressMonitor monitor)

getTranslation

protected String getTranslation(org.eclipse.core.resources.IProject project,
 FeatureValue featureValue,
 TranslateLanguage language,
 org.eclipse.emf.ecore.EObject object,
 BasicCheck.ResultAcceptor resultAcceptor,
 ICheckParameters parameters)

Gets the translation.

Parameters:

project - the project

featureValue - the feature value

language - the language

object - the object

resultAcceptor - the message acceptor

parameters - the parameters

Returns:

the translation

addNoTranslationMessage

protected void addNoTranslationMessage(org.eclipse.emf.ecore.EObject object,
 BasicCheck.ResultAcceptor resultAcceptor,
 String value,
 FeatureKey key,
 FeatureSettings featureSettings,
 Collection<String> languages)

Adds the message about empty translation for specific languages.

Parameters:

object - the object

resultAcceptor - the message acceptor

value - the value

key - the key

featureSettings -

languages - the languages without translation

getMessageFeature

protected org.eclipse.emf.ecore.EStructuralFeature getMessageFeature(FeatureSettings featureSettings)

getParameters

protected ICollectingParameters getParameters(org.eclipse.core.resources.IProject project,
 ICheckParameters parameters)

getReader

protected IProjectTranslationReader getReader(org.eclipse.core.resources.IProject project)