Oracle Application Development Framework Model and Business Components Java API Reference 10g Release 3 (10.1.3)
B16005-01


oracle.jbo.rules
Class JboLengthValidator

java.lang.Object
  extended byoracle.jbo.rules.AbstractValidator
      extended byoracle.jbo.rules.JboAbstractValidator
          extended byoracle.jbo.rules.JboLengthValidator

All Implemented Interfaces:
JboValidatorInterface

public class JboLengthValidator
extends JboAbstractValidator
implements JboValidatorInterface

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

Field Summary
static int BYTE
           
static int CHARACTER
           
static int EQUALTO
           
static int GREATERTHAN
           
static int GREATERTHANEQUALTO
           
static int LESSTHAN
           
static int LESSTHANEQUALTO
           
protected  int mDataType
           
protected  int mOperType
           
protected  java.lang.Object rhsValue
           

 

Fields inherited from class oracle.jbo.rules.JboAbstractValidator
mValidatingAttr, mValidatingAttrName

 

Fields inherited from class oracle.jbo.rules.AbstractValidator
mbInverse, mDescription, mErrorMessageClass, mMsgId

 

Constructor Summary
JboLengthValidator()
          Creates an uninitialized length validator.
JboLengthValidator(boolean inverse, int operType, int dataType, java.lang.Object rhsValue)
          Creates an initialized length validator.

 

Method Summary
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.
 int getDataType()
          Gets this validator's comparison datatype.
 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 setDataType(int typeArg)
          Sets this validator's comparison datatype.
 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.

 

Methods inherited from class oracle.jbo.rules.JboAbstractValidator
getValidatingAttributeName, getValueToValidate, setNewValue, setValidatingAttribute, setValidatingAttribute, setValidatingAttributeName, validate

 

Methods inherited from class oracle.jbo.rules.AbstractValidator
convertToJava, getDescription, getErrorMessageClass, getErrorMsgId, getInverse, setDescription, setErrorMessageClass, setErrorMsgId, setInverse

 

Methods inherited from class java.lang.Object
clone, equals, finalize, getClass, hashCode, notify, notifyAll, wait, wait, wait

 

Methods inherited from interface oracle.jbo.rules.JboValidatorInterface
getDescription, setDescription, validate

 

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

mOperType

protected int mOperType

CHARACTER

public static final int CHARACTER
See Also:
Constant Field Values

BYTE

public static final int BYTE
See Also:
Constant Field Values

mDataType

protected int mDataType

rhsValue

protected java.lang.Object rhsValue

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

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.

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.

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.

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.

toString

public java.lang.String toString()
Internal: For debugging purposes only.

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.

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.

Oracle Application Development Framework Model and Business Components Java API Reference 10g Release 3 (10.1.3)
B16005-01


Copyright © 1997, 2005, Oracle. All rights reserved.