oracle.jbo.rules

Class AbstractValidator

java.lang.Object

oracle.jbo.common.NamedObjectImpl

oracle.jbo.rules.AbstractValidator

All Implemented Interfaces:

DiffMergeable, ValidatorConstants, VariableManagerOwner, VariableManagerOwnerBase

Direct Known Subclasses:

JboAbstractValidator, JboBaseValidator, JboCustomValidator

public abstract class AbstractValidator
extends NamedObjectImpl
implements VariableManagerOwner, ValidatorConstants, DiffMergeable

The superclass for all pre-defined validators.

This class implements the basic functionality of storing the value of either an attribute to be validated, or the entity or application module reference on which validation is to be invoked. Subclasses must provide validateValue, which performs the actual validation test.

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 boolean	mbInverse
protected java.lang.String	mDescription
protected java.lang.Class	mErrorMessageClass
protected java.lang.String	mMsgId
protected java.util.List<java.lang.String>	mMsgIds
protected java.lang.String	mResourceBundleId
protected java.lang.String[]	mTriggeringAttributeNames
protected AttributeDef[]	mTriggeringAttributes
protected java.lang.String	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

Constructor Summary

Constructors

Constructor and Description
AbstractValidator()

Method Summary

Modifier and Type	Method and Description
void	applyDiffChildren(DifferDetails dif, DiffResolver resolver) Applies changes to children defs.
void	applyDiffContents(DifferDetails dif, DiffResolver resolver) When diff/merge operation is requested, we have the following three def objects:
AbstractValidator	applyValidatorPersonalization(AbstractValidator orgVal)
DifferDetails	beginDiffObjects(DiffMergeable docDef, DiffMergeable orgDef, DifferDetails difDetails) This method is the entry point call when the diffing process begins on the document-level def.
java.lang.Object	clone()
java.lang.Object	convertToJava(AttributeDef attrDef, java.lang.Object val)
void	copyErrorMsgInfo(AbstractValidator val)
protected AttrSetValException	createAttributeException(int objType, ResourceBundleDef resBundleDef, java.lang.String errorCode, java.lang.String objName, java.lang.String attrName, java.lang.Object newValue, java.lang.String methodName, java.lang.Object source) For internal framework use only
ValidationException	createException(java.lang.Exception e, JboValidatorContext evObj, java.lang.String msgId, AttributeDef attrDef, java.lang.Object value, java.lang.String methodName, int severity)
protected ExprValueSupplier	createExprValueSupplier(JboValidatorContext ctx) For internal framework use only
protected RowValException	createRowException(ResourceBundleDef resBundleDef, java.lang.String errorCode, java.lang.String objName, Key key, AttributeDef[] keyCols, java.lang.String methodName, java.lang.Object source) For internal framework use only
DifferDetails	diffChildren(DiffMergeable docDef, DiffMergeable orgDef, DifferDetails difDetails) Performs diff of children defs.
DifferDetails	diffContents(DiffMergeable docDef, DiffMergeable orgDef, DifferDetails difDetails) Performs diff of scalar values.
DifferDetails	diffObjects(DiffMergeable docDef, DiffMergeable orgDef, DifferDetails difDetails) The work-horse method performing diff between two defs of this def type.
DifferDetails	ensureDifferDetails(DifferDetails difDetails) Ensures that we have a valid DifferDetails.
VariableValueManager	ensureVariableManager() Returns this object's Variable Value Manager.
java.lang.String	getDefTypeName() Returns the XML def type name of this defintion object, e.g., "PDefEntityObject".
java.lang.String	getDefXMLElementTag()
java.lang.String	getDescription() Gets the textul description of this validator.
java.lang.Class	getErrorMessageClass()
java.util.Map<java.lang.String,ExpressionDef>	getErrorMsgExpressionDefs()
java.util.Map	getErrorMsgExpressions()
java.lang.String	getErrorMsgId()
java.util.List	getErrorMsgIds()
java.lang.String	getExprIdentifier()
java.lang.String	getExprValueSupplierType()
java.lang.String	getFullName() Gets this object's fully-qualified name.
boolean	getInverse() Reports whether the logic of this validator is inverted.
java.lang.String	getMergeableFullName() Returns the fully qualified name of the diff-mergeable definition object.
java.lang.String	getMergeableName() Returns the diff-mergeable definition's name (short form).
java.lang.Class	getMessageBundleClass()
java.lang.String	getName() Get the name of this object.
java.lang.String	getOnCondition() Deprecated. since 12.2.1. This should not be necessary and may result in a performance issue.
ExprDef	getOnConditionDef()
ValidationManager	getOwner()
ResourceBundleDef	getResourceBundleDef() getResourceBundleDef gets the mResourceBundleDef value
java.lang.String	getResourceBundleId()
int	getSeverity() Returns severity as one of the constants in oracle.jbo.JboWarning : JboWarning.SEVERITY_ERROR , JboWarning.SEVERITY_WARNING, JboWarning.SEVERITY_VETOABLE_WARNING, or JboWarning.SEVERITY_RECOVERABLE_ERROR
AttributeDef[]	getTriggeringAttributeDefs()
java.lang.String[]	getTriggeringAttributeNames()
java.lang.String	getTriggerType()
java.lang.String	getValidatingAttributeName()
java.lang.String	getValidatorSubType()
VariableValueManager	getVariableManager() Returns this object's current Variable Value Manager.
boolean	hasErrorMsg()
protected boolean	hasValidationCondition()
boolean	hasVariables() Returns a flag indicating whether this object has Variables or not.
void	initErrMsgParms(ValidationException valEx, JboValidatorContext evObj, int severity)
void	initTriggeringAttributeDefs(StructureDef strDef)
void	initValidatorProperties(java.util.HashMap props)
boolean	isDirty()
boolean	isMovedToAttrLevel()
boolean	isNew()
boolean	isTransactionLevel()
boolean	isTransactionLevel(JboValidatorContext valCtx)
protected boolean	isValidatable(JboValidatorContext evObj)
void	loadVariables(DefElement xmlElement)
void	loadXMLContents(DefElement elem)
ExprDef	lookupMessageDef(java.lang.String msgName)
static int	parseSeverityStr(java.lang.String severityStr) Advanced internal method.
protected void	prepareException(ValidationException valEx, JboValidatorContext evObj, int severity)
void	raiseException(java.lang.Exception e, JboValidatorContext evObj)
void	raiseException(java.lang.Exception e, JboValidatorContext evObj, java.lang.String msgId, int severity)
protected java.util.ArrayList	readStringArrayList(DefElement rootElem, java.lang.String attrName, java.lang.String arrayName, boolean useNameAttr)
static ExpressionDef	readTransientExpression(NamedObjectImpl parent, DefElement rootElem, java.lang.String elemName) Deprecated. since 11.1.1.4.0 Apps should never be using this implementation method.
static ExpressionDef	readTransientExpression(NamedObjectImpl parent, DefElement rootElem, java.lang.String elemName, OwnerType ownerType) Deprecated. since 11.1.1.4.0 Apps should never be using this implementation method.
java.lang.String	readUserObject(DefElement rootElem, java.lang.String attrName)
java.lang.String	readUserObject(DefElement rootElem, java.lang.String attrName, boolean checkUnique)
java.lang.String	readUserObjectTrim(DefElement rootElem, java.lang.String attrName)
java.lang.String	readUserObjectTrim(DefElement rootElem, java.lang.String attrName, boolean checkUnique)
java.util.HashMap	readUserStringElementsMap(DefElement rootElem, java.lang.String elemName)
void	resolve(ValidationManager owner, StructureDef structDef, PersistableDefObject defObj)
protected void	setDefaultDescription(java.lang.String descId) Sets the textul description of this validator using locale message code.
void	setDescription(java.lang.String description) Sets the textul description of this validator using a specified string.
void	setDirty(boolean b)
void	setErrorMessageClass(java.lang.Class clz)
void	setErrorMsgExpressionDefs(java.util.Map<java.lang.String,ExpressionDef> exprDefs)
void	setErrorMsgExpressions(java.util.Map map)
void	setErrorMsgId(java.lang.String msgId)
void	setErrorMsgIds(java.util.List msgIds)
void	setExprValueSupplierType(java.lang.String s)
void	setInverse(boolean bInverse) Allows the logic of this validator to be inverted.
void	setNew(boolean b)
void	setOnCondition(java.lang.String s)
void	setResourceBundleDef(ResourceBundleDef resourceBundleDef) setResourceBundleDef sets the mResourceBundleDef value
void	setResourceBundleId(java.lang.String bundleId)
void	setSeverity(int severity) severity should be one of the constants in oracle.jbo.JboWarning - one of: JboWarning.SEVERITY_ERROR , JboWarning.SEVERITY_WARNING, JboWarning.SEVERITY_VETOABLE_WARNING, or JboWarning.SEVERITY_RECOVERABLE_ERROR
void	setTransactionLevel(boolean bTransactionLevel)
void	setTriggeringAttributeNames(java.lang.String[] names)
void	setTriggerTypeString(java.lang.String triggerType)
void	setValidatingAttributeName(java.lang.String name)
void	setValidatorSubType(java.lang.String s)
void	writeChildren(DefWriter jos)
void	writeContents(DefWriter jos)

Methods inherited from class oracle.jbo.common.NamedObjectImpl

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

Methods inherited from class java.lang.Object

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

Field Detail

mbInverse

protected boolean mbInverse

mDescription

protected java.lang.String mDescription

mMsgId

protected java.lang.String mMsgId

mMsgIds

protected java.util.List<java.lang.String> mMsgIds

mErrorMessageClass

protected java.lang.Class mErrorMessageClass

mValidatingAttrName

protected java.lang.String mValidatingAttrName

mResourceBundleId

protected java.lang.String mResourceBundleId

mTriggeringAttributeNames

protected java.lang.String[] mTriggeringAttributeNames

mTriggeringAttributes

protected AttributeDef[] mTriggeringAttributes

Constructor Detail

AbstractValidator

public AbstractValidator()

Method Detail

clone

public java.lang.Object clone()

Overrides:

clone in class java.lang.Object

isDirty

public boolean isDirty()

setDirty

public void setDirty(boolean b)

isNew

public boolean isNew()

setNew

public void setNew(boolean b)

getOwner

public ValidationManager getOwner()

getValidatorSubType

public java.lang.String getValidatorSubType()

setValidatorSubType

public void setValidatorSubType(java.lang.String s)

setErrorMessageClass

public void setErrorMessageClass(java.lang.Class clz)

getErrorMessageClass

public java.lang.Class getErrorMessageClass()

getResourceBundleDef

public ResourceBundleDef getResourceBundleDef()

getResourceBundleDef gets the mResourceBundleDef value

Specified by:

getResourceBundleDef in interface VariableManagerOwnerBase

setResourceBundleDef

public void setResourceBundleDef(ResourceBundleDef resourceBundleDef)

setResourceBundleDef sets the mResourceBundleDef value

Parameters:

resourceBundleDef - ResourceBundleDef

convertToJava

public java.lang.Object convertToJava(AttributeDef attrDef,
                                      java.lang.Object val)

setTransactionLevel

public void setTransactionLevel(boolean bTransactionLevel)

isTransactionLevel

public boolean isTransactionLevel()

isTransactionLevel

public boolean isTransactionLevel(JboValidatorContext valCtx)

setInverse

public void setInverse(boolean bInverse)

Allows the logic of this validator to be inverted.

Parameters:

bInverse - true if the validation result is to be inverted, and false if the validation result is not to be inverted.

getInverse

public boolean getInverse()

Reports whether the logic of this validator is inverted.

Returns:

true if the validation result is inverted, and false if the validation result is not inverted.

getDescription

public java.lang.String getDescription()

Gets the textul description of this validator.

Returns:

a documentation string.

setDescription

public void setDescription(java.lang.String description)

Sets the textul description of this validator using a specified string.

Parameters:

description - a documentation string.

setDefaultDescription

protected void setDefaultDescription(java.lang.String descId)

Sets the textul description of this validator using locale message code.

Parameters:

description - a message code.

getErrorMsgId

public java.lang.String getErrorMsgId()

setErrorMsgId

public void setErrorMsgId(java.lang.String msgId)

hasErrorMsg

public boolean hasErrorMsg()

copyErrorMsgInfo

public void copyErrorMsgInfo(AbstractValidator val)

getResourceBundleId

public java.lang.String getResourceBundleId()

setResourceBundleId

public void setResourceBundleId(java.lang.String bundleId)

getErrorMsgIds

public java.util.List getErrorMsgIds()

setErrorMsgIds

public void setErrorMsgIds(java.util.List msgIds)

getErrorMsgExpressionDefs

@Concealed
public java.util.Map<java.lang.String,ExpressionDef> getErrorMsgExpressionDefs()

For internal use only. Application developers should not use this

setErrorMsgExpressionDefs

@Concealed
public void setErrorMsgExpressionDefs(java.util.Map<java.lang.String,ExpressionDef> exprDefs)

For internal use only. Application developers should not use this

getErrorMsgExpressions

public java.util.Map getErrorMsgExpressions()

setErrorMsgExpressions

public void setErrorMsgExpressions(java.util.Map map)

setValidatingAttributeName

public void setValidatingAttributeName(java.lang.String name)

getValidatingAttributeName

public java.lang.String getValidatingAttributeName()

getTriggeringAttributeNames

public java.lang.String[] getTriggeringAttributeNames()

getTriggeringAttributeDefs

public AttributeDef[] getTriggeringAttributeDefs()

setTriggeringAttributeNames

public void setTriggeringAttributeNames(java.lang.String[] names)

getName

public java.lang.String getName()

Description copied from class: NamedObjectImpl

Get the name of this object.

Specified by:

getName in interface VariableManagerOwner

Overrides:

getName in class NamedObjectImpl

Returns:

the name given to this object.

getFullName

public java.lang.String getFullName()

Description copied from class: NamedObjectImpl

Gets this object's fully-qualified name.

Overrides:

getFullName in class NamedObjectImpl

Returns:

this object's fully-qualified name; the package name concatenated with the class name.

getMergeableName

public java.lang.String getMergeableName()

Description copied from interface: DiffMergeable

Returns the diff-mergeable definition's name (short form).

Specified by:

getMergeableName in interface DiffMergeable

Returns:

name of the def object

getMergeableFullName

public java.lang.String getMergeableFullName()

Description copied from interface: DiffMergeable

Returns the fully qualified name of the diff-mergeable definition object. It must uniquely identify the def object.

Specified by:

getMergeableFullName in interface DiffMergeable

Returns:

full name of the def object

hasVariables

public boolean hasVariables()

Description copied from interface: VariableManagerOwnerBase

Returns a flag indicating whether this object has Variables or not.

Specified by:

hasVariables in interface VariableManagerOwnerBase

Returns:

the flag indicating whether this object has Variables.

isMovedToAttrLevel

public boolean isMovedToAttrLevel()

lookupMessageDef

@Concealed
public ExprDef lookupMessageDef(java.lang.String msgName)

For internal use only. Application developers should not use this

getOnConditionDef

@Concealed
public ExprDef getOnConditionDef()

For internal use only. Application developers should not use this

getOnCondition

public java.lang.String getOnCondition()

Deprecated. since 12.2.1. This should not be necessary and may result in a performance issue.

setOnCondition

public void setOnCondition(java.lang.String s)

getTriggerType

@Concealed
public java.lang.String getTriggerType()

For internal use only. Application developers should not use this

setTriggerTypeString

@Concealed
public void setTriggerTypeString(java.lang.String triggerType)

For internal use only. Application developers should not use this

getExprValueSupplierType

public java.lang.String getExprValueSupplierType()

setExprValueSupplierType

public void setExprValueSupplierType(java.lang.String s)

ensureVariableManager

public VariableValueManager ensureVariableManager()

Description copied from interface: VariableManagerOwnerBase

Returns this object's Variable Value Manager. If this object current has no Variable Value Manager, it will initialize (create) one.

Specified by:

ensureVariableManager in interface VariableManagerOwnerBase

Returns:

this object's Variable Value Manager. Will create a Variable Value Manager if this object had no Variable Value Manager.

getVariableManager

public VariableValueManager getVariableManager()

Description copied from interface: VariableManagerOwnerBase

Returns this object's current Variable Value Manager. It will return null if Variable Value Manager has been initialized.

When a framework object is first created, its Variable Value Manager may be null. This method does not initialize (create) the Variable Value Manager.

VariableManagerOwnerBase.ensureVariableManager() in contrast, ensures that the Variable Value Manager is initialized (created).

Specified by:

getVariableManager in interface VariableManagerOwnerBase

Returns:

this object's current Variable Value Manager. May return null if one was not yet initialized.

getMessageBundleClass

public java.lang.Class getMessageBundleClass()

Specified by:

getMessageBundleClass in interface VariableManagerOwnerBase

loadVariables

public void loadVariables(DefElement xmlElement)

initValidatorProperties

public void initValidatorProperties(java.util.HashMap props)

initTriggeringAttributeDefs

public void initTriggeringAttributeDefs(StructureDef strDef)

loadXMLContents

public void loadXMLContents(DefElement elem)

writeChildren

public void writeChildren(DefWriter jos)

writeContents

public void writeContents(DefWriter jos)

getDefXMLElementTag

public java.lang.String getDefXMLElementTag()

getDefTypeName

public java.lang.String getDefTypeName()

Description copied from interface: DiffMergeable

Returns the XML def type name of this defintion object, e.g., "PDefEntityObject".

Specified by:

getDefTypeName in interface DiffMergeable

Returns:

XML def type name

ensureDifferDetails

public DifferDetails ensureDifferDetails(DifferDetails difDetails)

Description copied from interface: DiffMergeable

Ensures that we have a valid DifferDetails.

This method is to create a DifferDetails object to be used for diffing if necessary. The difDetails may come in as null. By calling this method, we can ensure that a non-null difDetails is there. So, instead of writing:

    if (difDetails == null)
    {
       difDetails = new DifferDetails(..);
    }
    difDetails.addDiffDetail(..);
 

we can write

    (difDetails = diffMergeable.ensureDifferDetails(difDetails)).addDiffDetail(..);
 

Specified by:

ensureDifferDetails in interface DiffMergeable

Parameters:

difDetails - the incoming DifferDetails. It may be null.

Returns:

the same difDetails if it wasn't null coming in, or a new DifferDetails if the incoming difDetails was null

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)
    {
        orgDefImpl = () 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

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

diffChildren

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

Description copied from interface: DiffMergeable

Performs diff of children defs. This def should enumerate through all its children and diff them and accumulate details of diff into difDetails and return it at the end.

For example, if this def has Child1 and Child2, its implementation should look something like:

    public DifferDetails diffChildren(DiffMergeable docDef, DiffMergeable orgDef, DifferDetails difDetails)
    {
       difDetails = diffChildrenChild1(docDef, orgDef, difDetails);
       difDetails = diffChildrenChild1(docDef, orgDef, difDetails);

       return difDetails;
    }
 

where diffChildrenChild1() uses DifferChildren's helper method diffChildrenList to diff the child defs.

Specified by:

diffChildren in interface DiffMergeable

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

beginDiffObjects

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

Description copied from interface: DiffMergeable

This method is the entry point call when the diffing process begins on the document-level def. This document-level def may perform its setup or preparation operations and then traverse into nested (children) DiffMergeable's. 'this' object is the changed definition.

Specified by:

beginDiffObjects in interface DiffMergeable

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

diffObjects

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

Description copied from interface: DiffMergeable

The work-horse method performing diff between two defs of this def type. Most typically, it will call diffContents to diff scalar values and diffChildren to diff children objects. The children objects themselves are expected to be DiffMergeable. 'this' object is the changed definition.

Specified by:

diffObjects in interface DiffMergeable

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

Parameters:

dif - changes to be applied to 'this' def

resolver - the diff resolver used in diff/merge operation

applyDiffChildren

public void applyDiffChildren(DifferDetails dif,
                              DiffResolver resolver)

Description copied from interface: DiffMergeable

Applies changes to children defs. dif contains the changes to be applied to the children. For each child def, this method should first retrieve the diff details for the child, which is of type DifferChildren. Then, it should call DifferChildren.applyDiffChanges(oracle.jbo.mom.DiffChildrenMerge, oracle.jbo.mom.DiffResolver) to perform the change operation.

applyChanges() requires a DiffChildrenMerge object, which has the insert, update, and remove methods. 'this' def object must provide implmementation of these operations.

Here is a sample:

    public void applyDiffChildren(DifferDetails dif, DiffResolver resolver)
    {
       DifferChangeMap detailMap = dif.getDetailMap();

       if (detailMap != null)
       {
          DifferChildren difChild1 = (DifferChildren) detailMap.getValue();

          if (difVCs != null)
          {
             DiffChildrenMerge dm = new DiffChildrenMerge()
             {
                public void insertChild(Object id, Object value)
                {
                   .. perform insert op for Child1 ..
                }

                public void updateChild(Object id, Object value, Object oldValue)
                {
                   .. perform update op for Child1 ..
                }

                public void removeChild(Object id)
                {
                   .. perform remove op for Child1 ..
                }
             };

             difChild1.applyDiffChanges(dm, resolver);
          }

          // Similarly for Child2
       }
    }
 

Specified by:

applyDiffChildren in interface DiffMergeable

getExprIdentifier

@Concealed
public java.lang.String getExprIdentifier()

For internal use only. Application developers should not use this

resolve

public void resolve(ValidationManager owner,
                    StructureDef structDef,
                    PersistableDefObject defObj)

setSeverity

public void setSeverity(int severity)

severity should be one of the constants in oracle.jbo.JboWarning - one of: JboWarning.SEVERITY_ERROR , JboWarning.SEVERITY_WARNING, JboWarning.SEVERITY_VETOABLE_WARNING, or JboWarning.SEVERITY_RECOVERABLE_ERROR

getSeverity

public int getSeverity()

Returns severity as one of the constants in oracle.jbo.JboWarning : JboWarning.SEVERITY_ERROR , JboWarning.SEVERITY_WARNING, JboWarning.SEVERITY_VETOABLE_WARNING, or JboWarning.SEVERITY_RECOVERABLE_ERROR

parseSeverityStr

public static int parseSeverityStr(java.lang.String severityStr)

Advanced internal method.

initErrMsgParms

public void initErrMsgParms(ValidationException valEx,
                            JboValidatorContext evObj,
                            int severity)

prepareException

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

createException

public ValidationException createException(java.lang.Exception e,
                                           JboValidatorContext evObj,
                                           java.lang.String msgId,
                                           AttributeDef attrDef,
                                           java.lang.Object value,
                                           java.lang.String methodName,
                                           int severity)

raiseException

public void raiseException(java.lang.Exception e,
                           JboValidatorContext evObj)

raiseException

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

createExprValueSupplier

@Concealed
protected ExprValueSupplier createExprValueSupplier(JboValidatorContext ctx)

For internal framework use only

For internal use only. Application developers should not use this

applyValidatorPersonalization

public AbstractValidator applyValidatorPersonalization(AbstractValidator orgVal)

isValidatable

protected boolean isValidatable(JboValidatorContext evObj)

hasValidationCondition

protected boolean hasValidationCondition()

readUserStringElementsMap

public java.util.HashMap readUserStringElementsMap(DefElement rootElem,
                                                   java.lang.String elemName)

readTransientExpression

public static ExpressionDef readTransientExpression(NamedObjectImpl parent,
                                                    DefElement rootElem,
                                                    java.lang.String elemName)

Deprecated. since 11.1.1.4.0 Apps should never be using this implementation method.

readTransientExpression

public static ExpressionDef readTransientExpression(NamedObjectImpl parent,
                                                    DefElement rootElem,
                                                    java.lang.String elemName,
                                                    OwnerType ownerType)

Deprecated. since 11.1.1.4.0 Apps should never be using this implementation method.

readUserObjectTrim

public java.lang.String readUserObjectTrim(DefElement rootElem,
                                           java.lang.String attrName)

readUserObjectTrim

public java.lang.String readUserObjectTrim(DefElement rootElem,
                                           java.lang.String attrName,
                                           boolean checkUnique)

readUserObject

public java.lang.String readUserObject(DefElement rootElem,
                                       java.lang.String attrName)

readUserObject

public java.lang.String readUserObject(DefElement rootElem,
                                       java.lang.String attrName,
                                       boolean checkUnique)

readStringArrayList

protected java.util.ArrayList readStringArrayList(DefElement rootElem,
                                                  java.lang.String attrName,
                                                  java.lang.String arrayName,
                                                  boolean useNameAttr)

createRowException

@Concealed
protected RowValException createRowException(ResourceBundleDef resBundleDef,
                                                        java.lang.String errorCode,
                                                        java.lang.String objName,
                                                        Key key,
                                                        AttributeDef[] keyCols,
                                                        java.lang.String methodName,
                                                        java.lang.Object source)

For internal framework use only

For internal use only. Application developers should not use this

createAttributeException

@Concealed
protected AttrSetValException createAttributeException(int objType,
                                                                  ResourceBundleDef resBundleDef,
                                                                  java.lang.String errorCode,
                                                                  java.lang.String objName,
                                                                  java.lang.String attrName,
                                                                  java.lang.Object newValue,
                                                                  java.lang.String methodName,
                                                                  java.lang.Object source)

For internal framework use only

For internal use only. Application developers should not use this