griffon.plugins.validation.constraints

Class ConstrainedProperty

java.lang.Object

griffon.plugins.validation.constraints.ConstrainedProperty

public class ConstrainedProperty
extends Object

Provides the ability to set constraints against a properties of a class. Constraints can either be set via the property setters or via the

applyConstraint(String constraintName, Object constrainingValue)

in combination with a constraint constant. Example:

...

ConstrainedProperty cp = new ConstrainedProperty(owningClass, propertyName, propertyType); if (cp.supportsConstraint(ConstrainedProperty.EmailConstraint.VALIDATION_DSL_NAME)) { cp.applyConstraint(ConstrainedProperty.EmailConstraint.VALIDATION_DSL_NAME, new Boolean(true)); }

Alternatively constraints can be applied directly using the java bean getters/setters if a static (as opposed to dynamic) approach to constraint creation is possible:

cp.setEmail(true)

Author:

Graeme Rocher (Grails)

Field Summary

Fields

Modifier and Type	Field and Description
protected Map<String,Constraint>	appliedConstraints
protected static Map<String,List<Object>>	constraints
static Map<String,String>	DEFAULT_MESSAGES
protected static org.slf4j.Logger	LOG
protected MessageSource	messageSource
protected Class<?>	owningClass
protected String	propertyName
protected Class<?>	propertyType

Constructor Summary

Constructors

Constructor and Description
ConstrainedProperty(Class<?> clazz, String propertyName, Class<?> propertyType) Constructs a new ConstrainedProperty for the given arguments.

Method Summary

Modifier and Type	Method and Description
void	addMetaConstraint(String name, Object value) Adds a meta constraints which is a non-validating informational constraint.
void	applyConstraint(String constraintName, Object constrainingValue) Applies a constraint for the specified name and constraint value.
Constraint	getAppliedConstraint(String name) Obtains an applied constraint by name.
Collection<Constraint>	getAppliedConstraints()
Map<String,Object>	getAttributes()
String	getFormat()
List	getInList()
String	getMatches()
Comparable	getMax()
Integer	getMaxSize()
Object	getMetaConstraintValue(String name) Obtains the value of the named meta constraint.
Comparable	getMin()
Integer	getMinSize()
Object	getNotEqual()
int	getOrder()
Class<?>	getOwningClass()
String	getPropertyName()
Class<?>	getPropertyType()
Range	getRange()
Integer	getScale()
Range	getSize()
String	getWidget()
boolean	hasAppliedConstraint(String constraintName)
static boolean	hasRegisteredConstraint(String constraintName)
boolean	isBlank()
boolean	isCreditCard()
boolean	isDisplay()
boolean	isEditable()
boolean	isEmail()
boolean	isEnabled()
boolean	isNullable()
boolean	isPassword()
boolean	isUrl()
boolean	isValidator()
static void	registerNewConstraint(String name, Class<?> constraintClass)
static void	registerNewConstraint(String name, ConstraintFactory factory)
static void	removeConstraint(String name)
static void	removeConstraint(String name, Class<?> constraintClass)
void	setAttributes(Map<String,Object> attributes)
void	setBlank(boolean blank)
void	setCreditCard(boolean creditCard)
void	setDisplay(boolean display)
void	setEditable(boolean editable)
void	setEmail(boolean email)
void	setEnabled(boolean enabled)
void	setFormat(String format)
void	setInList(List inList)
void	setMatches(String regex)
void	setMax(Comparable max)
void	setMaxSize(Integer maxSize)
void	setMessageSource(MessageSource source) The message source used to evaluate error messages
void	setMin(Comparable min)
void	setMinSize(Integer minSize)
void	setNotEqual(Object notEqual)
void	setNullable(boolean nullable)
void	setOrder(int order)
void	setPassword(boolean password)
void	setPropertyName(String propertyName)
void	setRange(Range range)
void	setSize(Range size)
void	setUrl(boolean url)
void	setValidator(Validator validator)
void	setWidget(String widget)
boolean	supportsContraint(String constraintName) Checks with this ConstrainedProperty instance supports applying the specified constraint.
String	toString()
void	validate(Object target, Object propertyValue, Errors errors) Validate this constrained property against specified property value

Methods inherited from class java.lang.Object

clone, equals, finalize, getClass, hashCode, notify, notifyAll, wait, wait, wait

Field Detail

constraints

protected static Map<String,List<Object>> constraints

DEFAULT_MESSAGES

public static final Map<String,String> DEFAULT_MESSAGES

LOG

protected static final org.slf4j.Logger LOG

propertyName

protected String propertyName

propertyType

protected Class<?> propertyType

appliedConstraints

protected Map<String,Constraint> appliedConstraints

owningClass

protected Class<?> owningClass

messageSource

protected MessageSource messageSource

Constructor Detail

ConstrainedProperty

public ConstrainedProperty(@Nonnull
                           Class<?> clazz,
                           @Nonnull
                           String propertyName,
                           @Nonnull
                           Class<?> propertyType)

Constructs a new ConstrainedProperty for the given arguments.

Parameters:

clazz - The owning class

propertyName - The name of the property

propertyType - The property type

Method Detail

removeConstraint

public static void removeConstraint(String name,
                                    Class<?> constraintClass)

removeConstraint

public static void removeConstraint(String name)

registerNewConstraint

public static void registerNewConstraint(String name,
                                         Class<?> constraintClass)

registerNewConstraint

public static void registerNewConstraint(String name,
                                         ConstraintFactory factory)

hasRegisteredConstraint

public static boolean hasRegisteredConstraint(String constraintName)

getAppliedConstraints

public Collection<Constraint> getAppliedConstraints()

Returns:

Returns the appliedConstraints.

getAppliedConstraint

public Constraint getAppliedConstraint(String name)

Obtains an applied constraint by name.

Parameters:

name - The name of the constraint

Returns:

The applied constraint

hasAppliedConstraint

public boolean hasAppliedConstraint(String constraintName)

Parameters:

constraintName - The name of the constraint to check

Returns:

Returns true if the specified constraint name is being applied to this property

getPropertyType

public Class<?> getPropertyType()

Returns:

Returns the propertyType.

getMax

public Comparable getMax()

Returns:

Returns the max.

setMax

public void setMax(Comparable max)

Parameters:

max - The max to set.

getMin

public Comparable getMin()

Returns:

Returns the min.

setMin

public void setMin(Comparable min)

Parameters:

min - The min to set.

getInList

public List getInList()

Returns:

Returns the inList.

setInList

public void setInList(List inList)

Parameters:

inList - The inList to set.

getRange

public Range getRange()

Returns:

Returns the range.

setRange

public void setRange(Range range)

Parameters:

range - The range to set.

getScale

public Integer getScale()

Returns:

The scale, if defined for this property; null, otherwise

getSize

public Range getSize()

Returns:

Returns the size.

setSize

public void setSize(Range size)

Parameters:

size - The size to set.

isBlank

public boolean isBlank()

Returns:

Returns the blank.

setBlank

public void setBlank(boolean blank)

Parameters:

blank - The blank to set.

isEmail

public boolean isEmail()

Returns:

Returns the email.

setEmail

public void setEmail(boolean email)

Parameters:

email - The email to set.

isCreditCard

public boolean isCreditCard()

Returns:

Returns the creditCard.

setCreditCard

public void setCreditCard(boolean creditCard)

Parameters:

creditCard - The creditCard to set.

getMatches

public String getMatches()

Returns:

Returns the matches.

setMatches

public void setMatches(String regex)

Parameters:

regex - The matches to set.

getNotEqual

public Object getNotEqual()

Returns:

Returns the notEqual.

getMaxSize

public Integer getMaxSize()

Returns:

Returns the maxSize.

setMaxSize

public void setMaxSize(Integer maxSize)

Parameters:

maxSize - The maxSize to set.

getMinSize

public Integer getMinSize()

Returns:

Returns the minSize.

setMinSize

public void setMinSize(Integer minSize)

Parameters:

minSize - The minLength to set.

setNotEqual

public void setNotEqual(Object notEqual)

Parameters:

notEqual - The notEqual to set.

isNullable

public boolean isNullable()

Returns:

Returns the nullable.

setNullable

public void setNullable(boolean nullable)

Parameters:

nullable - The nullable to set.

getOwningClass

public Class<?> getOwningClass()

getPropertyName

public String getPropertyName()

Returns:

Returns the propertyName.

setPropertyName

public void setPropertyName(String propertyName)

Parameters:

propertyName - The propertyName to set.

isUrl

public boolean isUrl()

Returns:

Returns the url.

setUrl

public void setUrl(boolean url)

Parameters:

url - The url to set.

isValidator

public boolean isValidator()

Returns:

Returns the validator.

setValidator

public void setValidator(Validator validator)

Parameters:

validator - The validator to set.

getAttributes

public Map<String,Object> getAttributes()

setAttributes

public void setAttributes(Map<String,Object> attributes)

setMessageSource

public void setMessageSource(MessageSource source)

The message source used to evaluate error messages

Parameters:

source - The MessageSource instance to use to resolve messages

validate

public void validate(Object target,
                     Object propertyValue,
                     Errors errors)

Validate this constrained property against specified property value

Parameters:

target - The target object to validate

propertyValue - The value of the property to validate

errors - The Errors instances to report errors to

supportsContraint

public boolean supportsContraint(String constraintName)

Checks with this ConstrainedProperty instance supports applying the specified constraint.

Parameters:

constraintName - The name of the constraint

Returns:

True if the constraint is supported

applyConstraint

public void applyConstraint(String constraintName,
                            Object constrainingValue)

Applies a constraint for the specified name and constraint value.

Parameters:

constraintName - The name of the constraint

constrainingValue - The constraining value

Throws:

ConstraintException - Thrown when the specified constraint is not supported by this ConstrainedProperty. Use supportsContraint(String constraintName) to check before calling

toString

public String toString()

Overrides:

toString in class Object

addMetaConstraint

public void addMetaConstraint(String name,
                              Object value)

Adds a meta constraints which is a non-validating informational constraint.

Parameters:

name - The name of the constraint

value - The value

getMetaConstraintValue

public Object getMetaConstraintValue(String name)

Obtains the value of the named meta constraint.

Parameters:

name - The name of the constraint

Returns:

The value

isDisplay

public boolean isDisplay()

Returns:

Returns the display.

setDisplay

public void setDisplay(boolean display)

Parameters:

display - The display to set.

isEditable

public boolean isEditable()

Returns:

Returns the editable.

setEditable

public void setEditable(boolean editable)

Parameters:

editable - The editable to set.

isEnabled

public boolean isEnabled()

Returns:

Returns the enabled.

setEnabled

public void setEnabled(boolean enabled)

Parameters:

enabled - The enabled to set.

getFormat

public String getFormat()

setFormat

public void setFormat(String format)

isPassword

public boolean isPassword()

setPassword

public void setPassword(boolean password)

getWidget

public String getWidget()

setWidget

public void setWidget(String widget)

getOrder

public int getOrder()

setOrder

public void setOrder(int order)