oracle.jbo.rules

Class JboListValidator

java.lang.Object

oracle.jbo.common.NamedObjectImpl

oracle.jbo.rules.AbstractValidator

oracle.jbo.rules.JboAbstractValidator

oracle.jbo.rules.JboListValidator

All Implemented Interfaces:

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

Direct Known Subclasses:

JboSQLListValidator, JboVOListValidator, JboVOUsageListValidator

public class JboListValidator
extends JboAbstractValidator

A validator that tests for the presence of a literal value in a list of pre-defined values.

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.Object	mSource Deprecated.

Fields inherited from class oracle.jbo.rules.JboAbstractValidator

mValidatingAttr

Fields inherited from class oracle.jbo.rules.AbstractValidator

mbInverse, mDescription, mErrorMessageClass, 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

XML_STATEMENT

Constructor Summary

Constructors

Constructor and Description
JboListValidator() Creates an uninitialized list validator.
JboListValidator(boolean bInverse)
JboListValidator(boolean inverse, java.util.Vector vec) Creates a list 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:
java.lang.Object	clone()
static java.util.Vector	convertToVector(java.lang.String listVal) Converts a string representation of values to a vector.
DifferDetails	diffContents(DiffMergeable docDef, DiffMergeable orgDef, DifferDetails difDetails) Performs diff of scalar values.
protected boolean	doValidateValue(java.lang.Object value, java.lang.Object source)
java.lang.String	getDefXMLElementTag()
java.util.Vector	getList() Deprecated. Replaced by getList(Object).
java.util.Vector	getList(java.lang.Object source)
java.lang.String	getValidatorSubType()
protected void	initialize(JboValidatorContext evObj)
void	initValidatorProperties(java.util.HashMap props)
void	loadXMLContents(DefElement elem)
void	setList(java.util.Vector vec) Sets this validator's list of comparison values.
java.lang.String	toString() Internal: For debugging purposes only.
boolean	validateValue(java.lang.Object value) Deprecated. Replaced by validateValueWithContext(JboValidatorContext, Object).
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	writeChildren(DefWriter jos) Writes the Object's children to the Persistent storage

Methods inherited from class oracle.jbo.rules.JboAbstractValidator

applyValidatorPersonalization, closeObject, createException, editCodeSource, ensureCodeSource, getDefXMLNameSpace, getErrorMsgId, getErrorReportAttrDef, getFullName, getImageLoc, getMessageFlavor, getName, getOperationDefinitions, getOrigObject, getRowOperationDefinitions, getTriggeringAttributeDefs, getValidatingAttributeName, getValidatorType, getValueToValidate, getXMLElementTag, isForPersonalization, isReadOnly, lookupExprDef, raiseException, resolve, setForPersonalization, setInitialized, setMessageFlavor, setName, setNewValue, setOrigObject, setValidatingAttribute, setValidatingAttribute, validate, validateMany, writeContents, 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, getInverse, getMergeableFullName, getMergeableName, getMessageBundleClass, getOnCondition, getOnConditionDef, getOwner, getResourceBundleDef, getResourceBundleId, getSeverity, getTriggeringAttributeNames, getTriggerType, getVariableManager, hasErrorMsg, hasValidationCondition, hasVariables, initErrMsgParms, initTriggeringAttributeDefs, isDirty, isMovedToAttrLevel, isNew, isTransactionLevel, isTransactionLevel, isValidatable, loadVariables, lookupMessageDef, parseSeverityStr, prepareException, raiseException, readStringArrayList, readTransientExpression, readTransientExpression, readUserObject, readUserObject, readUserObjectTrim, readUserObjectTrim, readUserStringElementsMap, setDefaultDescription, setDescription, setDirty, setErrorMessageClass, setErrorMsgExpressionDefs, setErrorMsgExpressions, setErrorMsgId, setErrorMsgIds, setExprValueSupplierType, setInverse, setNew, setOnCondition, setResourceBundleDef, setResourceBundleId, setSeverity, setTransactionLevel, setTriggeringAttributeNames, setTriggerTypeString, setValidatingAttributeName, setValidatorSubType

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, setParent, setPropertiesMap, setPropertiesMap2, setProperty, setProperty, setPropertyExpression, setPropertyMap

Methods inherited from class java.lang.Object

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

Methods inherited from interface oracle.jbo.rules.JboValidatorHints

getTriggeringAttributeNames, isTransactionLevel

Methods inherited from interface oracle.jbo.rules.JboValidatorInterface

getDescription, setDescription

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

isDirty, isNew, setDirty, setNew

Field Detail

mSource

@Deprecated
protected java.lang.Object mSource

Deprecated.

This field is deprecated and should not be used. The source should be passed in validateValueWithContext(JboValidatorContext, Object).

Constructor Detail

JboListValidator

public JboListValidator()

Creates an uninitialized list validator.

Invoke setList() to provide a list of comparison values.

JboListValidator

public JboListValidator(boolean bInverse)

JboListValidator

public JboListValidator(boolean inverse,
                        java.util.Vector vec)

Creates a list validator.

Parameters:

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

vec - a list of comparison values.

Method Detail

clone

public java.lang.Object clone()

Overrides:

clone in class JboAbstractValidator

getValidatorSubType

public java.lang.String getValidatorSubType()

Overrides:

getValidatorSubType in class AbstractValidator

initialize

protected void initialize(JboValidatorContext evObj)

Overrides:

initialize 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

validateValue

@Deprecated
public boolean validateValue(java.lang.Object value)

Deprecated. Replaced by validateValueWithContext(JboValidatorContext, Object).

Validate that an object is present in a list of values.

The list of test values is set by setList.

This method is called by AbstractValidator#vetoableChange().

Specified by:

validateValue in class JboAbstractValidator

Parameters:

value - the object to be validated.

Returns:

true if value is in this validator's list of values.

doValidateValue

protected boolean doValidateValue(java.lang.Object value,
                                  java.lang.Object source)

setList

public void setList(java.util.Vector vec)

Sets this validator's list of comparison values.

Parameters:

vec - a list of values.

getList

public java.util.Vector getList(java.lang.Object source)

getList

@Deprecated
public java.util.Vector getList()

Deprecated. Replaced by getList(Object).

This method is deprecated and should not be used.

toString

public java.lang.String toString()

Internal: For debugging purposes only.

Overrides:

toString in class java.lang.Object

convertToVector

public static java.util.Vector convertToVector(java.lang.String listVal)

Converts a string representation of values to a vector.

Parameters:

listVal - a string containing values separated by ":" characters.

initValidatorProperties

public void initValidatorProperties(java.util.HashMap props)

Specified by:

initValidatorProperties in interface JboValidatorHints

Overrides:

initValidatorProperties in class AbstractValidator

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

writeChildren

public void writeChildren(DefWriter jos)

Description copied from interface: PersistentDefinition

Writes the Object's children to the Persistent storage

Specified by:

writeChildren in interface PersistentDefinition

Overrides:

writeChildren in class AbstractValidator

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)
    {
        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

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