Oracle Fusion Middleware Java API Reference for Oracle ADF Mobile Client
11g Release 1 (11.1.1)

E17503-02

oracle.jbo.rules
Class JboAbstractValidator

java.lang.Object
  extended by oracle.jbo.rules.AbstractValidator
      extended by oracle.jbo.rules.JboAbstractValidator
All Implemented Interfaces:
JboValidatorHints, JboValidatorInterface, ValidatorConstants, VariableManagerOwner, VariableManagerOwnerBase
Direct Known Subclasses:
JboCompareValidator, JboExistsValidator, JboExpressionValidator, JboLengthValidator, JboListValidator, JboMandatoryAttrValHelper, JboMethodValidator, JboNonNullValidator, JboPrecisionScaleValidator, JboRangeValidator, JboRegExpValidator, JboRequiredValidator, JboUniqueKeyValidator, JboVCItemRequiredValidator

public abstract class JboAbstractValidator
extends AbstractValidator
implements JboValidatorHints


Field Summary
static java.lang.Class CLASS_INSTANCE
           
protected  AttributeDef mValidatingAttr
           
 
Fields inherited from class oracle.jbo.rules.AbstractValidator
m_children, m_props, mbInverse, mDescription, mErrorMessageClass, mMsgExpr, mMsgId, mMsgIds, mResourceBundleId, mTriggeringAttributeNames, mTriggeringAttributes, mValidatingAttrName
 
Fields inherited from interface oracle.jbo.rules.ValidatorConstants
ATTR, ATTR_STR, EO, EO_STR, EQUALTO, EXPR, EXPR_STR, GREATERTHAN, GREATERTHANEQUALTO, JBO, JBO_STR, LESSTHAN, LESSTHANEQUALTO, LITERAL, LITERAL_STR, MANDATORY_STR, mCompOperTypeVals, mRhsTypeVals, mSeverityVals, PNAME_CompareLength, PNAME_CompareType, PNAME_CompareValue, PNAME_DataType, PNAME_ErrorMessageExpressions, PNAME_ErrorMessageId, PNAME_ErrorMessageIds, PNAME_Exposed, PNAME_ForPersonalization, PNAME_Inverse, PNAME_Name, PNAME_OnAttribute, PNAME_OnAttributes, PNAME_OnCondition, PNAME_OperandType, PNAME_Severity, PNAME_Subtype, PNAME_TransactionLevel, 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
 
Constructor Summary
JboAbstractValidator()
           
 
Method Summary
 JboValidatorHints applyValidatorPersonalization(JboValidatorHints orgVal)
           
 java.lang.Object clone()
           
 void closeObject()
           
 void endInit()
           
abstract  java.lang.String getDefXMLElementTag()
           
 java.lang.String getDefXMLNameSpace()
           
 java.lang.String getErrorMsgId()
           
 java.lang.String getFullName()
           
 java.lang.String getImageLoc(boolean bOpen)
           
 java.lang.String getName()
          Returns the name of this Variable Manager Owner.
 AttributeDef[] getTriggeringAttributeDefs()
          Returns an array of attribute defs for those attributes whose change in value, should trigger this validation rule to execute.
 java.lang.String[] getTriggeringAttributeNames()
          Returns an array of names for those attributes whose change in value, should trigger this validation rule to execute.
 java.lang.String getValidatingAttributeName()
           
protected  java.lang.Object getValueToValidate(JboValidatorContext evObj)
           
 java.lang.String getXMLElementTag()
           
protected  void initialize(JboValidatorContext evObj)
           
 boolean isDirty()
           
 boolean isForPersonalization()
           
 boolean isNew()
           
 boolean isReadOnly()
           
 void raiseException(java.lang.Class callingClass, java.lang.String callingMethod, java.lang.Exception e, JboValidatorContext evObj, java.lang.String msgId, int severity)
           
 void resolve(ValidationManager owner, StructureDef structDef, PersistableDefObject defObj)
           
 void setDirty(boolean b)
           
 void setForPersonalization(boolean b)
           
protected  void setInitialized()
           
 void setName(java.lang.String name)
           
 void setNew(boolean b)
           
protected  void setNewValue(java.lang.Object newValue)
          When the newValue is an Entity, get the attribute's value by using the getAttribute method on the entity.
 void setTriggeringAttributeNames(java.lang.String[] names)
           
 void setValidatingAttribute(AttributeDef attr)
          Sets the validating attribute.
 void setValidatingAttribute(StructureDef beanInfo, java.lang.String str)
          Sets the validating attribute by name.
 void validate(JboValidatorContext evObj)
          Tests the validity of the object/value as described in the validator context.
 void validateMany(ArrayList valCtxs)
           
abstract  boolean validateValue(java.lang.Object value)
          Validates a 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.
 
Methods inherited from class oracle.jbo.rules.AbstractValidator
beginInit, convertToJava, createException, createExprValueSupplier, ensureVariableManager, getDescription, getErrorMessageClass, getErrorMsgExpressions, getInverse, getMessageBundleClass, getOnCondition, getOperandType, getOwner, getProps, getResourceBundleDef, getResourceBundleId, getSeverity, getValidatorSubType, getVariableManager, hasCustomErrorMsgId, hasValidationCondition, hasVariables, initErrMsgParms, initFromXml, initTriggeringAttributeDefs, initValidatorProperties, isMovedToAttrLevel, isTransactionLevel, isTransactionLevel, isValidatable, parseSeverityStr, prepareException, raiseException, readStringArrayList, readUserObjectTrim, setDefaultDescription, setDescription, setErrorMessageClass, setErrorMsgExpressions, setErrorMsgId, setErrorMsgIds, setInverse, setOnCondition, setOperandType, setProp, setResourceBundleDef, setResourceBundleId, setSeverity, setTransactionLevel, setValidatingAttributeName
 
Methods inherited from class java.lang.Object
equals, getClass, hashCode, notify, notifyAll, toString, wait, wait, wait
 
Methods inherited from interface oracle.jbo.rules.JboValidatorHints
initValidatorProperties, isTransactionLevel
 
Methods inherited from interface oracle.jbo.rules.JboValidatorInterface
getDescription, setDescription
 

Field Detail

CLASS_INSTANCE

public static final java.lang.Class CLASS_INSTANCE

mValidatingAttr

protected AttributeDef mValidatingAttr
Constructor Detail

JboAbstractValidator

public JboAbstractValidator()
Method Detail

clone

public java.lang.Object clone()
Overrides:
clone in class AbstractValidator

endInit

public void endInit()
Overrides:
endInit in class AbstractValidator

getName

public java.lang.String getName()
Description copied from interface: VariableManagerOwner
Returns the name of this Variable Manager Owner.

Specified by:
getName in interface JboValidatorHints
Specified by:
getName in interface VariableManagerOwner
Overrides:
getName in class AbstractValidator
Returns:
the name.

setName

public void setName(java.lang.String name)
Specified by:
setName in interface JboValidatorHints

getFullName

public java.lang.String getFullName()
Overrides:
getFullName in class AbstractValidator

isReadOnly

public boolean isReadOnly()

closeObject

public void closeObject()

getImageLoc

public java.lang.String getImageLoc(boolean bOpen)

isForPersonalization

public boolean isForPersonalization()
Specified by:
isForPersonalization in interface JboValidatorHints

setForPersonalization

public void setForPersonalization(boolean b)
Specified by:
setForPersonalization in interface JboValidatorHints

setInitialized

protected void setInitialized()

initialize

protected void initialize(JboValidatorContext evObj)

getTriggeringAttributeDefs

public AttributeDef[] getTriggeringAttributeDefs()
Description copied from interface: JboValidatorHints
Returns an array of attribute defs for those attributes whose change in value, should trigger this validation rule to execute.

Specified by:
getTriggeringAttributeDefs in interface JboValidatorHints
Overrides:
getTriggeringAttributeDefs in class AbstractValidator

getTriggeringAttributeNames

public java.lang.String[] getTriggeringAttributeNames()
Description copied from interface: JboValidatorHints
Returns an array of names for those attributes whose change in value, should trigger this validation rule to execute.

Specified by:
getTriggeringAttributeNames in interface JboValidatorHints
Overrides:
getTriggeringAttributeNames in class AbstractValidator

setTriggeringAttributeNames

public void setTriggeringAttributeNames(java.lang.String[] names)
Overrides:
setTriggeringAttributeNames in class AbstractValidator

getErrorMsgId

public java.lang.String getErrorMsgId()
Overrides:
getErrorMsgId in class AbstractValidator

validateValue

public abstract boolean validateValue(java.lang.Object value)
Validates a value.

Subclasses must implement this method.

Parameters:
value - the object to be validated.
Returns:
true if the object is valid.
Throws:
java.lang.Exception - if validation cannot be performed.

validateValueWithContext

public boolean validateValueWithContext(JboValidatorContext evObj,
                                        java.lang.Object value)
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.


validate

public void validate(JboValidatorContext evObj)
Description copied from interface: JboValidatorInterface
Tests the validity of the object/value as described in the validator context.

Specified by:
validate in interface JboValidatorInterface
Parameters:
evObj - the validator context

validateMany

public void validateMany(ArrayList valCtxs)

raiseException

public void raiseException(java.lang.Class callingClass,
                           java.lang.String callingMethod,
                           java.lang.Exception e,
                           JboValidatorContext evObj,
                           java.lang.String msgId,
                           int severity)
Overrides:
raiseException in class AbstractValidator

setNewValue

protected void setNewValue(java.lang.Object newValue)
                    throws java.lang.Exception
When the newValue is an Entity, get the attribute's value by using the getAttribute method on the entity. Otherwise, newValue should be a value to compare in this validator.

Parameters:
newValue - either the attribute's value or a value to use to compare in the validator.
Throws:
java.lang.Exception

getValueToValidate

protected java.lang.Object getValueToValidate(JboValidatorContext evObj)

setValidatingAttribute

public void setValidatingAttribute(AttributeDef attr)
Sets the validating attribute.

Parameters:
attr - an attribute.

setValidatingAttribute

public void setValidatingAttribute(StructureDef beanInfo,
                                   java.lang.String str)
Sets the validating attribute by name.

This variant is used when the validator is attached to an entity, rather than to an attribute.

Parameters:
beanInfo - the entity containing the attribute.
str - an attribute name as a string.

getValidatingAttributeName

public java.lang.String getValidatingAttributeName()
Overrides:
getValidatingAttributeName in class AbstractValidator

resolve

public void resolve(ValidationManager owner,
                    StructureDef structDef,
                    PersistableDefObject defObj)
Specified by:
resolve in interface JboValidatorHints
Overrides:
resolve in class AbstractValidator

isDirty

public boolean isDirty()

setDirty

public void setDirty(boolean b)

isNew

public boolean isNew()

setNew

public void setNew(boolean b)

getDefXMLElementTag

public abstract java.lang.String getDefXMLElementTag()

getXMLElementTag

public java.lang.String getXMLElementTag()

getDefXMLNameSpace

public java.lang.String getDefXMLNameSpace()

applyValidatorPersonalization

public JboValidatorHints applyValidatorPersonalization(JboValidatorHints orgVal)
Specified by:
applyValidatorPersonalization in interface JboValidatorHints

Oracle Fusion Middleware Java API Reference for Oracle ADF Mobile Client
11g Release 1 (11.1.1)

E17503-02

Copyright © 2011, Oracle and/or its affiliates. All rights reserved.