Class ValuePatternBehavior

java.lang.Object

com.kingsrook.qqq.backend.core.model.metadata.fields.ValuePatternBehavior

All Implemented Interfaces:

FieldBehavior<ValuePatternBehavior>, Serializable

public class ValuePatternBehavior
extends Object
implements FieldBehavior<ValuePatternBehavior>

Field behavior: a string value must match a regular expression (the whole value, as Matcher.matches), or the record is refused on insert and update. Empty values are left to isRequired. The pattern and its message are published to frontends in the field's validation rules (UI API 1.6.0), so a client can check a value before saving; the server stays the authority. Write patterns that mean the same in Java and in ECMAScript (no possessive quantifiers, lookbehind or inline flags), since clients test them in their own regex engines.

See Also:

• Serialized Form

Constructor Summary

Constructors

Constructor	Description
ValuePatternBehavior()	Constructor
ValuePatternBehavior(String pattern, String message)	Constructor

Method Summary

Modifier and Type	Method	Description
void	apply(ValueBehaviorApplier.Action action, List<QRecord> recordList, QInstance instance, QTableMetaData table, QFieldMetaData field)	Add an error to each record whose (non-empty) value does not match.
ValuePatternBehavior	getDefault()	No pattern by default.
String	getMessage()	Getter for message
String	getMessageFor(QFieldMetaData field)	The message for a value that does not match.
String	getPattern()	Getter for pattern
void	setMessage(String message)	Setter for message
void	setPattern(String pattern)	Setter for pattern
List<String>	validateBehaviorConfiguration(QTableMetaData tableMetaData, QFieldMetaData fieldMetaData)	allow this behavior to be validated during QInstance validation.
ValuePatternBehavior	withMessage(String message)	Fluent setter for message
ValuePatternBehavior	withPattern(String pattern)	Fluent setter for pattern

Methods inherited from class java.lang.Object

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

Methods inherited from interface com.kingsrook.qqq.backend.core.model.metadata.fields.FieldBehavior

allowMultipleBehaviorsOfThisType

Constructor Details

ValuePatternBehavior

public ValuePatternBehavior()

Constructor

ValuePatternBehavior

public ValuePatternBehavior(String pattern,
 String message)

Constructor

Method Details

getDefault

public ValuePatternBehavior getDefault()

No pattern by default.

Specified by:

getDefault in interface FieldBehavior<ValuePatternBehavior>

apply

public void apply(ValueBehaviorApplier.Action action,
 List<QRecord> recordList,
 QInstance instance,
 QTableMetaData table,
 QFieldMetaData field)

Add an error to each record whose (non-empty) value does not match.

Specified by:

apply in interface FieldBehavior<ValuePatternBehavior>

getMessageFor

public String getMessageFor(QFieldMetaData field)

The message for a value that does not match.

validateBehaviorConfiguration

public List<String> validateBehaviorConfiguration(QTableMetaData tableMetaData,
 QFieldMetaData fieldMetaData)

Description copied from interface: FieldBehavior

allow this behavior to be validated during QInstance validation. return a list of validation errors, if there are any.

Specified by:

validateBehaviorConfiguration in interface FieldBehavior<ValuePatternBehavior>

getPattern

public String getPattern()

Getter for pattern

setPattern

public void setPattern(String pattern)

Setter for pattern

withPattern

public ValuePatternBehavior withPattern(String pattern)

Fluent setter for pattern

getMessage

public String getMessage()

Getter for message

setMessage

public void setMessage(String message)

Setter for message

withMessage

public ValuePatternBehavior withMessage(String message)

Fluent setter for message