org.openarchitectureware.check
Class CheckComponent

java.lang.Object
  extended by org.openarchitectureware.workflow.lib.AbstractWorkflowComponent
      extended by org.openarchitectureware.workflow.lib.AbstractWorkflowComponent2
          extended by org.openarchitectureware.expression.AbstractExpressionsUsingWorkflowComponent
              extended by org.openarchitectureware.check.CheckComponent
All Implemented Interfaces:
WorkflowComponent, WorkflowComponentWithID

public class CheckComponent
extends AbstractExpressionsUsingWorkflowComponent


Nested Class Summary
 
Nested classes/interfaces inherited from class org.openarchitectureware.expression.AbstractExpressionsUsingWorkflowComponent
AbstractExpressionsUsingWorkflowComponent.Debug, AbstractExpressionsUsingWorkflowComponent.GlobalVarDef
 
Field Summary
 
Fields inherited from class org.openarchitectureware.expression.AbstractExpressionsUsingWorkflowComponent
callback, exceptionHandler, exceptionsOnNullEvaluation, log, metaModels
 
Constructor Summary
CheckComponent()
           
 
Method Summary
 void addCheckFile(java.lang.String checkFile)
          Adds a check file.
protected  void checkConfigurationInternal(Issues issues)
           
 java.lang.String getComponentName()
          Override this method by custom components.
 java.lang.String getLogMessage()
          Returns the log message,
protected  void invokeInternal2(WorkflowContext ctx, ProgressMonitor monitor, Issues issues)
           
 void setAbortOnError(boolean abortOnError)
          Sets if execution should be aborted on error.
 void setEmfAllChildrenSlot(java.lang.String childExpression)
          Sets the expression for the emfAllChildren property.
 void setExpression(java.lang.String expression)
          Sets the expression to check.
 void setWarnIfNothingChecked(boolean warn)
          Sets if a warning should be issued if nothing has been checked.
 
Methods inherited from class org.openarchitectureware.expression.AbstractExpressionsUsingWorkflowComponent
addDebug, addGlobalVarDef, addMetaModel, getExecutionContext, getGlobalVars, getNullEvaluationHandler, getResourceManager, invokeInternal, setCallback, setDumpContext, setExceptionHandler, setExceptionsOnNullEvaluation, setResourceManager, toString
 
Methods inherited from class org.openarchitectureware.workflow.lib.AbstractWorkflowComponent2
checkConfiguration, invoke, setSkipOnErrors
 
Methods inherited from class org.openarchitectureware.workflow.lib.AbstractWorkflowComponent
checkRequiredConfigProperty, getContainer, getId, getLocation, setContainer, setId, setLocation
 
Methods inherited from class java.lang.Object
clone, equals, finalize, getClass, hashCode, notify, notifyAll, toString, wait, wait, wait
 

Constructor Detail

CheckComponent

public CheckComponent()
Method Detail

setAbortOnError

public void setAbortOnError(boolean abortOnError)
Sets if execution should be aborted on error.

Parameters:
abortOnError - If true, the execution is aborted on error, otherwise, the execution is continued normally.

addCheckFile

public void addCheckFile(java.lang.String checkFile)
Adds a check file.

Parameters:
checkFile - the check file

setExpression

public void setExpression(java.lang.String expression)
Sets the expression to check. This property only works for non-EMF based models. For EMF based models, use setEmfAllChildrenSlot(String).

Parameters:
expression - the expression to check

setWarnIfNothingChecked

public void setWarnIfNothingChecked(boolean warn)
Sets if a warning should be issued if nothing has been checked.

Parameters:
warn - If true, a warning is issued in case nothing has been checked, otherwise no warning is issued.

setEmfAllChildrenSlot

public void setEmfAllChildrenSlot(java.lang.String childExpression)
Sets the expression for the emfAllChildren property. This property only works for EMF based models. For all other kinds of models use setExpression(String).

Parameters:
childExpression - the expression

getLogMessage

public java.lang.String getLogMessage()
Description copied from interface: WorkflowComponentWithID
Returns the log message,

Specified by:
getLogMessage in interface WorkflowComponentWithID
Overrides:
getLogMessage in class AbstractWorkflowComponent
Returns:
the log message
See Also:
AbstractWorkflowComponent.getLogMessage()

getComponentName

public java.lang.String getComponentName()
Description copied from class: AbstractWorkflowComponent
Override this method by custom components.

Specified by:
getComponentName in interface WorkflowComponent
Overrides:
getComponentName in class AbstractWorkflowComponent
Returns:
Simple class name as default.
See Also:
WorkflowComponent.getComponentName()

invokeInternal2

protected void invokeInternal2(WorkflowContext ctx,
                               ProgressMonitor monitor,
                               Issues issues)
Overrides:
invokeInternal2 in class AbstractExpressionsUsingWorkflowComponent

checkConfigurationInternal

protected void checkConfigurationInternal(Issues issues)
Overrides:
checkConfigurationInternal in class AbstractExpressionsUsingWorkflowComponent