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

Class QlBasicDelegateCheck

java.lang.Object

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

com.e1c.g5.v8.dt.ql.check.QlBasicDelegateCheck

All Implemented Interfaces:

ITopObjectFilter, ICheck

public abstract class QlBasicDelegateCheck
extends BasicCheck

Basic form QL check. Delelopers should use it to perform easier validations of dynamic list queries

Nested Class Summary

Nested Classes

Modifier and Type	Class	Description
static interface	QlBasicDelegateCheck.IQlResultAcceptor
static class	QlBasicDelegateCheck.QueryOwner	The owner of the query.

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

Constructor Summary

Constructors

Constructor	Description
QlBasicDelegateCheck()

Method Summary

Modifier and Type	Method	Description
protected void	check(Object object, BasicCheck.ResultAcceptor resultAcceptor, ICheckParameters parameters, org.eclipse.core.runtime.IProgressMonitor progressMonitor)	The method that performs the check.
protected abstract void	checkQlObject(org.eclipse.emf.ecore.EObject currentNode, QlBasicDelegateCheck.QueryOwner queryOwner, QlBasicDelegateCheck.IQlResultAcceptor resultAceptor, ICheckParameters parameters, org.eclipse.core.runtime.IProgressMonitor progressMonitor)	Checks the documentation comment model object.
static void	resetOwner()
static void	resetResultAcceptor()
static void	setOwner(QlBasicDelegateCheck.QueryOwner owner)	Internal API
static void	setResultAcceptor(BiFunction<QlBasicDelegateCheck.QueryOwner,BasicCheck.ResultAcceptor,QlBasicDelegateCheck.IQlResultAcceptor> resultAcceptorSupplier)	Internal API

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

check, configureCheck, configureContextCollector, isCheckApplicable

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

getCheckId

Constructor Detail

QlBasicDelegateCheck

public QlBasicDelegateCheck()

Method Detail

resetOwner

public static void resetOwner()

resetResultAcceptor

public static void resetResultAcceptor()

setOwner

public static void setOwner(QlBasicDelegateCheck.QueryOwner owner)

Internal API

Parameters:

owner -

setResultAcceptor

public static void setResultAcceptor(BiFunction<QlBasicDelegateCheck.QueryOwner,BasicCheck.ResultAcceptor,QlBasicDelegateCheck.IQlResultAcceptor> resultAcceptorSupplier)

Internal API

Parameters:

owner -

check

protected final void check(Object object,
                           BasicCheck.ResultAcceptor resultAcceptor,
                           ICheckParameters parameters,
                           org.eclipse.core.runtime.IProgressMonitor progressMonitor)

Description copied from class: BasicCheck

The method that performs the check. Check results (issues) need to be placed into the result acceptor. Validation may be cancelled by a user. Complex implemantations should take this into the account and check IProgressMonitor.isCanceled() periodically during long-running operations.

Specified by:

check in class BasicCheck

Parameters:

object - The object to check, not null

resultAcceptor - Result acceptor, not null

parameters - The set of check execution parameters taken from check settings, not null

progressMonitor - Current check progress monitor, not null

checkQlObject

protected abstract void checkQlObject(org.eclipse.emf.ecore.EObject currentNode,
                                      QlBasicDelegateCheck.QueryOwner queryOwner,
                                      QlBasicDelegateCheck.IQlResultAcceptor resultAceptor,
                                      ICheckParameters parameters,
                                      org.eclipse.core.runtime.IProgressMonitor progressMonitor)

Checks the documentation comment model object. Check developers should implement their main check logic by overriding this method

Parameters:

currentNode - The checked node of the QL model. May not be null

queryOwner - The corresponding object and feature that holds the query/query link. May not be null

resultAceptor - The check's result acceptor. May not be null

parameters - The accessor of the check's parameters. May not be null

progressMonitor - The progress monitor. It should be checked for the cancelling in case of the long/complex checks. May not be null