Package net.simplace.sim.check

Class FWCheckHelper

java.lang.Object

net.simplace.sim.check.FWCheckHelper

public class FWCheckHelper
extends Object

Checks the setting of values and other tasks in the system due to 4 different checking levels. Main idea of the levels is explained in FWCheckHelper.CHECK_LEVEL.

Author:

Andreas Enders

Nested Class Summary

Nested Classes

Modifier and Type	Class	Description
static enum	FWCheckHelper.CHECK_LEVEL

Constructor Summary

Constructors

Constructor	Description
FWCheckHelper(FWCheckHelper.CHECK_LEVEL aLevel, String aCustomCheckerClassName, FWSimSession aSession)

Method Summary

Modifier and Type	Method	Description
void	checkCondition(Boolean aCheckResult, String aMessage, FWSimFieldContainer aInstance)	Called from inside the FWSimFieldContainer to log the initialization Errors.
Number	checkLimits(FWSimVariable<?> aSource, Number aValue, Number aMin, Number aMax)	Returns false if aValue is NaN or outside limits.
boolean	checkOnlyMode(String aSimulationID)
boolean	checkParametersInScript(Collection<String> aAllowedFields, Collection<String> aForbiddenFields, String aJexlScript, FWSimFieldContainer aSource)	Returns false if the content type makes the variable write protected
boolean	checkResource(Map<String,FWSimInputAdapter> aResourceCreators, FWSimVarMap aVarMap, Map<String,FWSimResourceCache> aResourcesCacheMap)
boolean	checkSource(FWSimVariable<?> aTarget, FWSimFieldContainer aSimFieldContainer, FWSimFieldContainer aSource)	Returns false if the owning container: .
boolean	checkWriteProtectionOnContentType(FWSimVariable<?> aTarget, FWSimVariable.CONTENT_TYPE aContentType, FWSimFieldContainer aSource)	Returns false if the content type makes the variable write protected
void	finalize()
FWCheckHelper.CHECK_LEVEL	getCheckLevel()
boolean	isConditionCheck()
void	setCheckLevel(FWCheckHelper.CHECK_LEVEL aCheckLevel)

Methods inherited from class java.lang.Object

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

Constructor Details

FWCheckHelper

public FWCheckHelper(FWCheckHelper.CHECK_LEVEL aLevel,
 String aCustomCheckerClassName,
 FWSimSession aSession)

Parameters:

aLevel -

aCustomCheckerClassName -

aSession -

Method Details

getCheckLevel

public FWCheckHelper.CHECK_LEVEL getCheckLevel()

Returns:

the checkLevel

setCheckLevel

public void setCheckLevel(FWCheckHelper.CHECK_LEVEL aCheckLevel)

Parameters:

aCheckLevel - the checkLevel to set

checkLimits

public Number checkLimits(FWSimVariable<?> aSource,
 Number aValue,
 Number aMin,
 Number aMax)
                   throws SimValueOutOfRangeException

Returns false if aValue is NaN or outside limits. Limits that are null are ignored.

Parameters:

aSource -

aValue -

aMin -

aMax -

Returns:

if limits are checked valid - if level < LAZY no check is performed (return true)

Throws:

SimValueOutOfRangeException

checkSource

public boolean checkSource(FWSimVariable<?> aTarget,
 FWSimFieldContainer aSimFieldContainer,
 FWSimFieldContainer aSource)
                    throws SimLinkInvalidException

Returns false if the owning container: .

Parameters:

aTarget -

aSimFieldContainer - is same as the writing source

aSource -

Returns:

if check is valid - if level < LAZY no check is performed (return true)

Throws:

SimLinkInvalidException

checkWriteProtectionOnContentType

public boolean checkWriteProtectionOnContentType(FWSimVariable<?> aTarget,
 FWSimVariable.CONTENT_TYPE aContentType,
 FWSimFieldContainer aSource)
                                          throws SimLinkInvalidException

Returns false if the content type makes the variable write protected

Parameters:

aTarget -

aContentType -

aSource -

Returns:

if check is valid - if level < LAZY no check is performed (return true)

Throws:

SimLinkInvalidException

checkResource

public boolean checkResource(Map<String,FWSimInputAdapter> aResourceCreators,
 FWSimVarMap aVarMap,
 Map<String,FWSimResourceCache> aResourcesCacheMap)

isConditionCheck

public boolean isConditionCheck()

checkCondition

public void checkCondition(Boolean aCheckResult,
 String aMessage,
 FWSimFieldContainer aInstance)

Called from inside the FWSimFieldContainer to log the initialization Errors.

Parameters:

aCheckResult -

aMessage -

aInstance -

checkOnlyMode

public boolean checkOnlyMode(String aSimulationID)

checkParametersInScript

public boolean checkParametersInScript(Collection<String> aAllowedFields,
 Collection<String> aForbiddenFields,
 String aJexlScript,
 FWSimFieldContainer aSource)

Returns false if the content type makes the variable write protected

Parameters:

aAllowedFields -

aForbiddenFields -

aJexlScript -

aContentType -

aSource -

Returns:

if check is valid - if level < LAZY no check is performed (return true)

finalize

public void finalize()

Overrides:

finalize in class Object