oracle.jbo.rules

Class JboLengthValidator

java.lang.Object

oracle.jbo.common.NamedObjectImpl

oracle.jbo.rules.AbstractValidator

oracle.jbo.rules.JboAbstractValidator

oracle.jbo.rules.JboLengthValidator

All Implemented Interfaces:

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

public class JboLengthValidator
extends JboAbstractValidator

A validator that tests the length of the attribute values by comparing them with a pre-defined length value.

The length to be validated is designated as the left-hand operand of a relation operation. The validator provides the right-hand operand, the comparison datatype 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
static int	BETWEEN
static int	BYTE
static int	CHARACTER
static java.lang.String[]	dataTypeVals
static int	EQUALTO
static int	GREATERTHAN
static int	GREATERTHANEQUALTO
static int	LESSTHAN
static int	LESSTHANEQUALTO
protected int	mDataType
protected int	mMaxLength
protected int	mMinLength
protected int	mOperType
static java.lang.String[]	operTypeVals
protected java.lang.Object	rhsValue

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, EO, EO_STR, EXPR, EXPR_STR, JBO, JBO_STR, 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
JboLengthValidator() Creates an uninitialized length validator.
JboLengthValidator(boolean propBased)
JboLengthValidator(boolean inverse, int operType, int dataType, java.lang.Object rhsValue) Creates an initialized length 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 int	convertDataType(java.lang.String typeArg) Interprets a string as one of the comparison datatype constants defined in this class.
static int	convertOperType(java.lang.String typeArg) 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.
int	getDataType() Gets this validator's comparison datatype.
java.lang.String	getDefXMLElementTag()
int	getMaxLength()
int	getMinLength()
java.lang.String	getOperatorTypeString() Converts this validator's comparison operator to its symbolic form.
int	getOperType() Gets this validator's comparison operator.
java.lang.Object	getRhsValue() Gets the right-side operand of this validator's expression.
protected void	initialize(JboValidatorContext evObj)
void	initValidatorProperties(java.util.HashMap props)
void	loadXMLContents(DefElement elem)
static int	parseOperatorTypeStr(java.lang.String str)
void	setDataType(int typeArg) Sets this validator's comparison datatype.
void	setMaxLength(int maxLength)
void	setMinLength(int minLength)
void	setOperType(int typeArg) Sets this validator's comparison operator.
void	setRhsValue(java.lang.Object rhsValueArg) Sets the right-side operand of this validator's expression.
java.lang.String	toString() Internal: For debugging purposes only.
boolean	validateValue(java.lang.Object value) Validate an object by comparing its length with a pre-defined length 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, getErrorMsgId, getErrorReportAttrDef, getFullName, getImageLoc, getMessageFlavor, getOperationDefinitions, getOrigObject, getOwnerName, getRowOperationDefinitions, getScriptOperationDefinitions, getScriptRowOperationDefinitions, getTriggeringAttributeDefs, getValidatingAttrDef, getValidatingAttributeName, getValidatorType, getValueToValidate, getXMLElementTag, isDynamicCodeSourceEnabled, isForPersonalization, isHintBased, isReadOnly, lookupExprDef, raiseException, resolve, setForPersonalization, setHintBased, setInitialized, setMessageFlavor, setNewValue, 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, getValidatorSubType, 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, 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.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

EQUALTO

public static final int EQUALTO

See Also:

Constant Field Values

LESSTHAN

public static final int LESSTHAN

See Also:

Constant Field Values

GREATERTHAN

public static final int GREATERTHAN

See Also:

Constant Field Values

LESSTHANEQUALTO

public static final int LESSTHANEQUALTO

See Also:

Constant Field Values

GREATERTHANEQUALTO

public static final int GREATERTHANEQUALTO

See Also:

Constant Field Values

BETWEEN

public static final int BETWEEN

See Also:

Constant Field Values

operTypeVals

public static final java.lang.String[] operTypeVals

dataTypeVals

public static final java.lang.String[] dataTypeVals

CHARACTER

public static final int CHARACTER

See Also:

Constant Field Values

BYTE

public static final int BYTE

See Also:

Constant Field Values

mOperType

protected int mOperType

mDataType

protected int mDataType

rhsValue

protected java.lang.Object rhsValue

mMinLength

protected int mMinLength

mMaxLength

protected int mMaxLength

Constructor Detail

JboLengthValidator

public JboLengthValidator()

Creates an uninitialized length validator.

The methods setOperType() ,setDataType() and setRhsValue() must be invoked before validation can be performed.

JboLengthValidator

public JboLengthValidator(boolean propBased)

JboLengthValidator

public JboLengthValidator(boolean inverse,
                          int operType,
                          int dataType,
                          java.lang.Object rhsValue)

Creates an initialized length 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.

dataType - this validator's comparison datatype; one of the datatype constants defined in this class.

rhsValue - this validator's right-hand operand, a reference object containing a numeric value.

Method Detail

clone

public java.lang.Object clone()

Overrides:

clone in class JboAbstractValidator

initialize

protected void initialize(JboValidatorContext evObj)

Overrides:

initialize in class JboAbstractValidator

validateValue

public boolean validateValue(java.lang.Object value)

Validate an object by comparing its length with a pre-defined length value.

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

This method is called by AbstractValidator#vetoableChange().

Specified by:

validateValue in class JboAbstractValidator

Parameters:

value - the object whose length is 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.

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

setOperType

public void setOperType(int typeArg)

Sets this validator's comparison operator.

Parameters:

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

getOperType

public int getOperType()

Gets this validator's comparison operator.

Parameters:

value - the comparison operator previously passed to setOperType.

setDataType

public void setDataType(int typeArg)

Sets this validator's comparison datatype.

Parameters:

typeArg - one of the datatype constants defined in this class.

getDataType

public int getDataType()

Gets this validator's comparison datatype.

Parameters:

value - the comparison datatype previously passed to setDataType.

setRhsValue

public void setRhsValue(java.lang.Object rhsValueArg)

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

Parameters:

rhsValueArg - a reference object containing a numeric value.

getRhsValue

public java.lang.Object getRhsValue()

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

Parameters:

value - the operand previously passed to setRhsValue.

getMinLength

public int getMinLength()

setMinLength

public void setMinLength(int minLength)

getMaxLength

public int getMaxLength()

setMaxLength

public void setMaxLength(int maxLength)

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

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

Parameters:

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

Returns:

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

convertDataType

public static int convertDataType(java.lang.String typeArg)

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

Parameters:

typeArg - a string, the textual name of a comparison datatype.

Returns:

a comparison datatype constant. An unrecognizable string defaults to CHARACTER.

parseOperatorTypeStr

public static int parseOperatorTypeStr(java.lang.String str)

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

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

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