Class RegexConstraint
- java.lang.Object
-
- org.alfresco.repo.dictionary.constraint.AbstractConstraint
-
- org.alfresco.repo.dictionary.constraint.RegexConstraint
-
- All Implemented Interfaces:
Constraint
public class RegexConstraint extends AbstractConstraint
Constraint implementation that performs regular expression comparisons. Where possible, thetype converter
will be used to first convert the value to aString
, so the evaluation will be against the value'sString
equivalent.The failure condition can be changed to occur either on a match or on a non-match by using the
requiresMatch
property. The default is true, i.e. failures will occur if the object value does not match the given expression.- Author:
- Derek Hulley
- See Also:
String.matches(java.lang.String)
,Pattern
-
-
Field Summary
Fields Modifier and Type Field Description static java.lang.String
CONSTRAINT_REGEX_MATCH
static java.lang.String
CONSTRAINT_REGEX_MSG_PREFIX
static java.lang.String
CONSTRAINT_REGEX_NO_MATCH
-
Fields inherited from class org.alfresco.repo.dictionary.constraint.AbstractConstraint
ERR_EVALUATE_EXCEPTION, ERR_PROP_NOT_SET
-
-
Constructor Summary
Constructors Constructor Description RegexConstraint()
-
Method Summary
All Methods Instance Methods Concrete Methods Modifier and Type Method Description protected void
evaluateSingleValue(java.lang.Object value)
Support for evaluation of properties.java.lang.String
getExpression()
java.util.Map<java.lang.String,java.lang.Object>
getParameters()
Returns the parameters passed to the instance of the constraint.boolean
getRequiresMatch()
java.lang.String
getType()
Returns the 'type' of the constraint, this is the identifier given to constraint in the configuration.void
initialize()
Initializes the constraint with appropriate values, which will depend on the implementation itself.void
setExpression(java.lang.String expression)
Set the regular expression used to evaluate String valuesvoid
setRequiresMatch(boolean requiresMatch)
Set whether the regular expression must be matched or notjava.lang.String
toString()
-
Methods inherited from class org.alfresco.repo.dictionary.constraint.AbstractConstraint
checkPropertyNotNull, evaluate, evaluateCollection, getShortName, getTitle, set_shortName, setRegistry, setShortName, setTitle
-
-
-
-
Field Detail
-
CONSTRAINT_REGEX_NO_MATCH
public static final java.lang.String CONSTRAINT_REGEX_NO_MATCH
- See Also:
- Constant Field Values
-
CONSTRAINT_REGEX_MATCH
public static final java.lang.String CONSTRAINT_REGEX_MATCH
- See Also:
- Constant Field Values
-
CONSTRAINT_REGEX_MSG_PREFIX
public static final java.lang.String CONSTRAINT_REGEX_MSG_PREFIX
- See Also:
- Constant Field Values
-
-
Method Detail
-
getType
public java.lang.String getType()
Returns the 'type' of the constraint, this is the identifier given to constraint in the configuration.- Specified by:
getType
in interfaceConstraint
- Overrides:
getType
in classAbstractConstraint
- Returns:
- The type
-
toString
public java.lang.String toString()
- Overrides:
toString
in classjava.lang.Object
-
getExpression
public java.lang.String getExpression()
- Returns:
- Returns the regular expression similar to the
String.matches(java.lang.String)
-
setExpression
public void setExpression(java.lang.String expression)
Set the regular expression used to evaluate String values- Parameters:
expression
- regular expression similar to theString.matches(java.lang.String)
argument
-
getRequiresMatch
public boolean getRequiresMatch()
- Returns:
- Returns true if the value must match the regular expression or false if the value must not match the regular expression
-
setRequiresMatch
public void setRequiresMatch(boolean requiresMatch)
Set whether the regular expression must be matched or not- Parameters:
requiresMatch
- Set to true if the value must match the regular expression or false if the value must not match the regular expression
-
getParameters
public java.util.Map<java.lang.String,java.lang.Object> getParameters()
Description copied from interface:Constraint
Returns the parameters passed to the instance of the constraint.- Specified by:
getParameters
in interfaceConstraint
- Overrides:
getParameters
in classAbstractConstraint
- Returns:
- Map of parameters or an empty Map if none exist
-
initialize
public void initialize()
Description copied from class:AbstractConstraint
Initializes the constraint with appropriate values, which will depend on the implementation itself. This method can be implemented as a once-off, i.e. reinitialization does not have to be supported.Registers the constraint with the registry, if present. Call this method if you want the constraint to be auto-registered.
- Specified by:
initialize
in interfaceConstraint
- Overrides:
initialize
in classAbstractConstraint
-
evaluateSingleValue
protected void evaluateSingleValue(java.lang.Object value)
Description copied from class:AbstractConstraint
Support for evaluation of properties. The value passed in will never be a Collection and will never be null.- Specified by:
evaluateSingleValue
in classAbstractConstraint
-
-