ConstraintObject (SAP CC 5.0 Java APIs (Core Library))

java.lang.Object
- com.highdeal.udr.hci.ConstraintObject

Direct Known Subclasses:

EnumeratedListConstraint, FormatConstraint, RangeConstraint
```
public abstract class ConstraintObject
extends java.lang.Object
```
This Java class represents the constraint as used by an entity to be constrained; A constraint can be an enumerated list, a range, or a format.
A constraint has a constraint type (enumerated list, range, format) and a compatible subtype corresponding to the type of the value to be constrained (boolean, integer, decimal, string, date).

A constraint is represented by a String. See the createConstraintFromString(String) method for more information about the String format.

Nested Class Summary

Nested Classes
Modifier and Type Class and Description

static class ConstraintObject.MetaChar
This enumeration lists the meta characters: escape, multiple, single, slash.

Nested Classes
Modifier and Type	Class and Description
`static class`	`ConstraintObject.MetaChar` This `enumeration` lists the meta characters: escape, multiple, single, slash.

Field Summary

Fields
Modifier and Type	Field and Description
`static boolean[][]`	`compatibilityTable` The compatibility table: constrained object type/constraint object type.
`static int`	`NO_SUBTYPE` The no subtype.
`static java.lang.String`	`separator` The separator character as a string
`static char`	`separatorChar` The separator character: '/'
`static java.lang.String`	`STRING_TYPE_BIG_INTEGER`
`static java.lang.String`	`STRING_TYPE_BOOLEAN`
`static java.lang.String`	`STRING_TYPE_DATE`
`static java.lang.String`	`STRING_TYPE_DECIMAL`
`static java.lang.String`	`STRING_TYPE_ENUMERATED_LIST`
`static java.lang.String`	`STRING_TYPE_FORMAT`
`static java.lang.String`	`STRING_TYPE_INTEGER`
`static java.lang.String`	`STRING_TYPE_LONG`
`static java.lang.String`	`STRING_TYPE_RANGE`
`static java.lang.String`	`STRING_TYPE_STRING`
`static int`	`TYPE_BIG_INTEGER` the big integer subtype.
`static int`	`TYPE_BOOLEAN` the date subtype.
`static int`	`TYPE_DATE` the date subtype.
`static int`	`TYPE_DECIMAL` the decimal subtype.
`static int`	`TYPE_ENUMERATED_LIST` The enumerated list type.
`static int`	`TYPE_FORMAT` The format constraint type.
`static int`	`TYPE_INTEGER` the integer subtype.
`static int`	`TYPE_LONG` the long subtype.
`static int`	`TYPE_RANGE` The range constraint type.
`static int`	`TYPE_STRING` the string subtype.

Constructor Summary

Constructors
Constructor and Description

ConstraintObject(int constraintType)
Builds a constraint object from a constraint type.

Constructors
Constructor and Description
`ConstraintObject(int constraintType)` Builds a constraint object from a constraint type.

Method Summary

All Methods Static Methods Instance Methods Abstract Methods Concrete Methods
Modifier and Type	Method and Description
`static ConstraintObject`	`createConstraintFromString(java.lang.String str)` Builds a constraint from a string representation.
`boolean`	`equals(java.lang.Object obj)`
`static java.lang.String`	`escapeMetaChar(java.lang.String value)` This method adds an `escape char` before each `metachar` from the input string.
`static int[]`	`getAllowedConstraintTypes(int valueType)` According to the value type (NUMBER, STRING, DATE, BOOLEAN) to be constrained returns the allowed constraint types.
`int`	`getConstraintSubType()` Gets the subtype of the constraint that depends on the type of the constrained value.
`int`	`getConstraintType()` Returns the constraint type of this constraint.
`abstract java.lang.String`	`getInitializationString()` Returns the initialization string of the constraint.
`int`	`hashCode()`
`abstract boolean`	`isBigIntegerConstraint()` Returns big integer status of the constraint.
`abstract boolean`	`isBooleanConstraint()` Returns boolean status of the constraint.
`abstract boolean`	`isDateConstraint()` Returns date status of the constraint.
`abstract boolean`	`isDecimalConstraint()` Returns decimal status of the constraint.
`static boolean`	`isEscapedChar(java.lang.String value, int index)` This method tests if the character at position index in the string value is escaped .
`abstract boolean`	`isIntegerConstraint()` Returns integer status of the constraint.
`abstract boolean`	`isLongConstraint()` Returns long status of the constraint.
`abstract boolean`	`isStringConstraint()` Returns string status of the constraint.
`abstract boolean`	`isValidValue(java.lang.Object value)` Tests if the value checks the constraint.
`static int`	`parseConstraintSubType(java.lang.String subType)` Returns the sub type as `int`
`abstract java.lang.String`	`toString()` Returns `true` the string that represents the constraint.
`static java.lang.String`	`unescapeMetaChar(java.lang.String value)` This method removes the `escape char` before each `metachar` from the input string.
`static java.lang.String`	`unescapeSeparatorChar(java.lang.String s)` Unescapes the separator character.

Methods inherited from class java.lang.Object
getClass, notify, notifyAll, wait, wait, wait

- Field Detail
  - TYPE_ENUMERATED_LIST
```
public static final int TYPE_ENUMERATED_LIST
```
    The enumerated list type.
    
    See Also:
    
    Constant Field Values
  - STRING_TYPE_ENUMERATED_LIST
```
public static final java.lang.String STRING_TYPE_ENUMERATED_LIST
```
    See Also:
    
    Constant Field Values
  - TYPE_RANGE
```
public static final int TYPE_RANGE
```
    The range constraint type.
    
    See Also:
    
    Constant Field Values
  - STRING_TYPE_RANGE
```
public static final java.lang.String STRING_TYPE_RANGE
```
    See Also:
    
    Constant Field Values
  - TYPE_FORMAT
```
public static final int TYPE_FORMAT
```
    The format constraint type.
    
    See Also:
    
    Constant Field Values
  - STRING_TYPE_FORMAT
```
public static final java.lang.String STRING_TYPE_FORMAT
```
    See Also:
    
    Constant Field Values
  - TYPE_INTEGER
```
public static final int TYPE_INTEGER
```
    the integer subtype.
    
    See Also:
    
    Constant Field Values
  - STRING_TYPE_INTEGER
```
public static final java.lang.String STRING_TYPE_INTEGER
```
    See Also:
    
    Constant Field Values
  - TYPE_DECIMAL
```
public static final int TYPE_DECIMAL
```
    the decimal subtype.
    
    See Also:
    
    Constant Field Values
  - STRING_TYPE_DECIMAL
```
public static final java.lang.String STRING_TYPE_DECIMAL
```
    See Also:
    
    Constant Field Values
  - TYPE_STRING
```
public static final int TYPE_STRING
```
    the string subtype.
    
    See Also:
    
    Constant Field Values
  - STRING_TYPE_STRING
```
public static final java.lang.String STRING_TYPE_STRING
```
    See Also:
    
    Constant Field Values
  - TYPE_DATE
```
public static final int TYPE_DATE
```
    the date subtype.
    
    See Also:
    
    Constant Field Values
  - STRING_TYPE_DATE
```
public static final java.lang.String STRING_TYPE_DATE
```
    See Also:
    
    Constant Field Values
  - TYPE_BOOLEAN
```
public static final int TYPE_BOOLEAN
```
    the date subtype.
    
    See Also:
    
    Constant Field Values
  - STRING_TYPE_BOOLEAN
```
public static final java.lang.String STRING_TYPE_BOOLEAN
```
    See Also:
    
    Constant Field Values
  - NO_SUBTYPE
```
public static final int NO_SUBTYPE
```
    The no subtype.
    
    See Also:
    
    Constant Field Values
  - TYPE_LONG
```
public static final int TYPE_LONG
```
    the long subtype.
    
    See Also:
    
    Constant Field Values
  - STRING_TYPE_LONG
```
public static final java.lang.String STRING_TYPE_LONG
```
    See Also:
    
    Constant Field Values
  - TYPE_BIG_INTEGER
```
public static final int TYPE_BIG_INTEGER
```
    the big integer subtype.
    
    See Also:
    
    Constant Field Values
  - STRING_TYPE_BIG_INTEGER
```
public static final java.lang.String STRING_TYPE_BIG_INTEGER
```
    See Also:
    
    Constant Field Values
  - compatibilityTable
```
public static final boolean[][] compatibilityTable
```
    The compatibility table: constrained object type/constraint object type.
  - separatorChar
```
public static final char separatorChar
```
    The separator character: '/'
    
    See Also:
    
    Constant Field Values
  - separator
```
public static final java.lang.String separator
```
    The separator character as a string
- Constructor Detail
  - ConstraintObject
```
public ConstraintObject(int constraintType)
```
    Builds a constraint object from a constraint type.
    
    Parameters:
    
    constraintType - the constraint type
    
    See Also:
    
    TYPE_ENUMERATED_LIST, TYPE_FORMAT, TYPE_RANGE
- Method Detail
  - createConstraintFromString
```
public static ConstraintObject createConstraintFromString(java.lang.String str)
```
    Builds a constraint from a string representation.
    Three types of constraints can be defined: enumerated list constraint, range constraint, and format constraint.
    
    Enumerated List Constraint
    
    This type of constraint is described by a string that respects the following format:
    /E/compatible_subtype/item1/.../itemN/
    
    Where:
    - E indicates the enumerated list constraint type
    - compatible_subtype indicates the type of allowed values, and is one of:
      
      I for Integer
      
      L for Long
      
      BI for BigInteger
      
      D for BigDecimal
      
      S for String
      
      DA for Date (in this case, items must respect ISO 8601 format or be expressed in milliseconds since January 1, 1970, 00:00:00 GMT)
    - item1 to itemN are the N values of the list
    An Object is compatible with an enumerated list constraint if and only if it's instance of the given compatible subtype and equals one of the given items.
    
    Range Constraint
    
    This type of constraint is decribed by a string that respects the following format:
    /R/compatible_subtype/min/min_type/max/max_type/
    
    Where:
    - R indicates the range constraint type
    - compatible_subtype indicates the type of allowed values, and is one of:
      
      I for Integer
      
      L for Long
      
      D for BigInteger
      
      D for BigDecimal
      
      DA for Date (in this case, items must respect ISO 8601 format or be expressed in milliseconds since January 1, 1970, 00:00:00 GMT)
    - min and max are the bounds of the range. If the string NULL is used as min or max value, it means the related bound is not taken into account.
    - min_type and max_type are interger flags indicating the type of the related bound, and is one of TYPE_INCLUSIVE (0) or TYPE_EXCLUSIVE (1).
    An Object is compatible with an range constraint if and only if it's instance of the given compatible subtype and belongs to the range defined by min and max bounds, and the related bound types.
    
    Format Constraint
    
    This type of constraint is described by a string that respects the following format:
    /F/pattern/
    
    Where:
    - F indicates the format constraint type
    - pattern is the pattern that matches the allowed values. Inside the pattern, each character '*' means any string is valid between the previous and the following character. The character '?' means any character is valid at this character position.
    An Object is compatible with a format constraint if and only if it's a String matching the given pattern.
    Parameters:
    
    str - the string representation of the constraint
    
    Returns:
    
    the ConstraintObject computed from the string or null if the string constraint is invalid
  - isValidValue
```
public abstract boolean isValidValue(java.lang.Object value)
```
    Tests if the value checks the constraint.
    
    Parameters:
    
    value - the value to check
    
    Returns:
    
    true if the value checks the constraint, false otherwise
  - getConstraintType
```
public int getConstraintType()
```
    Returns the constraint type of this constraint.
    
    Returns:
    
    The constraint type
    
    See Also:
    
    TYPE_ENUMERATED_LIST, TYPE_RANGE, TYPE_FORMAT
  - getConstraintSubType
```
public int getConstraintSubType()
```
    Gets the subtype of the constraint that depends on the type of the constrained value.
    
    Returns:
    
    The subtype of the constraint
    
    See Also:
    
    TYPE_BOOLEAN, TYPE_INTEGER, TYPE_LONG, TYPE_BIG_INTEGER, TYPE_DECIMAL, TYPE_STRING, TYPE_DATE, NO_SUBTYPE
  - isBooleanConstraint
```
public abstract boolean isBooleanConstraint()
```
    Returns boolean status of the constraint.
    
    Returns:
    
    true if the constrained value is boolean, false otherwise
  - isIntegerConstraint
```
public abstract boolean isIntegerConstraint()
```
    Returns integer status of the constraint.
    
    Returns:
    
    true if the constrained value is integer, false otherwise
  - isLongConstraint
```
public abstract boolean isLongConstraint()
```
    Returns long status of the constraint.
    
    Returns:
    
    true if the constrained value is long, false otherwise
  - isDecimalConstraint
```
public abstract boolean isDecimalConstraint()
```
    Returns decimal status of the constraint.
    
    Returns:
    
    true if the constrained value is big decimal, false otherwise
  - isBigIntegerConstraint
```
public abstract boolean isBigIntegerConstraint()
```
    Returns big integer status of the constraint.
    
    Returns:
    
    true if the constrained value is a BigInteger, false otherwise
  - isDateConstraint
```
public abstract boolean isDateConstraint()
```
    Returns date status of the constraint.
    
    Returns:
    
    true if the constrained value is date, false otherwise
  - isStringConstraint
```
public abstract boolean isStringConstraint()
```
    Returns string status of the constraint.
    
    Returns:
    
    true if the constrained value is string, false otherwise
  - getInitializationString
```
public abstract java.lang.String getInitializationString()
```
    Returns the initialization string of the constraint.
    
    Returns:
    
    The initialization string of the constraint
  - toString
```
public abstract java.lang.String toString()
```
    Returns true the string that represents the constraint.
    
    Overrides:
    
    toString in class java.lang.Object
    
    Returns:
    
    The string representation of the constraint
  - equals
```
public boolean equals(java.lang.Object obj)
```
    Overrides:
    
    equals in class java.lang.Object
  - hashCode
```
public int hashCode()
```
    Overrides:
    
    hashCode in class java.lang.Object
  - getAllowedConstraintTypes
```
public static int[] getAllowedConstraintTypes(int valueType)
```
    According to the value type (NUMBER, STRING, DATE, BOOLEAN) to be constrained returns the allowed constraint types.
    
    Returns:
    
    The allowed constraint types can be
    
    See Also:
    
    TYPE_ENUMERATED_LIST, TYPE_RANGE, TYPE_FORMAT
  - parseConstraintSubType
```
public static int parseConstraintSubType(java.lang.String subType)
```
    Returns the sub type as int
    Parameters: subType - the String representation of the subtype Returns: the int representation of the sub type if exists, NO_SUBTYPE otherwise
  escapeMetaChar public static java.lang.String escapeMetaChar(java.lang.String value) This method adds an escape char before each metachar from the input string. Parameters: value - The string to scan Returns: The string with the metachar escaped unescapeMetaChar public static java.lang.String unescapeMetaChar(java.lang.String value) This method removes the escape char before each metachar from the input string. Parameters: value - The string to scan Returns: The string with the metachar unescaped isEscapedChar public static boolean isEscapedChar(java.lang.String value, int index) This method tests if the character at position index in the string value is escaped . Parameters: value - The string which contains the character to check index - The index of the character to check Returns: true if the character is escaped unescapeSeparatorChar public static java.lang.String unescapeSeparatorChar(java.lang.String s) Unescapes the separator character. Returns: The unescaped string

Class ConstraintObject

Nested Class Summary

Field Summary

Constructor Summary

Method Summary

Methods inherited from class java.lang.Object

Field Detail

TYPE_ENUMERATED_LIST

STRING_TYPE_ENUMERATED_LIST

TYPE_RANGE

STRING_TYPE_RANGE

TYPE_FORMAT

STRING_TYPE_FORMAT

TYPE_INTEGER

STRING_TYPE_INTEGER

TYPE_DECIMAL

STRING_TYPE_DECIMAL

TYPE_STRING

STRING_TYPE_STRING

TYPE_DATE

STRING_TYPE_DATE

TYPE_BOOLEAN

STRING_TYPE_BOOLEAN

NO_SUBTYPE

TYPE_LONG

STRING_TYPE_LONG

TYPE_BIG_INTEGER

STRING_TYPE_BIG_INTEGER

compatibilityTable

separatorChar

separator

Constructor Detail

ConstraintObject

Method Detail

createConstraintFromString

isValidValue

getConstraintType

getConstraintSubType

isBooleanConstraint

isIntegerConstraint

isLongConstraint

isDecimalConstraint

isBigIntegerConstraint

isDateConstraint

isStringConstraint

getInitializationString

toString

equals

hashCode

getAllowedConstraintTypes

parseConstraintSubType

escapeMetaChar

unescapeMetaChar

isEscapedChar

unescapeSeparatorChar