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:

DefPersistable, PersistentDefinition, 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

Field Summary

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, mMsgExpr, mMsgId, mMsgIds, mResourceBundleId, mTriggeringAttributeNames, mTriggeringAttributes, mValidatingAttrName

Fields inherited from class oracle.jbo.common.NamedObjectImpl

mFullName, mObjName, mParent, mProperties, RES_ID_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_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, SEVERITY_VETOABLE_WARNING, SEVERITY_WARNING, SQL, SQL_STR, 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

	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

JboValidatorHints	applyValidatorPersonalization(JboValidatorHints orgVal)
static int	convertOperType(java.lang.String type) Interprets a string as one of the comparison operator constants defined in this class.
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)
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.
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

clone, closeObject, getDefXMLNameSpace, getErrorMsgId, getErrorReportAttrDef, getFullName, getImageLoc, getName, getOrigObject, getTriggeringAttributeDefs, getValidatingAttributeName, getValueToValidate, getXMLElementTag, isForPersonalization, isReadOnly, raiseException, resolve, setForPersonalization, setInitialized, setName, setOrigObject, setValidatingAttribute, setValidatingAttribute, validate, validateMany, writeObject

Methods inherited from class oracle.jbo.rules.AbstractValidator

applyValidatorPersonalization, convertToJava, copyErrorMsgInfo, createException, createExprValueSupplier, ensureVariableManager, getDescription, getErrorMessageClass, getErrorMsgExpressions, getErrorMsgIds, getExprValueSupplierType, getInverse, getMessageBundleClass, getOnCondition, getOwner, getResourceBundleDef, getResourceBundleId, getSeverity, getTriggeringAttributeNames, getVariableManager, hasErrorMsg, hasValidationCondition, hasVariables, initErrMsgParms, initTriggeringAttributeDefs, isDirty, isMovedToAttrLevel, isNew, isTransactionLevel, isTransactionLevel, isValidatable, loadVariables, parseSeverityStr, prepareException, raiseException, readStringArrayList, readTransientExpression, readUserObject, readUserObject, readUserObjectTrim, readUserObjectTrim, readUserStringElementsMap, setDefaultDescription, setDescription, setDirty, setErrorMessageClass, setErrorMsgExpressions, setErrorMsgId, setErrorMsgIds, setExprValueSupplierType, setInverse, setNew, setOnCondition, setResourceBundleDef, setResourceBundleId, setSeverity, setTransactionLevel, setTriggeringAttributeNames, setValidatingAttributeName, writeChildren

Methods inherited from class oracle.jbo.common.NamedObjectImpl

allocatePropertyMap, getAllProperties, getParent, getProperties, getPropertiesAsStrings, getPropertiesMap, getProperty, getProperty, getPropertyExpressionsMap, getPropertyMap, 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

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

writeChildren

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

getValidatorSubType

public java.lang.String getValidatorSubType()

Overrides:

getValidatorSubType 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.

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.

getRhsValue

public java.lang.Object getRhsValue()

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

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

loadXMLContents

public void loadXMLContents(DefElement elem)

Overrides:

loadXMLContents in class JboAbstractValidator

getDefXMLElementTag

public java.lang.String getDefXMLElementTag()

Specified by:

getDefXMLElementTag in interface PersistentDefinition

Specified by:

getDefXMLElementTag in class JboAbstractValidator

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