public class JboLengthValidator extends JboAbstractValidator
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.
ValidatorConstants.MessageFlavor
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 |
mValidatingAttr
mbInverse, mDescription, mErrorMessageClass, mMsgId, mMsgIds, mResourceBundleId, mTriggeringAttributeNames, mTriggeringAttributes, mValidatingAttrName
mFullName, mObjName, mParent, mProperties, RES_ID_SUFFIX, RESID_SUFFIX
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
XML_STATEMENT
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.
|
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
|
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, writeObject
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, getValidatorSubType, 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, writeChildren
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
equals, finalize, getClass, hashCode, notify, notifyAll, wait, wait, wait
getTriggeringAttributeNames, isTransactionLevel
getDescription, setDescription
isDirty, isNew, setDirty, setNew
writeChildren
public static final int EQUALTO
public static final int LESSTHAN
public static final int GREATERTHAN
public static final int LESSTHANEQUALTO
public static final int GREATERTHANEQUALTO
public static final int BETWEEN
public static final java.lang.String[] operTypeVals
public static final java.lang.String[] dataTypeVals
public static final int CHARACTER
public static final int BYTE
protected int mOperType
protected int mDataType
protected java.lang.Object rhsValue
protected int mMinLength
protected int mMaxLength
public JboLengthValidator()
The methods setOperType()
,setDataType()
and setRhsValue()
must be invoked before validation can be performed.
public JboLengthValidator(boolean propBased)
public JboLengthValidator(boolean inverse, int operType, int dataType, java.lang.Object rhsValue)
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.public java.lang.Object clone()
clone
in class JboAbstractValidator
protected void initialize(JboValidatorContext evObj)
initialize
in class JboAbstractValidator
public boolean validateValue(java.lang.Object 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()
.
validateValue
in class JboAbstractValidator
value
- the object whose length is to be validated.true
if the relation holds, or
false
if the relation does not hold or
if the operator or an operand is invalid or uninitialized.public boolean validateValueWithContext(JboValidatorContext evObj, java.lang.Object value)
JboAbstractValidator
validateValueWithContext
in class JboAbstractValidator
public void setOperType(int typeArg)
typeArg
- one of the comparison operator constants defined in this class.public int getOperType()
public void setDataType(int typeArg)
typeArg
- one of the datatype constants defined in this class.public int getDataType()
public void setRhsValue(java.lang.Object rhsValueArg)
rhsValueArg
- a reference object containing a numeric value.public java.lang.Object getRhsValue()
public int getMinLength()
public void setMinLength(int minLength)
public int getMaxLength()
public void setMaxLength(int maxLength)
public java.lang.String toString()
toString
in class java.lang.Object
public static int convertOperType(java.lang.String typeArg)
typeArg
- a string, the textual name of a comparison operator.EQUALTO
.public static int convertDataType(java.lang.String typeArg)
typeArg
- a string, the textual name of a comparison datatype.CHARACTER
.public static int parseOperatorTypeStr(java.lang.String str)
public java.lang.String getOperatorTypeString()
public void initValidatorProperties(java.util.HashMap props)
initValidatorProperties
in interface JboValidatorHints
initValidatorProperties
in class AbstractValidator
public void loadXMLContents(DefElement elem)
loadXMLContents
in class JboAbstractValidator
public java.lang.String getDefXMLElementTag()
getDefXMLElementTag
in interface PersistentDefinition
getDefXMLElementTag
in class AbstractValidator
public void writeContents(DefWriter jos)
PersistentDefinition
writeContents
in interface PersistentDefinition
writeContents
in class JboAbstractValidator
jos
- the Output storage for persistencepublic DifferDetails diffContents(DiffMergeable docDef, DiffMergeable orgDef, DifferDetails difDetails)
DiffMergeable
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; }
diffContents
in interface DiffMergeable
diffContents
in class JboAbstractValidator
docDef
- the document-level definitionorgDef
- the original definition. It could be
null
if the definition did not exist originallydifDetails
- the DifferDetails
that accumulate
the details of diff from the document-level (top-level) defDifferDetails
that has all the details
of diffpublic void applyDiffContents(DifferDetails dif, DiffResolver resolver)
DiffMergeable
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.
applyDiffContents
in interface DiffMergeable
applyDiffContents
in class AbstractValidator
dif
- changes to be applied to 'this'
defresolver
- the diff resolver used in diff/merge operation