oracle.jbo.rules

Class JboMethodValidator

java.lang.Object

oracle.jbo.common.NamedObjectImpl

oracle.jbo.rules.AbstractValidator

oracle.jbo.rules.JboAbstractValidator

oracle.jbo.rules.JboMethodValidator

All Implemented Interfaces:

ComponentOperationsManager, DiffMergeable, DefPersistable, PersistentDefinition, OperationContainer, PropertyManager, JboTransValidatorInterface, JboValidatorHints, JboValidatorInterface, ValidatorConstants, VariableManagerOwner, VariableManagerOwnerBase

public class JboMethodValidator
extends JboAbstractValidator
implements JboTransValidatorInterface

A validator that tests values by passing them to a validation method.

The validation method must be public, take a single Object parameter and return Boolean.

Since:

Jdeveloper 3.0

Nested Class Summary

Nested classes/interfaces inherited from interface oracle.jbo.rules.ValidatorConstants

ValidatorConstants.MessageFlavor

Field Summary

Fields inherited from class oracle.jbo.rules.JboAbstractValidator

mValidatingAttr

Fields inherited from class oracle.jbo.rules.AbstractValidator

mbInverse, mDescription, mErrorMessageClass, mIsObjectResolved, mMsgId, mMsgIds, mResourceBundleId, mTriggeringAttributeNames, mTriggeringAttributes, mValidatingAttrName

Fields inherited from class oracle.jbo.common.NamedObjectImpl

mFullName, mObjName, mParent, mProperties, RES_ID_SUFFIX, RESID_SUFFIX

Fields inherited from interface oracle.jbo.rules.ValidatorConstants

ATTR, ATTR_STR, BETWEEN, EO, EO_STR, EQUALTO, EXPR, EXPR_STR, GREATERTHAN, GREATERTHANEQUALTO, JBO, JBO_STR, LESSTHAN, LESSTHANEQUALTO, LITERAL, LITERAL_STR, MANDATORY_STR, mCompOperTypeVals, mRhsTypeVals, mSeverityVals, NOTEQUALTO, PNAME_CompareLength, PNAME_CompareType, PNAME_CompareValue, PNAME_DataType, PNAME_Description, PNAME_ErrorMessageExpressions, PNAME_ErrorMessageId, PNAME_ErrorMessageIds, PNAME_Exposed, PNAME_ExprValueSupplier, PNAME_ForPersonalization, PNAME_Inverse, PNAME_MessageFlavor, PNAME_Name, PNAME_OnAttribute, PNAME_OnAttributes, PNAME_OnCondition, PNAME_OperandType, PNAME_Severity, PNAME_Subtype, PNAME_TransactionLevel, PNAME_TransientExpression, PNAME_Trigger, PNAME_ValidationBeanClass, PNAME_ValName, PNAME_xmlns, PRECISION_SCALE_STR, SEVERITY_ERROR, SEVERITY_RECOVERABLE_ERROR_INDEX, SEVERITY_VETOABLE_WARNING, SEVERITY_WARNING, SQL, SQL_STR, TRIGGER_SUBTYPE_PREFIX, VALIDATION_XMLNS, VALIDATOR_MSG_ID_PREFIX, VO, VO_STR, VO_USAGE, VO_USAGE_STR

Fields inherited from interface oracle.jbo.mom.xml.DefPersistable

FLAG_DIRTY, FLAG_EDITABLE, FLAG_FROM_TIP, FLAG_LOAD_BASE, FLAG_LOAD_HL_DEFS, FLAG_MAJOR_VERSION_CHANGED, FLAG_MINOR_VERSION_CHANGED, FLAG_NEW, FLAG_NEW_RECURSE, FLAG_SKIP_WRITE, XML_STATEMENT

Constructor Summary

Constructors

Constructor and Description
JboMethodValidator() Creates a validator without assigning its validation method.
JboMethodValidator(java.lang.String methodName, java.lang.Class entityClz, java.lang.Class clz) Creates a validator given the name of the validation method.

Method Summary

Modifier and Type	Method and Description
void	applyDiffContents(DifferDetails dif, DiffResolver resolver) When diff/merge operation is requested, we have the following three def objects:
java.lang.Object	clone()
DifferDetails	diffContents(DiffMergeable docDef, DiffMergeable orgDef, DifferDetails difDetails) Performs diff of scalar values.
java.lang.String	getDefXMLElementTag()
java.lang.String	getErrorMsgId()
java.lang.reflect.Method	getMethod() Gets the method invoked by this validator.
java.lang.String	getMethodName() Gets the name of the method invoked by this validator.
void	initValidatorProperties(java.util.HashMap props)
void	loadXMLContents(DefElement elem)
protected void	prepareException(ValidationException valEx, JboValidatorContext evObj, int severity)
void	raiseException(java.lang.Exception e, JboValidatorContext evObj, java.lang.String msgId, int severity)
void	setMethodName(java.lang.String mthName) Sets the name of the method invoked by this validator.
void	setObjectMethod(java.lang.Class entityClz, java.lang.Class attrClaz) This implementation finds the given method in the given object and stores the Method reference for invocation by validateValue.
void	setTransactionLevel(boolean bTransactionLevel)
java.lang.String	toString() Internal: For debugging purposes only.
void	validateMany(java.util.ArrayList valCtxs)
boolean	validateValue(java.lang.Object value) Validates a value.
boolean	validateValueWithContext(JboValidatorContext evObj, java.lang.Object value) Called internally by the framework with validation OnCondition is true or there is no validation OnCondition.
void	writeContents(DefWriter jos) Objects should write their persistence output in this method

Methods inherited from class oracle.jbo.rules.JboAbstractValidator

applyValidatorPersonalization, closeObject, createException, editCodeSource, ensureCodeSource, getDefManager, getDefScope, getDefXMLNameSpace, getErrorReportAttrDef, getFullName, getImageLoc, getMessageFlavor, getOperationDefinitions, getOrigObject, getOwnerName, getRowOperationDefinitions, getScriptOperationDefinitions, getScriptRowOperationDefinitions, getTriggeringAttributeDefs, getValidatingAttrDef, getValidatingAttributeName, getValidatorType, getValueToValidate, getXMLElementTag, initialize, isDynamicCodeSourceEnabled, isForPersonalization, isHintBased, isReadOnly, lookupExprDef, resolve, setForPersonalization, setHintBased, setInitialized, setMessageFlavor, setNewValue, setOrigObject, setTransient, setValidatingAttribute, setValidatingAttribute, validate, writeObject

Methods inherited from class oracle.jbo.rules.AbstractValidator

applyDiffChildren, applyValidatorPersonalization, beginDiffObjects, convertToJava, copyErrorMsgInfo, createAttributeException, createExprValueSupplier, createRowException, diffChildren, diffObjects, ensureDifferDetails, ensureVariableManager, getDefTypeName, getDescription, getErrorMessageClass, getErrorMsgExpressionDefs, getErrorMsgExpressions, getErrorMsgIds, getExprIdentifier, getExprValueSupplierType, getIdentificationAttributeName, getInverse, getMergeableFullName, getMergeableName, getMessageBundleClass, getName, getOnCondition, getOnConditionDef, getOwner, getResourceBundleDef, getResourceBundleId, getSeverity, getTriggeringAttributeNames, getTriggerType, getValidatorSubType, getVariableManager, hasErrorMsg, hasValidationCondition, hasVariables, initErrMsgParms, initTriggeringAttributeDefs, isDirty, isMovedToAttrLevel, isNew, isNewRecurse, isSkipWrite, isTransactionLevel, isTransactionLevel, isValidatable, isWriteObject, loadVariables, lookupMessageDef, parseSeverityStr, raiseException, readStringArrayList, readTransientExpression, readTransientExpression, readUserObject, readUserObject, readUserObjectTrim, readUserObjectTrim, readUserStringElementsMap, setDefaultDescription, setDescription, setDirty, setErrorMessageClass, setErrorMsgExpressionDefs, setErrorMsgExpressions, setErrorMsgId, setErrorMsgIds, setExprValueSupplierType, setInverse, setName, setNew, setNewRecurse, setOnCondition, setOnConditionDef, setOwner, setResourceBundleDef, setResourceBundleId, setSeverity, setSkipWrite, setTriggeringAttributeNames, setTriggerTypeString, setValidatingAttributeName, setValidatorSubType, writeChildren

Methods inherited from class oracle.jbo.common.NamedObjectImpl

allocatePropertyMap, getAllProperties, getParent, getProperties, getPropertiesAsStrings, getPropertiesMap, getProperty, getProperty, getPropertyExpressionDef, getPropertyExpressionsMap, getPropertyExprEval, getPropertyMap, getPropertyNamesSet, getRawPropertyValue, getResourcesFromBundle, getStringFromMessageBundle, hasProperty, isPropertyExpression, mergePropertyMap, refreshProperty, removeProperty, removeProperty, requiresNamePrefixedResId, resolveObjectProperty, resolvePropertyRaw, setFullName, setParent, setPropertiesMap, setPropertiesMap2, setProperty, setProperty, setPropertyExpression, setPropertyExpressionMap, setPropertyMap, setRawPropertyValue

Methods inherited from class java.lang.Object

equals, finalize, getClass, hashCode, notify, notifyAll, wait, wait, wait

Methods inherited from interface oracle.jbo.rules.JboValidatorInterface

getDescription, setDescription, validate

Methods inherited from interface oracle.jbo.rules.JboValidatorHints

getName, getTriggeringAttributeNames, isTransactionLevel, setName

Methods inherited from interface oracle.jbo.mom.xml.DefPersistable

isDirty, isNew, isNewRecurse, isSkipWrite, isWriteObject, setDirty, setNew, setNewRecurse, setSkipWrite

Methods inherited from interface oracle.jbo.mom.xml.PersistentDefinition

getIdentificationAttributeName, writeChildren

Methods inherited from interface oracle.jbo.PropertyManager

getProperty, removeProperty, setProperty

Constructor Detail

JboMethodValidator

public JboMethodValidator()

Creates a validator without assigning its validation method.

JboMethodValidator

public JboMethodValidator(java.lang.String methodName,
                          java.lang.Class entityClz,
                          java.lang.Class clz)

Creates a validator given the name of the validation method.

Parameters:

methodName - the name of a Java method. The method must be public, take a single Object parameter and return Boolean.

Method Detail

clone

public java.lang.Object clone()

Overrides:

clone in class JboAbstractValidator

setObjectMethod

public void setObjectMethod(java.lang.Class entityClz,
                            java.lang.Class attrClaz)

This implementation finds the given method in the given object and stores the Method reference for invocation by validateValue.

prepareException

@Concealed
protected void prepareException(ValidationException valEx,
                                           JboValidatorContext evObj,
                                           int severity)

Overrides:

prepareException in class AbstractValidator

For internal use only. Application developers should not use this

getErrorMsgId

public java.lang.String getErrorMsgId()

Overrides:

getErrorMsgId in class JboAbstractValidator

validateMany

public void validateMany(java.util.ArrayList valCtxs)

Specified by:

validateMany in interface JboTransValidatorInterface

Overrides:

validateMany in class JboAbstractValidator

validateValueWithContext

public boolean validateValueWithContext(JboValidatorContext evObj,
                                        java.lang.Object value)

Description copied from class: JboAbstractValidator

Called internally by the framework with validation OnCondition is true or there is no validation OnCondition. This method should not be directly invoked in applications.

Overrides:

validateValueWithContext in class JboAbstractValidator

raiseException

public void raiseException(java.lang.Exception e,
                           JboValidatorContext evObj,
                           java.lang.String msgId,
                           int severity)

Overrides:

raiseException in class JboAbstractValidator

validateValue

public boolean validateValue(java.lang.Object value)

Description copied from class: JboAbstractValidator

Validates a value.

Subclasses must implement this method.

Specified by:

validateValue in class JboAbstractValidator

Parameters:

value - the object to be validated.

Returns:

true if the object is valid.

setMethodName

public void setMethodName(java.lang.String mthName)

Sets the name of the method invoked by this validator.

Parameters:

mthName - the name of a Java method. The method must be public, take a single Object parameter and return Boolean.

getMethodName

public java.lang.String getMethodName()

Gets the name of the method invoked by this validator.

Returns:

the name of a Java method.

getMethod

public java.lang.reflect.Method getMethod()

Gets the method invoked by this validator.

Returns:

a method object, a description of a Java method.

setTransactionLevel

public void setTransactionLevel(boolean bTransactionLevel)

Overrides:

setTransactionLevel in class AbstractValidator

toString

public java.lang.String toString()

Internal: For debugging purposes only.

Overrides:

toString in class java.lang.Object

initValidatorProperties

public void initValidatorProperties(java.util.HashMap props)

Specified by:

initValidatorProperties in interface JboValidatorHints

Overrides:

initValidatorProperties in class AbstractValidator

getDefXMLElementTag

public java.lang.String getDefXMLElementTag()

Specified by:

getDefXMLElementTag in interface PersistentDefinition

Overrides:

getDefXMLElementTag in class AbstractValidator

loadXMLContents

public void loadXMLContents(DefElement elem)

Overrides:

loadXMLContents in class JboAbstractValidator

writeContents

public void writeContents(DefWriter jos)

Description copied from interface: PersistentDefinition

Objects should write their persistence output in this method

Specified by:

writeContents in interface PersistentDefinition

Overrides:

writeContents in class JboAbstractValidator

Parameters:

jos - the Output storage for persistence

diffContents

public DifferDetails diffContents(DiffMergeable docDef,
                                  DiffMergeable orgDef,
                                  DifferDetails difDetails)

Description copied from interface: DiffMergeable

Performs diff of scalar values. Typically, scalar attr values are grouped into String, int, and boolean arrays -- one set coming from 'this' definition and the other set coming from orgDef. Then, help methods on DifferBase can be used to diff the attr values and accumulate the details of diff in difDetails.

Here is example code snippet:

    private static final String DIFF_STRING_ELEMS[] =
    {
       "MyStringVal1",
       "MyStringVal2"
    };

    private static final String DIFF_INT_ELEMS[] =
    {
       "MyIntVal",
    }

    public DifferDetails diffContents(DiffMergeable docDef, DiffMergeable orgDef, DifferDetails difDetails)
    {
       <Your-def-class> orgDefImpl = (<Your-def-class>) orgDef;

       final String editStringValues[] =
       {
          this.getMyStringVal1(),
          this.getMyStringVal2()
       };

       String orgStringValues[] = null;

       if (orgDef != null)
       {
          String orgV[] =
          {
             orgDefImpl.getMyStringVal1(),
             orgDefImpl.getMyStringVal2()
          };

          orgStringValues = orgV;
       }

       final int editIntValues[] =
       {
          this.getMyIntVal(),
       };

       int orgIntValues[] = null;

       if (orgDef != null)
       {
          int orgV[] =
          {
             orgDefImpl.getMyIntVal()
          };

          orgIntValues = orgV;
       }

       difDetails = DifferBase.diffStringArray(this, DIFF_STRING_ELEMS, editStringValues, orgStringValues, difDetails);
       difDetails = DifferBase.diffIntArray(this, DIFF_INT_ELEMS, editIntValues, orgIntValues, difDetails);

       return difDetails;
   }
 

Specified by:

diffContents in interface DiffMergeable

Overrides:

diffContents in class JboAbstractValidator

Parameters:

docDef - the document-level definition

orgDef - the original definition. It could be null if the definition did not exist originally

difDetails - the DifferDetails that accumulate the details of diff from the document-level (top-level) def

Returns:

the DifferDetails that has all the details of diff

applyDiffContents

public void applyDiffContents(DifferDetails dif,
                              DiffResolver resolver)

Description copied from interface: DiffMergeable

When diff/merge operation is requested, we have the following three def objects:

orgDef - original def object (from the branch point) editDef - def object into which changes are to be merge toMergeDef - def object to be merged (source of changes) For sandbox refresh operation, orgDef comes from the branch point, editDef from the sandbox, toMergeDef from the mainline of the repos. With these three defs, we first diff editDef against orgDef, producing editDifDetails.

Similarly, toMergeDef is diffed against orgDef, producing toMergeDifDetails. The diff engine then walks through these two sets of diffs and identifies conflicts. After the conflicts are all resolved, we apply appropriate changes to editDef.

applyDiffContents is called to apply changes to scalar values. dif contains the changed values to be applied to 'this' object. Use sample code like the following:

    public void applyDiffContents(DifferDetails dif, DiffResolver resolver)
    {
       DifferChangeMap detailMap = dif.getDetailMap();
       Object[] updValues;

       // DIFF_STRING_ELEMS from the above example code
       for (int j = 0; j < DIFF_STRING_ELEMS.length; j++)
       {
          if ((updValues = (Object[]) detailMap.getValue(DIFF_STRING_ELEMS[j])) != null)
          {
             switch(j)
             {
             case 0:
                setMyStringVal1((String) updValues[0]);
                break;
             case 1:
                 setMyStringVal2((String) updValues[0]);
                break;
             }
          }
       }

       for (int j = 0; j < DIFF_INT_ELEMS.length; j++)
       {
          if ((updValues = (Object[]) detailMap.getValue(DIFF_INT_ELEMS[j])) != null)
          {
             switch(j)
             {
             case 0:
                setMyIntVal((Integer) updValues[0]);
                break;
             }
          }
       }
    }
 

Notice that the index specified in the case statement is the array index of the attr in the String, int, or boolean array.

Specified by:

applyDiffContents in interface DiffMergeable

Overrides:

applyDiffContents in class AbstractValidator

Parameters:

dif - changes to be applied to 'this' def

resolver - the diff resolver used in diff/merge operation