oracle.jbo.rules

Class JboCompareValidator

java.lang.Object

oracle.jbo.common.NamedObjectImpl

oracle.jbo.rules.AbstractValidator

oracle.jbo.rules.JboAbstractValidator

oracle.jbo.rules.JboCompareValidator

All Implemented Interfaces:

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

Direct Known Subclasses:

JboCollectionValidator, JboExprCompareValidator, JboSQLCompareValidator, JboVOCompareValidator, JboVOUsageCompareValidator

public class JboCompareValidator
extends JboAbstractValidator

A validator that tests literal values by comparing them to a pre-defined value, using a pre-defined relation.

The value to be validated is designated as the left-hand operand of a relation operation. The validator provides the right-hand operand and the relation operator.

Since:

Jdeveloper 3.0

Nested Class Summary

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

ValidatorConstants.MessageFlavor

Field Summary

Fields

Modifier and Type	Field and Description
protected java.lang.String	mOperandType
protected int	mOperationType
protected java.lang.String	mRhsAttrName
protected java.lang.Object	mRValue
static int	UNINIT

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

Modifier	Constructor and Description
	JboCompareValidator() Creates an uninitialized compare validator.
protected	JboCompareValidator(boolean inverse, int operType) Creates an partially-initialized compare validator.
	JboCompareValidator(boolean inverse, int operType, java.lang.Object rValue) Creates an initialized compare validator.

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:
JboValidatorHints	applyValidatorPersonalization(JboValidatorHints orgVal)
java.lang.Object	clone()
static int	convertOperType(java.lang.String type) Interprets a string as one of the comparison operator constants defined in this class.
DifferDetails	diffContents(DiffMergeable docDef, DiffMergeable orgDef, DifferDetails difDetails) Performs diff of scalar values.
java.lang.String	getCompareValue()
java.lang.String	getDefXMLElementTag()
java.lang.String	getOperatorTypeString() Converts this validator's comparison operator to its symbolic form.
java.lang.Object	getRhsValue() Gets the right-side operand of this validator's expression.
java.lang.Object	getRhsValue(java.lang.Object src) Gets the right-side operand of this validator's expression.
int	getType() Gets this validator's comparison operator.
java.lang.String	getValidatorSubType()
java.lang.String	getValidatorType()
protected void	initialize(JboValidatorContext evObj)
void	initValidatorProperties(java.util.HashMap props)
void	loadXMLContents(DefElement elem)
void	resolve()
void	setCompareValue(java.lang.String compareValue)
protected void	setNewValue(java.lang.Object newValue) after setting the new value, prepare the comparator to be of same type if it is not already so.
void	setRhsValue(java.lang.Object rhsValue) Sets the right-side operand of this validator's expression.
void	setType(int type) Sets this validator's comparison operator.
void	setValidatorSubType(java.lang.String s)
java.lang.String	toString() Internal: For debugging purposes only.
boolean	validateValue(java.lang.Object value) Validate an object by comparing it with a pre-defined value, using a pre-defined relation.
boolean	validateValue(java.lang.Object value, java.lang.Object rValue)
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

closeObject, createException, editCodeSource, ensureCodeSource, getDefManager, getDefScope, getDefXMLNameSpace, getErrorMsgId, getErrorReportAttrDef, getFullName, getImageLoc, getMessageFlavor, getOperationDefinitions, getOrigObject, getOwnerName, getRowOperationDefinitions, getScriptOperationDefinitions, getScriptRowOperationDefinitions, getTriggeringAttributeDefs, getValidatingAttrDef, getValidatingAttributeName, getValueToValidate, getXMLElementTag, isDynamicCodeSourceEnabled, isForPersonalization, isHintBased, isReadOnly, lookupExprDef, raiseException, setForPersonalization, setHintBased, setInitialized, setMessageFlavor, setOrigObject, setTransient, setValidatingAttribute, setValidatingAttribute, validate, validateMany, 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, getVariableManager, hasErrorMsg, hasValidationCondition, hasVariables, initErrMsgParms, initTriggeringAttributeDefs, isDirty, isMovedToAttrLevel, isNew, isNewRecurse, isSkipWrite, isTransactionLevel, isTransactionLevel, isValidatable, isWriteObject, loadVariables, lookupMessageDef, parseSeverityStr, prepareException, 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, setTransactionLevel, setTriggeringAttributeNames, setTriggerTypeString, setValidatingAttributeName, 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.JboValidatorHints

getName, getTriggeringAttributeNames, isTransactionLevel, setName

Methods inherited from interface oracle.jbo.rules.JboValidatorInterface

getDescription, setDescription

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

Field Detail

UNINIT

public static final int UNINIT

See Also:

Constant Field Values

mOperationType

protected int mOperationType

mRValue

protected java.lang.Object mRValue

mOperandType

protected java.lang.String mOperandType

mRhsAttrName

protected java.lang.String mRhsAttrName

Constructor Detail

JboCompareValidator

public JboCompareValidator()

Creates an uninitialized compare validator.

The methods setType() and setRhsValue() must be invoked before validation can be performed.

JboCompareValidator

protected JboCompareValidator(boolean inverse,
                              int operType)

Creates an partially-initialized compare validator.

The method setRhsValue() must be invoked before validation can be performed.

Parameters:

inverse - if true the logic of this validator's comparison relation is inverted.

operType - this validator's comparison operator; one of the comparison operator constants defined in this class.

JboCompareValidator

public JboCompareValidator(boolean inverse,
                           int operType,
                           java.lang.Object rValue)

Creates an initialized compare validator.

Parameters:

inverse - if true the logic of this validator's comparison relation is inverted.

operType - this validator's comparison operator; one of the comparison operator constants defined in this class.

rValue - this validator's right-hand operand, a reference object containing a literal value.

Method Detail

clone

public java.lang.Object clone()

Overrides:

clone in class JboAbstractValidator

getValidatorSubType

public java.lang.String getValidatorSubType()

Overrides:

getValidatorSubType in class AbstractValidator

setValidatorSubType

public void setValidatorSubType(java.lang.String s)

Overrides:

setValidatorSubType in class AbstractValidator

initialize

protected void initialize(JboValidatorContext evObj)

Overrides:

initialize in class JboAbstractValidator

setNewValue

protected void setNewValue(java.lang.Object newValue)
                    throws java.lang.Exception

after setting the new value, prepare the comparator to be of same type if it is not already so.

Overrides:

setNewValue in class JboAbstractValidator

Parameters:

newValue - either the attribute's value or a value to use to compare in the validator.

Throws:

java.lang.Exception

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

validateValue

public boolean validateValue(java.lang.Object value)

Validate an object by comparing it with a pre-defined value, using a pre-defined relation.

The value parameter is the left-hand operand of this validator's comparison relation. The operator is set by setType() and the right-hand operator is set by setRhsValue().

This method is called by AbstractValidator#vetoableChange().

Specified by:

validateValue in class JboAbstractValidator

Parameters:

value - the object to be validated.

Returns:

true if the relation holds, or false if the relation does not hold or if the operator or an operand is invalid or uninitialized.

validateValue

public boolean validateValue(java.lang.Object value,
                             java.lang.Object rValue)

setType

public void setType(int type)

Sets this validator's comparison operator.

Parameters:

type - one of the comparison operator constants defined in this class.

getType

public int getType()

Gets this validator's comparison operator.

Parameters:

value - the comparison operator previously passed to setType.

resolve

public void resolve()

Overrides:

resolve in class JboAbstractValidator

setRhsValue

public void setRhsValue(java.lang.Object rhsValue)

Sets the right-side operand of this validator's expression.

Parameters:

rhsValue - a reference object containing a literal value.

getRhsValue

public java.lang.Object getRhsValue(java.lang.Object src)

Gets the right-side operand of this validator's expression.

Parameters:

value - the operand previously passed to setRhsValue.

getRhsValue

public java.lang.Object getRhsValue()

Gets the right-side operand of this validator's expression.

Parameters:

value - the operand previously passed to setRhsValue.

toString

public java.lang.String toString()

Internal: For debugging purposes only.

Overrides:

toString in class java.lang.Object

convertOperType

public static int convertOperType(java.lang.String type)

Interprets a string as one of the comparison operator constants defined in this class.

Parameters:

type - a string, the textual name of a comparison operator.

Returns:

a comparison operator constant. An unrecognizable string defaults to EQUALTO.

getOperatorTypeString

public java.lang.String getOperatorTypeString()

Converts this validator's comparison operator to its symbolic form.

Returns:

a comparison symbol. If the comparison operator is uninitialized or invalid the null string is returned.

initValidatorProperties

public void initValidatorProperties(java.util.HashMap props)

Specified by:

initValidatorProperties in interface JboValidatorHints

Overrides:

initValidatorProperties in class AbstractValidator

getCompareValue

public java.lang.String getCompareValue()

setCompareValue

public void setCompareValue(java.lang.String compareValue)

loadXMLContents

public void loadXMLContents(DefElement elem)

Overrides:

loadXMLContents in class JboAbstractValidator

getDefXMLElementTag

public java.lang.String getDefXMLElementTag()

Specified by:

getDefXMLElementTag in interface PersistentDefinition

Overrides:

getDefXMLElementTag in class AbstractValidator

getValidatorType

public java.lang.String getValidatorType()

Overrides:

getValidatorType 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

applyValidatorPersonalization

public JboValidatorHints applyValidatorPersonalization(JboValidatorHints orgVal)

Specified by:

applyValidatorPersonalization in interface JboValidatorHints

Overrides:

applyValidatorPersonalization in class JboAbstractValidator

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