com.highdeal.udr.hci

Class EnumeratedListConstraint

java.lang.Object

com.highdeal.udr.hci.ConstraintObject

com.highdeal.udr.hci.EnumeratedListConstraint

public class EnumeratedListConstraint
extends ConstraintObject

The EnumeratedListConstraint implements the constraint defined by a list of allowed values. Integer, long, big decimal, big integer, string, and date entities can be constrained by an enumerated list constraint.

The standard way to create an EnumeratedListConstraint instance is to use the method ConstraintObject.createConstraintFromString(String) with a string representation of an enumerated list constraint.

Nested Class Summary

Nested classes/interfaces inherited from class com.highdeal.udr.hci.ConstraintObject

ConstraintObject.MetaChar

Field Summary

Fields inherited from class com.highdeal.udr.hci.ConstraintObject

compatibilityTable, NO_SUBTYPE, separator, separatorChar, STRING_TYPE_BIG_INTEGER, STRING_TYPE_BOOLEAN, STRING_TYPE_DATE, STRING_TYPE_DECIMAL, STRING_TYPE_ENUMERATED_LIST, STRING_TYPE_FORMAT, STRING_TYPE_INTEGER, STRING_TYPE_LONG, STRING_TYPE_RANGE, STRING_TYPE_STRING, TYPE_BIG_INTEGER, TYPE_BOOLEAN, TYPE_DATE, TYPE_DECIMAL, TYPE_ENUMERATED_LIST, TYPE_FORMAT, TYPE_INTEGER, TYPE_LONG, TYPE_RANGE, TYPE_STRING

Constructor Summary

Constructors

Constructor and Description
EnumeratedListConstraint() Builds an empty enumerated list constraint.
EnumeratedListConstraint(java.util.List<?> v) Builds an enumerated list constraint.
EnumeratedListConstraint(java.lang.Object[] items) Builds an enumerated list constraint.

Method Summary

Modifier and Type	Method and Description
java.lang.String	getInitializationString() Returns the initialization string.
java.util.List<java.lang.Object>	getObjects() Returns the list of objects for enumerated list constraint.
boolean	isBigIntegerConstraint() Returns big integer status of the enumerated list constraint.
boolean	isBooleanConstraint() Returns boolean status of the enumerated list constraint.
boolean	isDateConstraint() Returns date status of the enumerated list constraint.
boolean	isDecimalConstraint() Returns decimal status of the enumerated list constraint.
boolean	isIntegerConstraint() Returns integer status of the enumerated list constraint.
boolean	isLongConstraint() Returns long status of the enumerated list constraint.
boolean	isStringConstraint() Returns string status of the enumerated list constraint.
boolean	isValidValue(java.lang.Object value) Tests if the value checks the enumerated list constraint.
void	setInitializationString(java.lang.String initializationString) Sets the initialization string.
void	setObjects(java.util.List objects) Sets the list of objects for enumerated list constraint.
java.lang.String	toString() Returns true the string that represents the constraint.

Methods inherited from class com.highdeal.udr.hci.ConstraintObject

createConstraintFromString, equals, escapeMetaChar, getAllowedConstraintTypes, getConstraintSubType, getConstraintType, hashCode, isEscapedChar, parseConstraintSubType, unescapeMetaChar, unescapeSeparatorChar

Methods inherited from class java.lang.Object

getClass, notify, notifyAll, wait, wait, wait

Constructor Detail

EnumeratedListConstraint

public EnumeratedListConstraint()

Builds an empty enumerated list constraint.

EnumeratedListConstraint

public EnumeratedListConstraint(java.lang.Object[] items)

Builds an enumerated list constraint.

Parameters:

items - the array of enumerated objects

EnumeratedListConstraint

public EnumeratedListConstraint(java.util.List<?> v)

Builds an enumerated list constraint.

Parameters:

v - the list of enumerated objects

Method Detail

getInitializationString

public java.lang.String getInitializationString()

Returns the initialization string.

Specified by:

getInitializationString in class ConstraintObject

Returns:

The initialization string

setInitializationString

public void setInitializationString(java.lang.String initializationString)

Sets the initialization string.

Parameters:

initializationString - The initialization string

getObjects

public java.util.List<java.lang.Object> getObjects()

Returns the list of objects for enumerated list constraint.

Returns:

The list of objects

setObjects

public void setObjects(java.util.List objects)

Sets the list of objects for enumerated list constraint.

Parameters:

objects - The list of objects

isValidValue

public boolean isValidValue(java.lang.Object value)

Tests if the value checks the enumerated list constraint.

Specified by:

isValidValue in class ConstraintObject

Parameters:

value - the value to check

Returns:

true if the value checks the enumerated list constraint, false otherwise

toString

public java.lang.String toString()

Returns true the string that represents the constraint.

Specified by:

toString in class ConstraintObject

Returns:

The string representation

isLongConstraint

public boolean isLongConstraint()

Returns long status of the enumerated list constraint.

Specified by:

isLongConstraint in class ConstraintObject

Returns:

true if all enumerated values are longs, false otherwise

isBigIntegerConstraint

public boolean isBigIntegerConstraint()

Returns big integer status of the enumerated list constraint.

Specified by:

isBigIntegerConstraint in class ConstraintObject

Returns:

true if all enumerated values are big integers, false otherwise

isIntegerConstraint

public boolean isIntegerConstraint()

Returns integer status of the enumerated list constraint.

Specified by:

isIntegerConstraint in class ConstraintObject

Returns:

true if all enumerated values are integers, false otherwise

isDecimalConstraint

public boolean isDecimalConstraint()

Returns decimal status of the enumerated list constraint.

Specified by:

isDecimalConstraint in class ConstraintObject

Returns:

true if all enumerated values are big decimals, false otherwise

isDateConstraint

public boolean isDateConstraint()

Returns date status of the enumerated list constraint.

Specified by:

isDateConstraint in class ConstraintObject

Returns:

true if all enumerated values are dates, false otherwise

isStringConstraint

public boolean isStringConstraint()

Returns string status of the enumerated list constraint.

Specified by:

isStringConstraint in class ConstraintObject

Returns:

true if all enumerated values are strings, false otherwise

isBooleanConstraint

public boolean isBooleanConstraint()

Returns boolean status of the enumerated list constraint.

Specified by:

isBooleanConstraint in class ConstraintObject

Returns:

false in any case